Skip to content

Commit d206d35

Browse files
ota-meshiota-meshi
authored
Introduce Prettier and update eslint config (#1161)
* Introduce Prettier and update eslint config * update ci * fix * fix
1 parent ec8083b commit d206d35

File tree

267 files changed

+8740
-5556
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

267 files changed

+8740
-5556
lines changed

‎.circleci/config.yml

+23
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ workflows:
66
- node-v10
77
- node-v12
88
- node-v14
9+
- lint
910

1011
version: 2
1112
jobs:
@@ -61,3 +62,25 @@ jobs:
6162
<<: *node-base
6263
docker:
6364
- image: node:14
65+
66+
lint:
67+
docker:
68+
- image: node:14
69+
steps:
70+
- run:
71+
name: Versions
72+
command: npm version
73+
- checkout
74+
- restore_cache:
75+
keys:
76+
- v2-npm-lock-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package.json" }}
77+
- run:
78+
name: Install dependencies
79+
command: npm install
80+
- save_cache:
81+
key: v2-npm-lock-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package.json" }}
82+
paths:
83+
- node_modules
84+
- run:
85+
name: Test
86+
command: npm run lint

‎.eslintrc.js

+69-19
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
'use strict'
22

33
module.exports = {
4-
// https://github.com/eslint/eslint/issues/11888
5-
root: false,
4+
root: true,
65
parserOptions: {
76
ecmaVersion: 6
87
},
@@ -12,28 +11,79 @@ module.exports = {
1211
},
1312
extends: [
1413
'plugin:eslint-plugin/recommended',
15-
'plugin:vue-libs/recommended'
16-
],
17-
plugins: [
18-
'eslint-plugin'
14+
'plugin:vue-libs/recommended',
15+
'prettier'
1916
],
17+
plugins: ['eslint-plugin', 'prettier'],
2018
rules: {
21-
'eslint-plugin/report-message-format': ['error', '^[A-Z`\'{].*\\.$'],
19+
'prettier/prettier': 'error',
20+
'eslint-plugin/report-message-format': ['error', "^[A-Z`'{].*\\.$"],
2221
'eslint-plugin/prefer-placeholders': 'error',
2322
'eslint-plugin/consistent-output': 'error',
24-
'no-mixed-operators': 'error'
23+
24+
'no-debugger': 'error',
25+
'no-console': 'error',
26+
'no-alert': 'error',
27+
'no-void': 'error',
28+
29+
'no-warning-comments': 'warn',
30+
'no-var': 'error',
31+
'prefer-template': 'error',
32+
'object-shorthand': 'error',
33+
'prefer-rest-params': 'error',
34+
'prefer-arrow-callback': 'error',
35+
'prefer-spread': 'error',
36+
37+
'dot-notation': 'error'
2538
},
39+
overrides: [
40+
// Introduce prettier. but ignore files to avoid conflicts with PR.
41+
{
42+
files: [
43+
// https://github.com/vuejs/eslint-plugin-vue/pull/1107
44+
'lib/rules/order-in-components.js',
45+
'tests/lib/rules/order-in-components.js',
46+
// https://github.com/vuejs/eslint-plugin-vue/pull/1090
47+
'lib/rules/require-direct-export.js',
48+
'tests/lib/rules/require-direct-export.js',
49+
'lib/utils/index.js',
50+
'tests/lib/utils/vue-component.js',
51+
// https://github.com/vuejs/eslint-plugin-vue/pull/1017
52+
'lib/utils/indent-common.js',
53+
'tests/lib/rules/html-indent.js',
54+
'tests/lib/rules/script-indent.js',
55+
// https://github.com/vuejs/eslint-plugin-vue/pull/982
56+
'lib/rules/attributes-order.js',
57+
'tests/lib/rules/attributes-order.js',
58+
// https://github.com/vuejs/eslint-plugin-vue/pull/819
59+
'lib/rules/attributes-order.js',
60+
'tests/lib/rules/attributes-order.js'
61+
],
62+
extends: [
63+
'plugin:eslint-plugin/recommended',
64+
'plugin:vue-libs/recommended'
65+
],
66+
rules: {
67+
'prettier/prettier': 'off',
2668

27-
overrides: [{
28-
files: ['lib/rules/*.js'],
29-
rules: {
30-
'consistent-docs-description': 'error',
31-
'no-invalid-meta': 'error',
32-
'no-invalid-meta-docs-categories': 'error',
33-
'eslint-plugin/require-meta-type': 'error',
34-
'require-meta-docs-url': ['error', {
35-
'pattern': `https://eslint.vuejs.org/rules/{{name}}.html`
36-
}]
69+
'rest-spread-spacing': 'error',
70+
'no-mixed-operators': 'error'
71+
}
72+
},
73+
{
74+
files: ['lib/rules/*.js'],
75+
rules: {
76+
'consistent-docs-description': 'error',
77+
'no-invalid-meta': 'error',
78+
'no-invalid-meta-docs-categories': 'error',
79+
'eslint-plugin/require-meta-type': 'error',
80+
'require-meta-docs-url': [
81+
'error',
82+
{
83+
pattern: `https://eslint.vuejs.org/rules/{{name}}.html`
84+
}
85+
]
86+
}
3787
}
38-
}]
88+
]
3989
}

‎.prettierrc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
semi: false
2+
singleQuote: true
3+
printWidth: 80
4+
trailingComma: none

‎docs/.vuepress/config.js

+54-20
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,62 @@
66

77
const rules = require('../../tools/lib/rules')
88

9-
const uncategorizedRules = rules.filter(rule => !rule.meta.docs.categories && !rule.meta.deprecated)
10-
const deprecatedRules = rules.filter(rule => rule.meta.deprecated)
9+
const uncategorizedRules = rules.filter(
10+
(rule) => !rule.meta.docs.categories && !rule.meta.deprecated
11+
)
12+
const deprecatedRules = rules.filter((rule) => rule.meta.deprecated)
1113

1214
const sidebarCategories = [
1315
{ title: 'Base Rules', categoryIds: ['base'] },
14-
{ title: 'Priority A: Essential', categoryIds: ['vue3-essential', 'essential'] },
15-
{ title: 'Priority A: Essential for Vue.js 3.x', categoryIds: ['vue3-essential'] },
16+
{
17+
title: 'Priority A: Essential',
18+
categoryIds: ['vue3-essential', 'essential']
19+
},
20+
{
21+
title: 'Priority A: Essential for Vue.js 3.x',
22+
categoryIds: ['vue3-essential']
23+
},
1624
{ title: 'Priority A: Essential for Vue.js 2.x', categoryIds: ['essential'] },
17-
{ title: 'Priority B: Strongly Recommended', categoryIds: ['vue3-strongly-recommended', 'strongly-recommended'] },
18-
{ title: 'Priority B: Strongly Recommended for Vue.js 3.x', categoryIds: ['vue3-strongly-recommended'] },
19-
{ title: 'Priority B: Strongly Recommended for Vue.js 2.x', categoryIds: ['strongly-recommended'] },
20-
{ title: 'Priority C: Recommended', categoryIds: ['vue3-recommended', 'recommended'] },
21-
{ title: 'Priority C: Recommended for Vue.js 3.x', categoryIds: ['vue3-recommended'] },
22-
{ title: 'Priority C: Recommended for Vue.js 2.x', categoryIds: ['recommended'] }
25+
{
26+
title: 'Priority B: Strongly Recommended',
27+
categoryIds: ['vue3-strongly-recommended', 'strongly-recommended']
28+
},
29+
{
30+
title: 'Priority B: Strongly Recommended for Vue.js 3.x',
31+
categoryIds: ['vue3-strongly-recommended']
32+
},
33+
{
34+
title: 'Priority B: Strongly Recommended for Vue.js 2.x',
35+
categoryIds: ['strongly-recommended']
36+
},
37+
{
38+
title: 'Priority C: Recommended',
39+
categoryIds: ['vue3-recommended', 'recommended']
40+
},
41+
{
42+
title: 'Priority C: Recommended for Vue.js 3.x',
43+
categoryIds: ['vue3-recommended']
44+
},
45+
{
46+
title: 'Priority C: Recommended for Vue.js 2.x',
47+
categoryIds: ['recommended']
48+
}
2349
]
2450

2551
const categorizedRules = []
2652
for (const { title, categoryIds } of sidebarCategories) {
2753
const categoryRules = rules
28-
.filter(rule => rule.meta.docs.categories && !rule.meta.deprecated)
29-
.filter(rule => categoryIds
30-
.every(categoryId => rule.meta.docs.categories.includes(categoryId))
54+
.filter((rule) => rule.meta.docs.categories && !rule.meta.deprecated)
55+
.filter((rule) =>
56+
categoryIds.every((categoryId) =>
57+
rule.meta.docs.categories.includes(categoryId)
58+
)
3159
)
3260
const children = categoryRules
3361
.filter(({ ruleId }) => {
34-
const exists = categorizedRules.some(({ children }) => children.some(([, alreadyRuleId]) => alreadyRuleId === ruleId))
62+
const exists = categorizedRules.some(({ children }) =>
63+
children.some(([, alreadyRuleId]) => alreadyRuleId === ruleId)
64+
)
3565
return !exists
3666
})
3767
.map(({ ruleId, name }) => [`/rules/${name}`, ruleId])
@@ -51,19 +81,25 @@ if (uncategorizedRules.length > 0) {
5181
extraCategories.push({
5282
title: 'Uncategorized',
5383
collapsable: false,
54-
children: uncategorizedRules.map(({ ruleId, name }) => [`/rules/${name}`, ruleId])
84+
children: uncategorizedRules.map(({ ruleId, name }) => [
85+
`/rules/${name}`,
86+
ruleId
87+
])
5588
})
5689
}
5790
if (deprecatedRules.length > 0) {
5891
extraCategories.push({
5992
title: 'Deprecated',
6093
collapsable: false,
61-
children: deprecatedRules.map(({ ruleId, name }) => [`/rules/${name}`, ruleId])
94+
children: deprecatedRules.map(({ ruleId, name }) => [
95+
`/rules/${name}`,
96+
ruleId
97+
])
6298
})
6399
}
64100

65101
module.exports = {
66-
configureWebpack (_config, _isServer) {
102+
configureWebpack(_config, _isServer) {
67103
return {
68104
resolve: {
69105
alias: {
@@ -77,9 +113,7 @@ module.exports = {
77113
title: 'eslint-plugin-vue',
78114
description: 'Official ESLint plugin for Vue.js',
79115
evergreen: true,
80-
head: [
81-
['link', { rel: 'icon', href: '/favicon.png' }]
82-
],
116+
head: [['link', { rel: 'icon', href: '/favicon.png' }]],
83117

84118
plugins: {
85119
'@vuepress/pwa': {

‎eslint-internal-rules/consistent-docs-description.js

+22-20
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,7 @@
55

66
'use strict'
77

8-
const ALLOWED_FIRST_WORDS = [
9-
'enforce',
10-
'require',
11-
'disallow'
12-
]
8+
const ALLOWED_FIRST_WORDS = ['enforce', 'require', 'disallow']
139

1410
// ------------------------------------------------------------------------------
1511
// Helpers
@@ -22,7 +18,7 @@ const ALLOWED_FIRST_WORDS = [
2218
* @param {ASTNode} node The ObjectExpression node.
2319
* @returns {ASTNode} The Property node or null if not found.
2420
*/
25-
function getPropertyFromObject (property, node) {
21+
function getPropertyFromObject(property, node) {
2622
if (node && node.type === 'ObjectExpression') {
2723
const properties = node.properties
2824

@@ -42,15 +38,17 @@ function getPropertyFromObject (property, node) {
4238
* @param {ASTNode} exportsNode ObjectExpression node that the rule exports.
4339
* @returns {void}
4440
*/
45-
function checkMetaDocsDescription (context, exportsNode) {
41+
function checkMetaDocsDescription(context, exportsNode) {
4642
if (exportsNode.type !== 'ObjectExpression') {
4743
// if the exported node is not the correct format, "internal-no-invalid-meta" will already report this.
4844
return
4945
}
5046

5147
const metaProperty = getPropertyFromObject('meta', exportsNode)
52-
const metaDocs = metaProperty && getPropertyFromObject('docs', metaProperty.value)
53-
const metaDocsDescription = metaDocs && getPropertyFromObject('description', metaDocs.value)
48+
const metaDocs =
49+
metaProperty && getPropertyFromObject('docs', metaProperty.value)
50+
const metaDocsDescription =
51+
metaDocs && getPropertyFromObject('description', metaDocs.value)
5452

5553
if (!metaDocsDescription) {
5654
// if there is no `meta.docs.description` property, "internal-no-invalid-meta" will already report this.
@@ -88,7 +86,8 @@ function checkMetaDocsDescription (context, exportsNode) {
8886
if (ALLOWED_FIRST_WORDS.indexOf(firstWord) === -1) {
8987
context.report({
9088
node: metaDocsDescription.value,
91-
message: '`meta.docs.description` should start with one of the following words: {{ allowedWords }}. Started with "{{ firstWord }}" instead.',
89+
message:
90+
'`meta.docs.description` should start with one of the following words: {{ allowedWords }}. Started with "{{ firstWord }}" instead.',
9291
data: {
9392
allowedWords: ALLOWED_FIRST_WORDS.join(', '),
9493
firstWord
@@ -100,7 +99,7 @@ function checkMetaDocsDescription (context, exportsNode) {
10099
context.report({
101100
node: metaDocsDescription.value,
102101
message: '`meta.docs.description` should not end with `.`.',
103-
fix (fixer) {
102+
fix(fixer) {
104103
const pos = metaDocsDescription.range[1] - 2
105104
return fixer.removeRange([pos, pos + 1])
106105
}
@@ -115,22 +114,25 @@ function checkMetaDocsDescription (context, exportsNode) {
115114
module.exports = {
116115
meta: {
117116
docs: {
118-
description: 'enforce correct conventions of `meta.docs.description` property in core rules',
117+
description:
118+
'enforce correct conventions of `meta.docs.description` property in core rules',
119119
categories: ['Internal']
120120
},
121121
fixable: 'code',
122122
schema: []
123123
},
124124

125-
create (context) {
125+
create(context) {
126126
return {
127-
AssignmentExpression (node) {
128-
if (node.left &&
129-
node.right &&
130-
node.left.type === 'MemberExpression' &&
131-
node.left.object.name === 'module' &&
132-
node.left.property.name === 'exports' &&
133-
node.right.type === 'ObjectExpression') {
127+
AssignmentExpression(node) {
128+
if (
129+
node.left &&
130+
node.right &&
131+
node.left.type === 'MemberExpression' &&
132+
node.left.object.name === 'module' &&
133+
node.left.property.name === 'exports' &&
134+
node.right.type === 'ObjectExpression'
135+
) {
134136
checkMetaDocsDescription(context, node.right)
135137
}
136138
}

0 commit comments

Comments
 (0)