electron教程(番外篇一): 開發環境及插件, VSCode調試, ESLint + Google JavaScript Style Guide代碼規範

個人electron教程系列

electron教程(一): electron的安裝和項目的建立javascript

electron教程(番外篇一): 開發環境及插件, VSCode調試, ESLint + Google JavaScript Style Guide代碼規範html

electron教程(番外篇二): 使用TypeScript版本的electron, VSCode調試TypeScript, TS版本的ESLint前端

electron教程(二): http服務器, ws服務器, 子進程管理java

electron教程(三): 使用ffi-napi引入C++的dllnode

electron教程(四): 使用electron-builder或electron-packager將項目打包爲可執行桌面程序(.exe)git

 

引言

 

這一篇將介紹:es6

1. 如何部署開發環境VSCode.
2. 如何使用vscode調試啓動項目.
3. 如何使用ESLint插件來檢查代碼, 代碼風格規範使用Google JavaScript Style Guide(官方英文第三方中文翻譯).
4. VSCode插件推薦.github

 

安裝VSCode

 

經過VSCode官網下載, 能夠安裝在任意盤符下任意位置.npm

安裝完成後, 就可使用VSCode打開並編輯main.js了.json

你還可使用VSCode打開並編輯.html.json等文件, 甚至是.txt.md等文件.

 

使用VSCode調試啓動項目

 

1. 部署node.js+electron環境

按步驟完成electron教程(一): electron的安裝和項目的建立所介紹的內容.

 

2. 建立launch配置文件

在項目根目錄, 創建.vscode目錄, 在該文件夾內建立launch.json文件, 內容以下:

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Electron JS", // 配置方案名字, VSCode左下角能夠切換配置方案
      "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron",
      "program": "${workspaceFolder}/src/main.js", // electron入口
      "protocol": "inspector" // 默認的協議是legacy,該協議致使不進入斷點
    },
  ]
}

 

3. 將你的項目複製進VSCode

如今, 啓動一個VSCode.

而後, 將整個項目文件夾blogs, 拖動到VSCode的主窗口中, 能夠看到, 鼠標位置顯示出複製, 以下圖所示:

鬆開鼠標, 複製完成, VSCode界面左邊出現blogs目錄, 能夠直接打開該目錄下任意文件:

 

4. 調試!

main.js中打一個斷點, 而後按下F5, 就會進入斷點調試, 一路執行下去, 最終依然會出現electron程序界面.

 

安裝ESLint代碼檢查工具, Google JavaScript Style Guide

 

ESLint是一個語法規則和編碼規範的檢查工具, 它有兩個功能:

功能一: 

因爲JavaScript是動態弱類型語言, 編譯器沒法進行代碼檢查(好比類型錯誤), 以往都須要執行JavaScript代碼才能發現語法錯誤或其餘錯誤. 而ESLint, 能夠在咱們寫代碼的時候就提示出語法錯誤, 對開發人員很是有幫助.

功能二: 

ESLint能夠導入編碼規範, 強制代碼符合某種規範, 常見的有: Google開源的JavaScript代碼風格規範Google JavaScript Style Guide, 由不少前端開發人員總結的eslint-config-standardAirbnb開源的的規範. 

你能夠在上述開源規範上, 作一些本身喜歡的修改, 若是你願意, 甚至能夠本身寫一套規範.

 

1. 安裝ESLint

在項目根目錄, 執行指令:

npm install --save eslint eslint-config-google

 

2. 修改配置文件

在項目根目錄建立.eslintrc.js文件,將下列內容複製到文件中:

module.exports = {
      "extends": ["google"],
      "parserOptions": {
          "ecmaVersion": 2018
      },
      "env": {
          "es6": true
      },
      rules: {
          "linebreak-style": ["error","windows"],
      }
};

上面的配置文件, 主要有如下內容:

1. extends指定了使用google編碼規範.
2. parserOptions指定ECMAScript支持的版本,2018指ES2018
3. env爲環境變量, 能夠預設好的其餘環境的全局變量,如brower環境變量, node環境變量, es6環境變量, mocha環境變量等.
4. rules能夠添加一些本身的規則, 這些規則會覆蓋掉extends中指定的規範. 在這裏我指定了linebreak-style使用windows風格換行符CRLF, 而不是Google Style默認的Unix風格換行符LF.

 

3. 安裝VSCode的ESlint插件

在VSCode左側的Extensions中搜索ESlint,安裝ESlint, 以下圖:

 

4. 重啓VSCode生效

 

VSCode插件推薦

 

1. vscode-icon

整個插件能夠改變不一樣格式文件的圖標.

以下圖所示, .js.html.json等文件, 使用了不一樣的圖標:

在VSCode左側的Extensions中搜索vscode-icons,安裝vscode-icons, 以下圖:

相關文章
相關標籤/搜索