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.

Sign up for GitHub

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

Jump to bottom

feat: switch to stylish formatter for eslint #6748

Merged
merged 1 commit into from Oct 13, 2021
Merged

feat: switch to stylish formatter for eslint #6748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/core-plugins/eslint.md
View file
Open in desktop
Expand Up @@ -11,7 +11,7 @@

Options:

--format [formatter] specify formatter (default: codeframe)
--format [formatter] specify formatter (default: stylish)
--no-fix do not fix errors
--max-errors specify number of errors to make build failed (default: 0)
--max-warnings specify number of warnings to make build failed (default: Infinity)
Expand Down
2 changes: 1 addition & 1 deletion docs/ru/core-plugins/eslint.md
View file
Open in desktop
Expand Up @@ -11,7 +11,7 @@

Опции:

--format [formatter] определяет форматтер (по умолчанию: codeframe)
--format [formatter] определяет форматтер (по умолчанию: stylish)
--no-fix отключает автоматическое исправление ошибок
--max-errors количество ошибок, по достижению которого сборка заканчивается ошибкой (по умолчанию: 0)
--max-warnings количество предупреждений, по достижению которого сборка заканчивается ошибкой (по умолчанию: Infinity)
Expand Down
2 changes: 1 addition & 1 deletion packages/@vue/cli-plugin-eslint/README.md
View file
Open in desktop
Expand Up @@ -11,7 +11,7 @@

Options:

--format [formatter] specify formatter (default: codeframe)
--format [formatter] specify formatter (default: stylish)
--no-fix do not fix errors
--max-errors specify number of errors to make build failed (default: 0)
--max-warnings specify number of warnings to make build failed (default: Infinity)
Expand Down
14 changes: 9 additions & 5 deletions packages/@vue/cli-plugin-eslint/__tests__/eslintPlugin.spec.js
View file
Open in desktop
Expand Up @@ -227,8 +227,8 @@ test('should persist cache', async () => {
expect(has('node_modules/.cache/eslint/cache.json')).toBe(true)
})

test.skip(`should use formatter 'codeframe'`, async () => {
const project = await create('eslint-formatter-codeframe', {
test(`should use formatter 'stylish'`, async () => {
const project = await create('eslint-formatter-stylish', {
plugins: {
'@vue/cli-plugin-babel': {},
'@vue/cli-plugin-eslint': {
Expand Down Expand Up @@ -259,9 +259,13 @@ test.skip(`should use formatter 'codeframe'`, async () => {
isFirstMsg = false
} else if (data.match(/semi/)) {
// check the format of output
// https://eslint.org/docs/user-guide/formatters/#codeframe
// https://eslint.org/docs/user-guide/formatters/#stylish
// it looks like:
// ERROR in .../packages/test/eslint-formatter-stylish/src/main.js
// 1:22 error Missing semicolon semi
expect(data).toMatch(`src${path.sep}main.js`)
expect(data).toMatch(`error`)
expect(data).toMatch(`Missing semicolon (semi) at src${path.sep}main.js`)
expect(data).toMatch(`Missing semicolon semi`)

server.stdin.write('close')
done()
Expand All @@ -282,7 +286,7 @@ test(`should work with eslint v8`, async () => {
}
})
const { read, write, run } = project
await run('npm add -D eslint@^8.0.0-0 eslint-formatter-codeframe')
await run('npm add -D eslint@^8.0.0-0')
// should've applied airbnb autofix
const main = await read('src/main.js')
expect(main).toMatch(';')
Expand Down
4 changes: 2 additions & 2 deletions packages/@vue/cli-plugin-eslint/index.js
View file
Open in desktop
Expand Up @@ -52,7 +52,7 @@ module.exports = (api, options) => {
resolveModule('eslint/package.json', cwd) ||
resolveModule('eslint/package.json', __dirname)
),
formatter: 'codeframe'
formatter: 'stylish'
}
webpackConfig.plugin('eslint').use(eslintWebpackPlugin, [eslintWebpackPluginOptions])
})
Expand All @@ -64,7 +64,7 @@ module.exports = (api, options) => {
description: 'lint and fix source files',
usage: 'vue-cli-service lint [options] [...files]',
options: {
'--format [formatter]': 'specify formatter (default: codeframe)',
'--format [formatter]': 'specify formatter (default: stylish)',
'--no-fix': 'do not fix errors or warnings',
'--no-fix-warnings': 'fix errors, but do not fix warnings',
'--max-errors [limit]':
Expand Down
2 changes: 1 addition & 1 deletion packages/@vue/cli-plugin-eslint/lint.js
View file
Open in desktop
Expand Up @@ -124,7 +124,7 @@ module.exports = async function lint (args = {}, api) {
const reportWarningCount = resultResults.reduce((p, c) => p + c.warningCount, 0)
process.cwd = processCwd

const formatter = await eslint.loadFormatter(args.format || 'codeframe')
const formatter = await eslint.loadFormatter(args.format || 'stylish')

if (config.outputFile) {
const outputFilePath = path.resolve(config.outputFile)
Expand Down
2 changes: 1 addition & 1 deletion packages/@vue/cli-service/types/cli-service-test.ts
View file
Open in desktop
Expand Up @@ -13,7 +13,7 @@ const servicePlugin: ServicePlugin = (api, options) => {
description: 'lint and fix source files',
usage: 'vue-cli-service lint [options] [...files]',
options: {
'--format [formatter]': 'specify formatter (default: codeframe)'
'--format [formatter]': 'specify formatter (default: stylish)'
},
details: 'For more options, see https://eslint.org/docs/user-guide/command-line-interface#options'
},
Expand Down