Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: upgrade to eslint 6 #4933

Merged
merged 13 commits into from Jan 14, 2020
Merged
17 changes: 11 additions & 6 deletions package.json
Expand Up @@ -45,22 +45,27 @@
},
"devDependencies": {
"@babel/core": "^7.7.4",
"@vue/eslint-config-airbnb": "^4.0.0",
"@vue/eslint-config-prettier": "^5.0.0",
"@vue/eslint-config-standard": "^4.0.0",
"@vue/eslint-config-typescript": "^4.0.0",
"@vue/eslint-config-airbnb": "^5.0.0",
"@vue/eslint-config-prettier": "^6.0.0",
"@vue/eslint-config-standard": "^5.0.0",
"@vue/eslint-config-typescript": "^5.0.1",
"@vuepress/plugin-pwa": "^1.2.0",
"@vuepress/theme-vue": "^1.2.0",
"@typescript-eslint/eslint-plugin": "^2.10.0",
"@typescript-eslint/parser": "^2.10.0",
"babel-core": "7.0.0-bridge.0",
"babel-eslint": "^10.0.3",
"babel-jest": "^24.9.0",
"chromedriver": "^78.0.1",
"debug": "^4.1.0",
"eslint": "^5.16.0",
"eslint": "^6.7.2",
"eslint-plugin-import": "^2.18.2",
"eslint-plugin-graphql": "^3.1.0",
"eslint-plugin-node": "^9.1.0",
"eslint-plugin-prettier": "^3.1.1",
"eslint-plugin-vue": "^5.2.2",
"eslint-plugin-promise": "^4.2.1",
"eslint-plugin-standard": "^4.0.0",
"eslint-plugin-vue": "^6.0.1",
"eslint-plugin-vue-libs": "^4.0.0",
"execa": "^1.0.0",
"geckodriver": "^1.19.1",
Expand Down
50 changes: 34 additions & 16 deletions packages/@vue/cli-plugin-eslint/__tests__/eslintGenerator.spec.js
Expand Up @@ -14,9 +14,6 @@ test('base', async () => {
expect(pkg.eslintConfig.extends).toEqual([
'plugin:vue/essential', 'eslint:recommended'
])
expect(pkg.eslintConfig.parserOptions).toEqual({
parser: 'babel-eslint'
})
})

test('airbnb', async () => {
Expand All @@ -33,9 +30,6 @@ test('airbnb', async () => {
'plugin:vue/essential',
'@vue/airbnb'
])
expect(pkg.eslintConfig.parserOptions).toEqual({
parser: 'babel-eslint'
})
expect(pkg.devDependencies).toHaveProperty('@vue/eslint-config-airbnb')
})

Expand All @@ -53,9 +47,6 @@ test('standard', async () => {
'plugin:vue/essential',
'@vue/standard'
])
expect(pkg.eslintConfig.parserOptions).toEqual({
parser: 'babel-eslint'
})
expect(pkg.devDependencies).toHaveProperty('@vue/eslint-config-standard')
})

Expand All @@ -71,12 +62,31 @@ test('prettier', async () => {
expect(pkg.scripts.lint).toBeTruthy()
expect(pkg.eslintConfig.extends).toEqual([
'plugin:vue/essential',
'eslint:recommended',
'@vue/prettier'
])
expect(pkg.devDependencies).toHaveProperty('@vue/eslint-config-prettier')
})

test('babel', async () => {
const { pkg } = await generateWithPlugin([
{
id: 'eslint',
apply: require('../generator'),
options: {}
},
{
id: 'babel',
apply: require('@vue/cli-plugin-babel/generator'),
options: {}
}
])

expect(pkg.scripts.lint).toBeTruthy()
expect(pkg.devDependencies).toHaveProperty('babel-eslint')
expect(pkg.eslintConfig.parserOptions).toEqual({
parser: 'babel-eslint'
})
expect(pkg.devDependencies).toHaveProperty('@vue/eslint-config-prettier')
})

