-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add
@nuxt/eslint-config for nuxt3 projects (#247)
- Loading branch information
Showing
14 changed files
with
541 additions
and
322 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| const { getPackageInfoSync } = require('local-pkg') | ||
|
|
||
| const nuxt = getPackageInfoSync('nuxt') | ||
| const isNuxt2 = nuxt && nuxt.version && nuxt.version.startsWith('2.') | ||
|
|
||
| module.exports = { | ||
| env: { | ||
| browser: true, | ||
| node: true, | ||
| ...(isNuxt2 ? {} : { es6: true }) | ||
| }, | ||
| extends: [ | ||
| 'standard', | ||
| 'plugin:import/errors', | ||
| 'plugin:import/warnings', | ||
| isNuxt2 | ||
| ? 'plugin:vue/recommended' | ||
| : 'plugin:vue/vue3-recommended' | ||
| ], | ||
| plugins: [ | ||
| 'unicorn', | ||
| 'vue' | ||
| ], | ||
| settings: { | ||
| 'import/resolver': { | ||
| node: { extensions: ['.js', '.mjs'] } | ||
| } | ||
| }, | ||
| rules: { | ||
|
|
||
| /**********************/ | ||
| /* General Code Rules */ | ||
| /**********************/ | ||
|
|
||
| // Enforce import order | ||
| 'import/order': 'error', | ||
|
|
||
| // Imports should come first | ||
| 'import/first': 'error', | ||
|
|
||
| // Other import rules | ||
| 'import/no-mutable-exports': 'error', | ||
|
|
||
| // Allow unresolved imports | ||
| 'import/no-unresolved': 'off', | ||
|
|
||
| // Allow paren-less arrow functions only when there's no braces | ||
| 'arrow-parens': ['error', 'as-needed', { requireForBlockBody: true }], | ||
|
|
||
| // Allow async-await | ||
| 'generator-star-spacing': 'off', | ||
|
|
||
| // Allow debugger during development | ||
| 'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'warn', | ||
| 'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'warn', | ||
|
|
||
| // Prefer const over let | ||
| 'prefer-const': ['error', { | ||
| destructuring: 'any', | ||
| ignoreReadBeforeAssign: false | ||
| }], | ||
|
|
||
| // No single if in an "else" block | ||
| 'no-lonely-if': 'error', | ||
|
|
||
| // Force curly braces for control flow, | ||
| // including if blocks with a single statement | ||
| curly: ['error', 'all'], | ||
|
|
||
| // No async function without await | ||
| 'require-await': 'error', | ||
|
|
||
| // Force dot notation when possible | ||
| 'dot-notation': 'error', | ||
|
|
||
| 'no-var': 'error', | ||
|
|
||
| // Force object shorthand where possible | ||
| 'object-shorthand': 'error', | ||
|
|
||
| // No useless destructuring/importing/exporting renames | ||
| 'no-useless-rename': 'error', | ||
|
|
||
| /**********************/ | ||
| /* Unicorn Rules */ | ||
| /**********************/ | ||
|
|
||
| // Pass error message when throwing errors | ||
| 'unicorn/error-message': 'error', | ||
|
|
||
| // Uppercase regex escapes | ||
| 'unicorn/escape-case': 'error', | ||
|
|
||
| // Array.isArray instead of instanceof | ||
| 'unicorn/no-array-instanceof': 'error', | ||
|
|
||
| // Prevent deprecated `new Buffer()` | ||
| 'unicorn/no-new-buffer': 'error', | ||
|
|
||
| // Keep regex literals safe! | ||
| 'unicorn/no-unsafe-regex': 'off', | ||
|
|
||
| // Lowercase number formatting for octal, hex, binary (0x12 instead of 0X12) | ||
| 'unicorn/number-literal-case': 'error', | ||
|
|
||
| // ** instead of Math.pow() | ||
| 'unicorn/prefer-exponentiation-operator': 'error', | ||
|
|
||
| // includes over indexOf when checking for existence | ||
| 'unicorn/prefer-includes': 'error', | ||
|
|
||
| // String methods startsWith/endsWith instead of more complicated stuff | ||
| 'unicorn/prefer-starts-ends-with': 'error', | ||
|
|
||
| // textContent instead of innerText | ||
| 'unicorn/prefer-text-content': 'error', | ||
|
|
||
| // Enforce throwing type error when throwing error while checking typeof | ||
| 'unicorn/prefer-type-error': 'error', | ||
|
|
||
| // Use new when throwing error | ||
| 'unicorn/throw-new-error': 'error', | ||
|
|
||
| /**********************/ | ||
| /* Vue Rules */ | ||
| /**********************/ | ||
|
|
||
| // Disable template errors regarding invalid end tags | ||
| 'vue/no-parsing-error': ['error', { | ||
| 'x-invalid-end-tag': false | ||
| }], | ||
|
|
||
| // Maximum 5 attributes per line instead of one | ||
| 'vue/max-attributes-per-line': ['error', { | ||
| singleline: 5 | ||
| }], | ||
|
|
||
| // v-model argument is supported in Vue3 | ||
| 'vue/no-v-model-argument': isNuxt2 ? 'error' : 'off' | ||
| }, | ||
| overrides: [ | ||
| { | ||
| files: [ | ||
| '**/pages/**/*.{js,ts,vue}', | ||
| '**/layouts/**/*.{js,ts,vue}', | ||
| '**/app.{js,ts,vue}', | ||
| '**/error.{js,ts,vue}' | ||
| ], | ||
| rules: { | ||
| 'vue/multi-word-component-names': 'off', | ||
| // Pages and layouts are required to have a single root element | ||
| 'vue/no-multiple-template-root': 'error' | ||
| } | ||
| } | ||
| ], | ||
| reportUnusedDisableDirectives: true, | ||
| ignorePatterns: [ | ||
| '*.min.*', | ||
| '*.d.ts', | ||
| 'dist', | ||
| 'LICENSE*', | ||
| 'output', | ||
| 'coverage', | ||
| 'public', | ||
| 'package-lock.json', | ||
| 'pnpm-lock.yaml', | ||
| 'yarn.lock', | ||
| '__snapshots__' | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| { | ||
| "name": "@nuxtjs/eslint-config", | ||
| "version": "12.0.0", | ||
| "description": "ESlint config used for Nuxt", | ||
| "repository": "nuxt/eslint-config", | ||
| "license": "MIT", | ||
| "files": [ | ||
| "index.js" | ||
| ], | ||
| "dependencies": { | ||
| "eslint-config-standard": "^17.0.0", | ||
| "eslint-plugin-import": "^2.26.0", | ||
| "eslint-plugin-n": "^15.6.0", | ||
| "eslint-plugin-node": "^11.1.0", | ||
| "eslint-plugin-promise": "^6.1.1", | ||
| "eslint-plugin-unicorn": "^45.0.1", | ||
| "eslint-plugin-vue": "^9.8.0", | ||
| "local-pkg": "^0.4.2" | ||
| }, | ||
| "peerDependencies": { | ||
| "eslint": "^8.29.0" | ||
| } | ||
| } |
File renamed without changes.
File renamed without changes.
Oops, something went wrong.