Skip to content

Commit bf74ad9

Browse files
danielroedanielroe
authoredDec 6, 2022
feat: add @nuxt/eslint-config for nuxt3 projects (#247)
·
v1.3.0@nuxt/eslint-config@0.1.0
1 parent 427e6ed commit bf74ad9

File tree

14 files changed

+541
-322
lines changed

14 files changed

+541
-322
lines changed
 

‎README.md

+72-14
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,58 @@
1-
# Nuxt ESLint Config
1+
# Nuxt ESLint packages
2+
3+
## `@nuxt/eslint-config`
4+
5+
[![npm version][npm-version-src]][npm-version-href]
6+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
7+
[![Github Actions][github-actions-src]][github-actions-href]
8+
[![Codecov][codecov-src]][codecov-href]
9+
[![Bundlephobia][bundlephobia-src]][bundlephobia-href]
10+
[![LGTM][lgtm-src]][lgtm-href]
11+
12+
> Non-opinionated [ESlint](https://eslint.org/) configuration for Nuxt 3 apps.
13+
14+
### Features
15+
16+
- Works out-of-the-box with no additional configuration.
17+
- Nuxt-specific rules for pages, components and more.
18+
- ... under active development
19+
20+
### Installation
21+
22+
1. Install this package and `eslint` in your `devDependencies`.
23+
24+
```bash
25+
npm i -D @nuxt/eslint-config eslint
26+
yarn add -D @nuxt/eslint-config eslint
27+
pnpm add -D @nuxt/eslint-config eslint
28+
```
29+
30+
2. Extend the default Nuxt config:
31+
32+
```js
33+
module.exports = {
34+
root: true,
35+
extends: ["@nuxt/eslint-config"],
36+
};
37+
```
38+
39+
You might also want to add a script entry to your `package.json:
40+
41+
```json
42+
{
43+
"scripts": {
44+
"lint": "eslint ."
45+
}
46+
}
47+
```
48+
49+
## `@nuxtjs/eslint-config` and `@nuxtjs/eslint-config-typescript`
250

351
[![GitHub Actions](https://flat.badgen.net/github/checks/nuxt/eslint-config/main)](https://github.com/nuxt/eslint-config/actions?query=workflow%3Aci)
452
[![npm](https://flat.badgen.net/npm/dm/@nuxtjs/eslint-config)](https://npmjs.com/package/@nuxtjs/eslint-config)
553
[![npm (scoped with tag)](https://flat.badgen.net/npm/v/@nuxtjs/eslint-config)](https://npmjs.com/package/@nuxtjs/eslint-config)
654

7-
[ESlint](https://eslint.org/) config used for Nuxt.
55+
> Opinionated [ESlint](https://eslint.org/) configuration used internally by Nuxt projects.
856
957
## Usage
1058

@@ -32,15 +80,14 @@ $ yarn add -D eslint
3280

3381
```json
3482
{
35-
"extends": [
36-
"@nuxtjs"
37-
]
83+
"extends": ["@nuxtjs"]
3884
}
3985
```
4086

4187
## Full example
4288

4389
A full example `.eslintrc` for a project with babel support:
90+
4491
> Dont forget to `npm i -D @babel/eslint-parser` or `yarn add -D @babel/eslint-parser`
4592
4693
```json
@@ -50,9 +97,7 @@ A full example `.eslintrc` for a project with babel support:
5097
"parserOptions": {
5198
"sourceType": "module"
5299
},
53-
"extends": [
54-
"@nuxtjs"
55-
]
100+
"extends": ["@nuxtjs"]
56101
}
57102
```
58103

@@ -64,9 +109,7 @@ And in your `.eslintrc` all you need is :
64109

65110
```json
66111
{
67-
"extends": [
68-
"@nuxtjs/eslint-config-typescript"
69-
]
112+
"extends": ["@nuxtjs/eslint-config-typescript"]
70113
}
71114
```
72115

@@ -75,8 +118,23 @@ You can find the list of supported TypeScript rules [here](https://github.com/ty
75118

76119
Also see [Nuxt TypeScript Support](https://typescript.nuxtjs.org/guide/lint.html).
77120

78-
## License
121+
### License
122+
123+
Made with ❤️
124+
125+
Published under [MIT License](./LICENCE).
79126

80-
Setup inspired by [eslint-config-standard](https://github.com/standard/eslint-config-standard)
127+
<!-- Badges -->
81128

82-
Published under the [MIT License](./LICENSE).
129+
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/eslint-config?style=flat-square
130+
[npm-version-href]: https://npmjs.com/package/@nuxt/eslint-config
131+
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/eslint-config?style=flat-square
132+
[npm-downloads-href]: https://npmjs.com/package/@nuxt/eslint-config
133+
[github-actions-src]: https://img.shields.io/github/workflow/status/nuxt/eslint-config/ci/main?style=flat-square
134+
[github-actions-href]: https://github.com/nuxt/eslint-config/actions?query=workflow%3Aci
135+
[codecov-src]: https://img.shields.io/codecov/c/gh/nuxt/eslint-config/main?style=flat-square
136+
[codecov-href]: https://codecov.io/gh/nuxt/eslint-config
137+
[lgtm-src]: https://img.shields.io/lgtm/grade/javascript/github/nuxt/eslint-config?style=flat-square
138+
[lgtm-href]: https://lgtm.com/projects/g/nuxt/eslint-config
139+
[bundlephobia-src]: https://img.shields.io/bundlephobia/minzip/@nuxt/eslint-config?style=flat-square
140+
[bundlephobia-href]: https://bundlephobia.com/package/@nuxt/eslint-config

‎packages/eslint-config/CHANGELOG.md ‎packages/eslint-config-legacy/CHANGELOG.md

File renamed without changes.

‎packages/eslint-config-legacy/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../README.md

‎packages/eslint-config-legacy/index.js

+170
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
const { getPackageInfoSync } = require('local-pkg')
2+
3+
const nuxt = getPackageInfoSync('nuxt')
4+
const isNuxt2 = nuxt && nuxt.version && nuxt.version.startsWith('2.')
5+
6+
module.exports = {
7+
env: {
8+
browser: true,
9+
node: true,
10+
...(isNuxt2 ? {} : { es6: true })
11+
},
12+
extends: [
13+
'standard',
14+
'plugin:import/errors',
15+
'plugin:import/warnings',
16+
isNuxt2
17+
? 'plugin:vue/recommended'
18+
: 'plugin:vue/vue3-recommended'
19+
],
20+
plugins: [
21+
'unicorn',
22+
'vue'
23+
],
24+
settings: {
25+
'import/resolver': {
26+
node: { extensions: ['.js', '.mjs'] }
27+
}
28+
},
29+
rules: {
30+
31+
/**********************/
32+
/* General Code Rules */
33+
/**********************/
34+
35+
// Enforce import order
36+
'import/order': 'error',
37+
38+
// Imports should come first
39+
'import/first': 'error',
40+
41+
// Other import rules
42+
'import/no-mutable-exports': 'error',
43+
44+
// Allow unresolved imports
45+
'import/no-unresolved': 'off',
46+
47+
// Allow paren-less arrow functions only when there's no braces
48+
'arrow-parens': ['error', 'as-needed', { requireForBlockBody: true }],
49+
50+
// Allow async-await
51+
'generator-star-spacing': 'off',
52+
53+
// Allow debugger during development
54+
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
55+
'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
56+
57+
// Prefer const over let
58+
'prefer-const': ['error', {
59+
destructuring: 'any',
60+
ignoreReadBeforeAssign: false
61+
}],
62+
63+
// No single if in an "else" block
64+
'no-lonely-if': 'error',
65+
66+
// Force curly braces for control flow,
67+
// including if blocks with a single statement
68+
curly: ['error', 'all'],
69+
70+
// No async function without await
71+
'require-await': 'error',
72+
73+
// Force dot notation when possible
74+
'dot-notation': 'error',
75+
76+
'no-var': 'error',
77+
78+
// Force object shorthand where possible
79+
'object-shorthand': 'error',
80+
81+
// No useless destructuring/importing/exporting renames
82+
'no-useless-rename': 'error',
83+
84+
/**********************/
85+
/* Unicorn Rules */
86+
/**********************/
87+
88+
// Pass error message when throwing errors
89+
'unicorn/error-message': 'error',
90+
91+
// Uppercase regex escapes
92+
'unicorn/escape-case': 'error',
93+
94+
// Array.isArray instead of instanceof
95+
'unicorn/no-array-instanceof': 'error',
96+
97+
// Prevent deprecated `new Buffer()`
98+
'unicorn/no-new-buffer': 'error',
99+
100+
// Keep regex literals safe!
101+
'unicorn/no-unsafe-regex': 'off',
102+
103+
// Lowercase number formatting for octal, hex, binary (0x12 instead of 0X12)
104+
'unicorn/number-literal-case': 'error',
105+
106+
// ** instead of Math.pow()
107+
'unicorn/prefer-exponentiation-operator': 'error',
108+
109+
// includes over indexOf when checking for existence
110+
'unicorn/prefer-includes': 'error',
111+
112+
// String methods startsWith/endsWith instead of more complicated stuff
113+
'unicorn/prefer-starts-ends-with': 'error',
114+
115+
// textContent instead of innerText
116+
'unicorn/prefer-text-content': 'error',
117+
118+
// Enforce throwing type error when throwing error while checking typeof
119+
'unicorn/prefer-type-error': 'error',
120+
121+
// Use new when throwing error
122+
'unicorn/throw-new-error': 'error',
123+
124+
/**********************/
125+
/* Vue Rules */
126+
/**********************/
127+
128+
// Disable template errors regarding invalid end tags
129+
'vue/no-parsing-error': ['error', {
130+
'x-invalid-end-tag': false
131+
}],
132+
133+
// Maximum 5 attributes per line instead of one
134+
'vue/max-attributes-per-line': ['error', {
135+
singleline: 5
136+
}],
137+
138+
// v-model argument is supported in Vue3
139+
'vue/no-v-model-argument': isNuxt2 ? 'error' : 'off'
140+
},
141+
overrides: [
142+
{
143+
files: [
144+
'**/pages/**/*.{js,ts,vue}',
145+
'**/layouts/**/*.{js,ts,vue}',
146+
'**/app.{js,ts,vue}',
147+
'**/error.{js,ts,vue}'
148+
],
149+
rules: {
150+
'vue/multi-word-component-names': 'off',
151+
// Pages and layouts are required to have a single root element
152+
'vue/no-multiple-template-root': 'error'
153+
}
154+
}
155+
],
156+
reportUnusedDisableDirectives: true,
157+
ignorePatterns: [
158+
'*.min.*',
159+
'*.d.ts',
160+
'dist',
161+
'LICENSE*',
162+
'output',
163+
'coverage',
164+
'public',
165+
'package-lock.json',
166+
'pnpm-lock.yaml',
167+
'yarn.lock',
168+
'__snapshots__'
169+
]
170+
}

‎packages/eslint-config-legacy/package.json

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"name": "@nuxtjs/eslint-config",
3+
"version": "12.0.0",
4+
"description": "ESlint config used for Nuxt",
5+
"repository": "nuxt/eslint-config",
6+
"license": "MIT",
7+
"files": [
8+
"index.js"
9+
],
10+
"dependencies": {
11+
"eslint-config-standard": "^17.0.0",
12+
"eslint-plugin-import": "^2.26.0",
13+
"eslint-plugin-n": "^15.6.0",
14+
"eslint-plugin-node": "^11.1.0",
15+
"eslint-plugin-promise": "^6.1.1",
16+
"eslint-plugin-unicorn": "^45.0.1",
17+
"eslint-plugin-vue": "^9.8.0",
18+
"local-pkg": "^0.4.2"
19+
},
20+
"peerDependencies": {
21+
"eslint": "^8.29.0"
22+
}
23+
}

‎packages/eslint-config/index.js

+36-154
Original file line numberDiff line numberDiff line change
@@ -1,170 +1,52 @@
1-
const { getPackageInfoSync } = require('local-pkg')
2-
3-
const nuxt = getPackageInfoSync('nuxt')
4-
const isNuxt2 = nuxt && nuxt.version && nuxt.version.startsWith('2.')
1+
require('@rushstack/eslint-patch/modern-module-resolution')
52

3+
/** @type {import('eslint').ESLint.ConfigData} */
64
module.exports = {
7-
env: {
8-
browser: true,
9-
node: true,
10-
...(isNuxt2 ? {} : { es6: true })
5+
parserOptions: {
6+
ecmaVersion: 'latest',
7+
parser: {
8+
js: 'espree',
9+
jsx: 'espree',
10+
11+
ts: '@typescript-eslint/parser',
12+
tsx: '@typescript-eslint/parser'
13+
},
14+
extraFileExtensions: ['.vue'],
15+
ecmaFeatures: {
16+
jsx: true
17+
}
1118
},
19+
env: { node: true },
20+
plugins: ['@typescript-eslint'],
1221
extends: [
13-
'standard',
14-
'plugin:import/errors',
15-
'plugin:import/warnings',
16-
isNuxt2
17-
? 'plugin:vue/recommended'
18-
: 'plugin:vue/vue3-recommended'
19-
],
20-
plugins: [
21-
'unicorn',
22-
'vue'
22+
'eslint:recommended',
23+
'plugin:@typescript-eslint/eslint-recommended',
24+
'plugin:vue/vue3-recommended'
2325
],
24-
settings: {
25-
'import/resolver': {
26-
node: { extensions: ['.js', '.mjs'] }
27-
}
28-
},
29-
rules: {
30-
31-
/**********************/
32-
/* General Code Rules */
33-
/**********************/
34-
35-
// Enforce import order
36-
'import/order': 'error',
37-
38-
// Imports should come first
39-
'import/first': 'error',
40-
41-
// Other import rules
42-
'import/no-mutable-exports': 'error',
43-
44-
// Allow unresolved imports
45-
'import/no-unresolved': 'off',
46-
47-
// Allow paren-less arrow functions only when there's no braces
48-
'arrow-parens': ['error', 'as-needed', { requireForBlockBody: true }],
49-
50-
// Allow async-await
51-
'generator-star-spacing': 'off',
52-
53-
// Allow debugger during development
54-
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
55-
'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
56-
57-
// Prefer const over let
58-
'prefer-const': ['error', {
59-
destructuring: 'any',
60-
ignoreReadBeforeAssign: false
61-
}],
62-
63-
// No single if in an "else" block
64-
'no-lonely-if': 'error',
65-
66-
// Force curly braces for control flow,
67-
// including if blocks with a single statement
68-
curly: ['error', 'all'],
69-
70-
// No async function without await
71-
'require-await': 'error',
72-
73-
// Force dot notation when possible
74-
'dot-notation': 'error',
75-
76-
'no-var': 'error',
77-
78-
// Force object shorthand where possible
79-
'object-shorthand': 'error',
80-
81-
// No useless destructuring/importing/exporting renames
82-
'no-useless-rename': 'error',
83-
84-
/**********************/
85-
/* Unicorn Rules */
86-
/**********************/
87-
88-
// Pass error message when throwing errors
89-
'unicorn/error-message': 'error',
90-
91-
// Uppercase regex escapes
92-
'unicorn/escape-case': 'error',
93-
94-
// Array.isArray instead of instanceof
95-
'unicorn/no-array-instanceof': 'error',
96-
97-
// Prevent deprecated `new Buffer()`
98-
'unicorn/no-new-buffer': 'error',
99-
100-
// Keep regex literals safe!
101-
'unicorn/no-unsafe-regex': 'off',
102-
103-
// Lowercase number formatting for octal, hex, binary (0x12 instead of 0X12)
104-
'unicorn/number-literal-case': 'error',
105-
106-
// ** instead of Math.pow()
107-
'unicorn/prefer-exponentiation-operator': 'error',
108-
109-
// includes over indexOf when checking for existence
110-
'unicorn/prefer-includes': 'error',
111-
112-
// String methods startsWith/endsWith instead of more complicated stuff
113-
'unicorn/prefer-starts-ends-with': 'error',
114-
115-
// textContent instead of innerText
116-
'unicorn/prefer-text-content': 'error',
117-
118-
// Enforce throwing type error when throwing error while checking typeof
119-
'unicorn/prefer-type-error': 'error',
120-
121-
// Use new when throwing error
122-
'unicorn/throw-new-error': 'error',
123-
124-
/**********************/
125-
/* Vue Rules */
126-
/**********************/
127-
128-
// Disable template errors regarding invalid end tags
129-
'vue/no-parsing-error': ['error', {
130-
'x-invalid-end-tag': false
131-
}],
132-
133-
// Maximum 5 attributes per line instead of one
134-
'vue/max-attributes-per-line': ['error', {
135-
singleline: 5
136-
}],
137-
138-
// v-model argument is supported in Vue3
139-
'vue/no-v-model-argument': isNuxt2 ? 'error' : 'off'
140-
},
14126
overrides: [
14227
{
28+
files: ['*.ts', '*.tsx', '*.vue'],
29+
rules: {
30+
// The core 'no-unused-vars' rules (in the eslint:recommended ruleset)
31+
// does not work with type definitions.
32+
'no-unused-vars': 'off',
33+
'@typescript-eslint/no-unused-vars': 'warn'
34+
}
35+
},
36+
{
37+
// These pages are not used directly by users so they can have one-word names.
14338
files: [
14439
'**/pages/**/*.{js,ts,vue}',
14540
'**/layouts/**/*.{js,ts,vue}',
14641
'**/app.{js,ts,vue}',
14742
'**/error.{js,ts,vue}'
14843
],
149-
rules: {
150-
'vue/multi-word-component-names': 'off',
151-
// Pages and layouts are required to have a single root element
152-
'vue/no-multiple-template-root': 'error'
153-
}
44+
rules: { 'vue/multi-word-component-names': 'off' }
45+
},
46+
{
47+
// Pages and layouts are required to have a single root element if transitions are enabled.
48+
files: ['**/pages/**/*.{js,ts,vue}', '**/layouts/**/*.{js,ts,vue}'],
49+
rules: { 'vue/no-multiple-template-root': 'error' }
15450
}
155-
],
156-
reportUnusedDisableDirectives: true,
157-
ignorePatterns: [
158-
'*.min.*',
159-
'*.d.ts',
160-
'dist',
161-
'LICENSE*',
162-
'output',
163-
'coverage',
164-
'public',
165-
'package-lock.json',
166-
'pnpm-lock.yaml',
167-
'yarn.lock',
168-
'__snapshots__'
16951
]
17052
}

‎packages/eslint-config/package.json

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
11
{
2-
"name": "@nuxtjs/eslint-config",
3-
"version": "12.0.0",
4-
"description": "ESlint config used for Nuxt",
2+
"name": "@nuxt/eslint-config",
3+
"version": "0.1.0",
4+
"description": "ESLint config for Nuxt projects",
55
"repository": "nuxt/eslint-config",
66
"license": "MIT",
7+
"main": "index.js",
8+
"exports": {
9+
".": "./index.js"
10+
},
711
"files": [
812
"index.js"
913
],
1014
"dependencies": {
11-
"eslint-config-standard": "^17.0.0",
12-
"eslint-plugin-import": "^2.26.0",
13-
"eslint-plugin-n": "^15.6.0",
14-
"eslint-plugin-node": "^11.1.0",
15-
"eslint-plugin-promise": "^6.1.1",
16-
"eslint-plugin-unicorn": "^45.0.1",
15+
"@rushstack/eslint-patch": "^1.2.0",
16+
"@typescript-eslint/eslint-plugin": "^5.45.0",
17+
"@typescript-eslint/parser": "^5.45.0",
1718
"eslint-plugin-vue": "^9.8.0",
18-
"local-pkg": "^0.4.2"
19+
"typescript": "^4.9.3"
20+
},
21+
"devDependencies": {
22+
"eslint": "^8.29.0"
1923
},
2024
"peerDependencies": {
2125
"eslint": "^8.29.0"

‎pnpm-lock.yaml

+225-144
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
Please sign in to comment.