test('typescript', async () => {
Expand All @@ -98,12 +108,11 @@ test('typescript', async () => {
expect(pkg.scripts.lint).toBeTruthy()
expect(pkg.eslintConfig.extends).toEqual([
'plugin:vue/essential',
'eslint:recommended',
'@vue/typescript/recommended',
'@vue/prettier',
'@vue/typescript'
'@vue/prettier/@typescript-eslint'
])
expect(pkg.eslintConfig.parserOptions).toEqual({
parser: '@typescript-eslint/parser'
})
expect(pkg.devDependencies).toHaveProperty('@vue/eslint-config-prettier')
expect(pkg.devDependencies).toHaveProperty('@vue/eslint-config-typescript')
})
Expand Down Expand Up @@ -131,7 +140,7 @@ test('lint on commit', async () => {
expect(pkg.gitHooks['pre-commit']).toBe('lint-staged')
expect(pkg.devDependencies).toHaveProperty('lint-staged')
expect(pkg['lint-staged']).toEqual({
'*.{js,vue}': ['vue-cli-service lint', 'git add']
'*.{js,jsx,vue}': ['vue-cli-service lint', 'git add']
})
expect(pkg.vue).toEqual({
lintOnSave: false
Expand All @@ -150,7 +159,7 @@ test('should lint ts files when typescript plugin co-exists', async () => {
const pkg = JSON.parse(await read('package.json'))
expect(pkg).toMatchObject({
'lint-staged': {
'*.{js,vue,ts}': ['vue-cli-service lint', 'git add']
'*.{js,jsx,vue,ts,tsx}': ['vue-cli-service lint', 'git add']
}
})
})
Expand Down Expand Up @@ -196,3 +205,12 @@ test('airbnb config + typescript + unit-mocha', async () => {
}
})
}, 30000)

test('should be able to parse dynamic import syntax', async () => {
await create('eslint-dynamic-import', {
plugins: {
'@vue/cli-plugin-eslint': {},
'@vue/cli-plugin-router': {}
}
})
}, 30000)
84 changes: 53 additions & 31 deletions packages/@vue/cli-plugin-eslint/generator/index.js
Expand Up @@ -2,49 +2,75 @@ const fs = require('fs')
const path = require('path')

module.exports = (api, { config, lintOn = [] }, _, invoking) => {
if (typeof lintOn === 'string') {
lintOn = lintOn.split(',')
}

const eslintConfig = require('../eslintOptions').config(api)
const extentions = require('../eslintOptions').extensions(api)
.map(ext => ext.replace(/^\./, '')) // remove the leading `.`

const pkg = {
scripts: {
lint: 'vue-cli-service lint'
},
eslintConfig,
devDependencies: {
'eslint': '^5.16.0',
'eslint-plugin-vue': '^5.0.0'
eslint: '^6.7.2',
'eslint-plugin-vue': '^6.0.1'
}
}

if (!api.hasPlugin('typescript')) {
// required for dynamic import support
pkg.devDependencies['babel-eslint'] = '^10.0.3'
}

if (config === 'airbnb') {
switch (config) {
case 'airbnb':
eslintConfig.extends.push('@vue/airbnb')
Object.assign(pkg.devDependencies, {
'@vue/eslint-config-airbnb': '^4.0.0'
'@vue/eslint-config-airbnb': '^5.0.0',
'eslint-plugin-import': '^2.18.2'
})
} else if (config === 'standard') {
break
case 'standard':
eslintConfig.extends.push('@vue/standard')
Object.assign(pkg.devDependencies, {
'@vue/eslint-config-standard': '^4.0.0'
'@vue/eslint-config-standard': '^5.0.0',
'eslint-plugin-import': '^2.18.2',
'eslint-plugin-node': '^9.1.0',
'eslint-plugin-promise': '^4.2.1',
'eslint-plugin-standard': '^4.0.0'
})
} else if (config === 'prettier') {
eslintConfig.extends.push('@vue/prettier')
break
case 'prettier':
eslintConfig.extends.push(
...(api.hasPlugin('typescript')
? ['eslint:recommended', '@vue/typescript/recommended', '@vue/prettier', '@vue/prettier/@typescript-eslint']
: ['eslint:recommended', '@vue/prettier']
)
)
Object.assign(pkg.devDependencies, {
'@vue/eslint-config-prettier': '^5.0.0',
'@vue/eslint-config-prettier': '^6.0.0',
'eslint-plugin-prettier': '^3.1.1',
prettier: '^1.19.1'
})
// prettier & default config do not have any style rules
// so no need to generate an editorconfig file
} else {
break
default:
// default
eslintConfig.extends.push('eslint:recommended')
break
}

// typescript support
if (api.hasPlugin('typescript')) {
Object.assign(pkg.devDependencies, {
'@vue/eslint-config-typescript': '^5.0.1',
'@typescript-eslint/eslint-plugin': '^2.10.0',
'@typescript-eslint/parser': '^2.10.0'
})
if (config !== 'prettier') {
// for any config other than `prettier`,
// typescript ruleset should be appended to the end of the `extends` array
eslintConfig.extends.push('@vue/typescript/recommended')
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure whether we should use @vue/typescript/recommended or @vue/typescript here.

}
}

const editorConfigTemplatePath = path.resolve(__dirname, `./template/${config}/_editorconfig`)
Expand All @@ -60,6 +86,10 @@ module.exports = (api, { config, lintOn = [] }, _, invoking) => {
}
}

if (typeof lintOn === 'string') {
lintOn = lintOn.split(',')
}

if (!lintOn.includes('save')) {
pkg.vue = {
lintOnSave: false // eslint-loader configured in runtime plugin
Expand All @@ -73,24 +103,13 @@ module.exports = (api, { config, lintOn = [] }, _, invoking) => {
pkg.gitHooks = {
'pre-commit': 'lint-staged'
}
if (api.hasPlugin('typescript')) {
pkg['lint-staged'] = {
'*.{js,vue,ts}': ['vue-cli-service lint', 'git add']
}
} else {
pkg['lint-staged'] = {
'*.{js,vue}': ['vue-cli-service lint', 'git add']
}
pkg['lint-staged'] = {
[`*.{${extentions.join(',')}}`]: ['vue-cli-service lint', 'git add']
}
}

api.extendPackage(pkg)

// typescript support
if (api.hasPlugin('typescript')) {
applyTS(api)
}

// invoking only
if (invoking) {
if (api.hasPlugin('unit-mocha')) {
Expand Down Expand Up @@ -130,7 +149,8 @@ module.exports.hooks = (api) => {
})
}

const applyTS = module.exports.applyTS = api => {
// exposed for the typescript plugin
module.exports.applyTS = api => {
sodatea marked this conversation as resolved.
Show resolved Hide resolved
api.extendPackage({
eslintConfig: {
extends: ['@vue/typescript'],
Expand All @@ -139,7 +159,9 @@ const applyTS = module.exports.applyTS = api => {
}
},
devDependencies: {
'@vue/eslint-config-typescript': '^4.0.0'
'@vue/eslint-config-typescript': '^5.0.1',
'@typescript-eslint/eslint-plugin': '^2.7.0',
'@typescript-eslint/parser': '^2.7.0'
}
})
}
9 changes: 7 additions & 2 deletions packages/@vue/cli-ui-addon-webpack/package.json
Expand Up @@ -21,9 +21,14 @@
"@vue/cli-plugin-babel": "^4.1.1",
"@vue/cli-plugin-eslint": "^4.1.1",
"@vue/cli-service": "^4.1.1",
"@vue/eslint-config-standard": "^4.0.0",
"@vue/eslint-config-standard": "^5.0.0",
"core-js": "^3.4.4",
"eslint": "^5.16.0",
"eslint": "^6.7.2",
"eslint-plugin-import": "^2.18.0",
"eslint-plugin-node": "^9.1.0",
"eslint-plugin-promise": "^4.2.1",
"eslint-plugin-standard": "^4.0.0",
"eslint-plugin-vue": "^6.0.1",
"stylus": "^0.54.7",
"stylus-loader": "^3.0.2",
"vue-progress-path": "^0.0.2",
Expand Down
4 changes: 2 additions & 2 deletions packages/@vue/cli-ui-addon-webpack/src/mixins/Dashboard.js
Expand Up @@ -16,8 +16,8 @@ export default {

sharedData () {
return {
serveUrl: `org.vue.webpack.serve-url`,
modernMode: `org.vue.webpack.modern-mode`
serveUrl: 'org.vue.webpack.serve-url',
modernMode: 'org.vue.webpack.modern-mode'
}
},

Expand Down
2 changes: 1 addition & 1 deletion packages/@vue/cli-ui-addon-widgets/.eslintrc.js
Expand Up @@ -3,7 +3,7 @@ module.exports = {
env: {
node: true
},
'extends': [
extends: [
'plugin:vue/essential',
'@vue/standard'
],
Expand Down
9 changes: 7 additions & 2 deletions packages/@vue/cli-ui-addon-widgets/package.json
Expand Up @@ -21,9 +21,14 @@
"@vue/cli-plugin-babel": "^4.1.1",
"@vue/cli-plugin-eslint": "^4.1.1",
"@vue/cli-service": "^4.1.1",
"@vue/eslint-config-standard": "^4.0.0",
"@vue/eslint-config-standard": "^5.0.0",
"core-js": "^3.4.4",
"eslint": "^5.16.0",
"eslint": "^6.7.2",
"eslint-plugin-import": "^2.18.0",
"eslint-plugin-node": "^9.1.0",
"eslint-plugin-promise": "^4.2.1",
"eslint-plugin-standard": "^4.0.0",
"eslint-plugin-vue": "^6.0.1",
"stylus": "^0.54.7",
"stylus-loader": "^3.0.2",
"vue-template-compiler": "^2.6.10"
Expand Down
6 changes: 3 additions & 3 deletions packages/@vue/cli-ui-addon-widgets/src/components/News.vue
Expand Up @@ -69,13 +69,13 @@ import NewsItem from './NewsItem.vue'
import NewsItemDetails from './NewsItemDetails.vue'

const ERRORS = {
'fetch': {
fetch: {
icon: 'error'
},
'offline': {
offline: {
icon: 'cloud_off'
},
'empty': {
empty: {
icon: 'cake'
}
}
Expand Down
Expand Up @@ -28,10 +28,10 @@ import { UPDATES_ICON_CLASSES } from '../util/consts'
import StatusWidget from './StatusWidget.vue'

const UPDATES_ICONS = {
'ok': 'verified_user',
'loading': 'hourglass_empty',
'attention': 'error',
'error': 'error'
ok: 'verified_user',
loading: 'hourglass_empty',
attention: 'error',
error: 'error'
}

export const SEVERITIES = {
Expand Down
12 changes: 6 additions & 6 deletions packages/@vue/cli-ui-addon-widgets/src/util/consts.js
@@ -1,11 +1,11 @@
export const UPDATES_ICONS = {
'ok': 'check_circle',
'loading': 'hourglass_full',
'attention': 'error'
ok: 'check_circle',
loading: 'hourglass_full',
attention: 'error'
}

export const UPDATES_ICON_CLASSES = {
'ok': 'success',
'loading': '',
'attention': 'warning'
ok: 'success',
loading: '',
attention: 'warning'
}