項目常用eslint配置(Vue/React/TypeScript) 記錄一下常用的eslint配置。 Vue項目常用eslint配置 需要安裝依賴(Vue這裡使用standard擴展和vue插件,所以需要安裝) .eslintrc.js文件配置 javascript // https://esli ...
項目常用eslint配置(Vue/React/TypeScript)
記錄一下常用的eslint配置。
Vue項目常用eslint配置
需要安裝依賴(Vue這裡使用standard擴展和vue插件,所以需要安裝)
{
"devDependencies": {
"babel-eslint": "^10.0.2",
"eslint": "^6.1.0",
"eslint-config-imperative-es6": "^2.1.0",
"eslint-config-standard": "^10.2.1",
"eslint-plugin-import": "^2.17.2",
"eslint-plugin-node": "^5.2.0",
"eslint-plugin-promise": "^3.4.0",
"eslint-plugin-standard": "^3.0.1",
"eslint-plugin-vue": "^4.7.1" // vue插件
}
}
.eslintrc.js文件配置
// https://eslint.org/docs/user-guide/configuring
module.exports = {
// 預設情況下,ESLint 會在所有父級目錄里尋找配置文件,一直到根目錄。ESLint 一旦發現配置文件中有 "root": true,它就會停止在父級目錄中尋找。
root: true,
parserOptions: { // 解析器選項
parser: 'babel-eslint' // 一個對Babel解析器的包裝,使其能夠與 ESLint 相容
},
// 環境的全局變數
env: {
browser: true,
node: true,
jquery: true
},
// 配置文件可以被基礎配置中的已啟用的規則繼承。
extends: [
// https://github.com/guidesmiths/eslint-config-imperative-es6
'imperative-es6',
// https://github.com/vuejs/eslint-plugin-vue#priority-a-essential-error-prevention
// consider switching to `plugin:vue/strongly-recommended` or `plugin:vue/recommended` for stricter rules.
'plugin:vue/essential',
// https://github.com/standard/standard/blob/master/docs/RULES-en.md
'standard' // 使用eslint-plugin-standard擴展(挺好用的
],
// 配置插件名字,可以省略'eslint-plugin-'首碼。使用前要用npm安裝。
plugins: [
'vue'
],
// 添加規則。配置定義在插件中的一個規則的時候,你必須使用 插件名/規則ID 的形式。
// 常用規則官網:http://eslint.cn/docs/rules/
rules: {
'indent': ['error', 4],
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
'linebreak-style': 'off', // 強制使用一致的換行分隔 LF or CRLF
'array-callback-return': 'off'
}
// 若要禁用一組文件的配置文件中的規則,請使用 overrides 和 files。例如:
// overrides:
// [{
// "files": ["*-test.js","*.spec.js"],
// "rules": {
// "no-unused-expressions": "off"
// }
// }]
}
React項目常用eslint配置
同樣安裝依賴,React這裡使用的airbnb擴展。安裝eslint-import-resolver-webpack用來解決webpack中設置的別名eslint無法識別報錯的問題。
{
"devDependencies": {
"babel-eslint": "^10.0.2",
"eslint": "^6.1.0",
"eslint-config-airbnb": "^18.0.1",
"eslint-import-resolver-webpack": "^0.12.1",
"eslint-plugin-import": "^2.20.1",
"eslint-plugin-jsx-a11y": "^6.2.3",
"eslint-plugin-node": "^11.0.0",
"eslint-plugin-promise": "^4.2.1",
"eslint-plugin-react": "^7.14.3"
}
}
.eslintrc.js文件配置
module.exports={
env: {
browser: true,
commonjs: true,
node: true,
es6: true
},
extends: [
'airbnb' // airbnb擴展
],
globals: {
$: true,
process: true,
__dirname: true
},
parser: 'babel-eslint',
parserOptions: {
ecmaFeatures: {
jsx: true
},
sourceType: 'module'
},
plugins: [
'react' // react插件
],
// 用來處理webpack中指定別名但eslint未能識別報的錯
settings: {
"import/resolver": {
webpack: {
config: './build/webpack.base.conf.js' // 指定webpack配置文件路徑
}
}
},
// https://github.com/yannickcr/eslint-plugin-react
rules: {
"no-console": 0, //不禁用console
"no-irregular-whitespace": 0, //不規則的空白不允許
"react/jsx-filename-extension": [1, {"extensions": [".js", ".jsx"]}],//文件是.js還是.jsx
"no-underscore-dangle": 0,
"array-bracket-spacing": [2, 'never'], // 指定數組的元素之間要以空格隔開(,後面)
"comma-dangle": 2, // 數組和對象鍵值對最後一個逗號, never參數:不能帶末尾的逗號, always參數:必須帶末尾的逗號
}
}
附上rules其他rules規則:
{
"rules": {
// off=0, warn=1, error=2, 如果是數組, 第二項表示參數option
"indent": [2, 2], // 控制縮進為2
"eqeqeq": 1,// 警告使用全等
"quotes": [2, "single"], //單引號
"no-console": 0, //不禁用console
"no-debugger": 1, //警告debugger
"no-var": 2, //對var禁止
"semi": 2, //強制使用分號
"semi-spacing": [2, {"before": false, "after": true}], // 強制分號前後不允許空格
"no-irregular-whitespace": 0, //不規則的空白不允許
"no-trailing-spaces": 'error', //一行結束後面有空格就發出警告
"eol-last": 0, //文件以單一的換行符結束
"no-unused-vars": [2, {"vars": "all", "args": "after-used"}], //不能有聲明後未被使用的變數或參數
"no-underscore-dangle": 0, //標識符不能以_開頭或結尾
"no-alert": 2, //禁止使用alert confirm prompt
"no-lone-blocks": 0, //禁止不必要的嵌套塊
"no-class-assign": 2, //禁止給類賦值
"no-cond-assign": 2, //禁止在條件表達式中使用賦值語句
"no-const-assign": 2, //禁止修改const聲明的變數
"no-delete-var": 2, //不能對var聲明的變數使用delete操作符
"no-dupe-keys": 2, //在創建對象字面量時不允許鍵重覆
"no-duplicate-case": 2, //switch中的case標簽不能重覆
"no-dupe-args": 2, //函數參數不能重覆
"no-empty": 2, //塊語句中的內容不能為空
"no-func-assign": 2, //禁止重覆的函數聲明
"no-invalid-this": 0, //禁止無效的this,只能用在構造器,類,對象字面量
"no-redeclare": 2, //禁止重覆聲明變數
"no-spaced-func": 2, //函數調用時 函數名與()之間不能有空格
"no-this-before-super": 0, //在調用super()之前不能使用this或super
"no-undef": 2, //不能有未定義的變數
"no-use-before-define": 2, //未定義前不能使用
"camelcase": 0, //強制駝峰法命名
"jsx-quotes": [2, "prefer-double"], //強制在JSX屬性(jsx-quotes)中一致使用雙引號
"react/display-name": 0, //防止在React組件定義中丟失displayName
"react/forbid-prop-types": 0, //禁止某些propTypes
"react/jsx-boolean-value": 0, //在JSX中強制布爾屬性符號
"react/jsx-closing-bracket-location": 0, //在JSX中驗證右括弧位置
"react/jsx-curly-spacing": [2, {"when": "never", "children": true}], //在JSX屬性和表達式中加強或禁止大括弧內的空格。
"react/jsx-indent": [2,2], // 語法縮進控制
"react/jsx-indent-props": [2, 2], //驗證JSX中的props縮進是否為2個
"react/jsx-key": 2, //在數組或迭代器中驗證JSX具有key屬性
"react/jsx-max-props-per-line": 0, // 限制JSX中單行上的props的最大數量
"react/jsx-no-bind": 0, //JSX中不允許使用箭頭函數和bind
"react/jsx-no-duplicate-props": 2, //防止在JSX中重覆的props
"react/jsx-no-literals": 0, //防止使用未包裝的JSX字元串
"react/jsx-no-undef": 1, //在JSX中禁止未聲明的變數
"react/jsx-pascal-case": 0, //為用戶定義的JSX組件強制使用PascalCase
"react/jsx-sort-props": 0, //強化props按字母排序
"react/jsx-uses-react": 1, //防止反應被錯誤地標記為未使用
"react/jsx-uses-vars": 2, //防止在JSX中使用的變數被錯誤地標記為未使用
"react/no-danger": 0, //防止使用危險的JSX屬性
"react/no-did-mount-set-state": 0, //防止在componentDidMount中使用setState
"react/no-did-update-set-state": 1, //防止在componentDidUpdate中使用setState
"react/no-direct-mutation-state": 2, //防止this.state的直接變異
"react/no-multi-comp": 0, //防止每個文件有多個組件定義
"react/no-set-state": 0, //防止使用setState
"react/no-unknown-property": 2, //防止使用未知的DOM屬性
"react/prefer-es6-class": 2, //為React組件強制執行ES5或ES6類
"react/prop-types": 0, //防止在React組件定義中丟失props驗證
"react/react-in-jsx-scope": 2, //使用JSX時防止丟失React
"react/self-closing-comp": 0, //防止沒有children的組件的額外結束標簽
"react/sort-comp": 2, //強制組件方法順序
"no-extra-boolean-cast": 0, //禁止不必要的bool轉換
"react/no-array-index-key": 0, //防止在數組中遍歷中使用數組key做索引
"react/no-deprecated": 1, //不使用棄用的方法
"react/jsx-equals-spacing": 2, //在JSX屬性中強制或禁止等號周圍的空格
"no-unreachable": 1, //不能有無法執行的代碼
"comma-dangle": [2, "never"], //對象字面量項尾必須有逗號
"no-mixed-spaces-and-tabs": 0, //禁止混用tab和空格
"prefer-arrow-callback": 0, //比較喜歡箭頭回調
"arrow-parens": 0, //箭頭函數用小括弧括起來
"arrow-spacing": [
'error',
{
before: true,
after: true
}
],
"prefer-const": ["error", {
"destructuring": "all"
}
],
"prefer-destructuring": ["error", {
"VariableDeclarator": {
"array": false,
"object": true
},
"AssignmentExpression": {
"array": false,
"object": false
}
}, {
"enforceForRenamedProperties": false
}
],
"use-isnan": 2,//禁止比較時使用NaN,只能用isNaN()
// @fixable 代碼塊如果在一行內,那麼大括弧內的首尾必須有空格,比如 function () { alert('Hello') }
'block-spacing': [
'error',
'always'
],
// @fixable 函數名和執行它的括弧之間禁止有空格
'func-call-spacing': [
'error',
'never'
],
// @fixable if, function 等的大括弧之前必須要有空格,比如 if (a) {
'space-before-blocks': [
'error',
'always'
],
// @fixable function 的小括弧之前必須要有空格
'space-before-function-paren': [
'error',
{
anonymous: 'ignore',
named: 'never',
asyncArrow: 'always'
}
],
// @fixable 小括弧內的首尾禁止有空格
'space-in-parens': [
'error',
'never'
],
// @fixable 操作符左右必須有空格,比如 let sum = 1 + 2;
'space-infix-ops': 'error',
// @fixable new, typeof 等後面必須有空格,++, -- 等禁止有空格,比如:
// let foo = new Person();
// bar = bar++;
'space-unary-ops': [
'error',
{
words: true,
nonwords: false
}
],
'switch-colon-spacing': [
'error',
{
after: true,
before: false
}
],
'arrow-spacing': [
'error',
{
before: true,
after: true
}
],
'comma-spacing': [
'error',
{
before: false,
after: true
}
],
'keyword-spacing': [
'error',
{
before: true,
after: true
}
]
}
}
TypeScript+React項目常用eslint配置
需要安裝依賴@typescript-eslint(前提是已經安裝了typescript)
{
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^2.23.0",
"@typescript-eslint/parser": "^2.23.0",
"eslint": "^6.8.0",
"eslint-config-airbnb-typescript": "^7.0.0",
"eslint-import-resolver-webpack": "^0.12.1",
"eslint-plugin-import": "^2.20.1",
"eslint-plugin-jsx-a11y": "^6.2.3",
"eslint-plugin-react": "^7.19.0",
"eslint-plugin-react-hooks": "^1.7.0",`
}
}
.eslintrc.js文件配置
module.exports = {
root: true,
parser: '@typescript-eslint/parser',
parserOptions: {
project: './tsconfig.json',
},
plugins: [
'@typescript-eslint',
],
extends: [
'airbnb-typescript',
'eslint:recommended',
'plugin:@typescript-eslint/eslint-recommended',
'plugin:@typescript-eslint/recommended',
],
// 用來處理webpack中指定別名但eslint未能識別報的錯
settings: {
"import/resolver": {
webpack: {
config: './build/webpack.base.conf.js' // 指定webpack配置文件路徑
}
}
},
rules: {
"react/state-in-constructor": 0,
"comma-dangle": [2, 'always-multiline'],
"no-console": 0, //不禁用console
"no-irregular-whitespace": 0, //不規則的空白不允許
"no-underscore-dangle": 0,
"array-bracket-spacing": [2, 'never'] // 指定數組的元素之間要以空格隔開(,後面)
}
}