Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(eslint): Prepare eslint for rollup 3 and upgrade eslint to newest…
… version (#1309) Prior to these changes, the eslint plugin was using an older version of eslint that relied on a class called CLIEngine. In newer versions this has now been deprecated and so upgrading versions required also updating to using ESLint internally instead. Ultimately this doesn't change the usage of the plugin but some of the option names have changed for ESLint (notably configFile needs to change to overrideConfigFile). The main driving factor for this change is to prevent conflicts that happen when using @rollup/plugin-typescript and this plugin together. Without this update, eslint would run on the transpiled code and so the error messages weren't as helpful. This update will allow the two plugins to work well together and provide helpful information about errors and warnings. This change also includes some necessary package updates to prepare eslint for Rollup 3. BREAKING CHANGES: - options structure has changed due to moving from CLIEngine t ESlint. Review the new supported options below: https://eslint.org/docs/latest/developer-guide/nodejs-api#-new-eslintoptions - requires Node 14
- Loading branch information
1 parent
69146cd
commit daf3d4d
Showing
10 changed files
with
2,200 additions
and
1,990 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
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
This file was deleted.
Oops, something went wrong.
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,7 @@ | ||
| import { readFileSync } from 'fs'; | ||
|
|
||
| import { createConfig } from '../../shared/rollup.config.mjs'; | ||
|
|
||
| export default createConfig({ | ||
| pkg: JSON.parse(readFileSync(new URL('./package.json', import.meta.url), 'utf8')) | ||
| }); |
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 |
|---|---|---|
| @@ -1,81 +1,83 @@ | ||
| import * as path from 'path'; | ||
| import { relative, resolve, sep } from 'path'; | ||
|
|
||
| import { Plugin } from 'rollup'; | ||
| import { createFilter } from '@rollup/pluginutils'; | ||
| import { CLIEngine } from 'eslint'; | ||
| import { ESLint } from 'eslint'; | ||
|
|
||
| import { RollupEslintOptions } from '../types'; | ||
| import type { RollupEslintOptions } from '../types'; | ||
|
|
||
| function normalizePath(id: string) { | ||
| return path.relative(process.cwd(), id).split(path.sep).join('/'); | ||
| return relative(process.cwd(), id).split(sep).join('/'); | ||
| } | ||
|
|
||
| export default function eslint(options = {} as RollupEslintOptions): Plugin { | ||
| if (typeof options === 'string') { | ||
| const configFile = path.resolve(process.cwd(), options); | ||
| const configFile = resolve(process.cwd(), options); | ||
| // eslint-disable-next-line global-require, import/no-dynamic-require, no-param-reassign | ||
| options = require(configFile); | ||
| // Tell eslint not to look for configuration files. | ||
| // eslint-disable-next-line no-param-reassign | ||
| options.useEslintrc = false; | ||
| } | ||
|
|
||
| const cli = new CLIEngine(options); | ||
| let formatter: CLIEngine.Formatter; | ||
|
|
||
| switch (typeof options.formatter) { | ||
| case 'string': | ||
| formatter = cli.getFormatter(options.formatter); | ||
| break; | ||
| case 'function': | ||
| ({ formatter } = options); | ||
| break; | ||
| default: | ||
| formatter = cli.getFormatter('stylish'); | ||
| } | ||
| const { | ||
| include, | ||
| exclude = /node_modules/, | ||
| throwOnWarning = false, | ||
| throwOnError = false, | ||
| formatter = 'stylish', | ||
| ...eslintOptions | ||
| } = options; | ||
|
|
||
| const filter = createFilter(options.include, options.exclude || /node_modules/); | ||
| const eslintInstance = new ESLint(eslintOptions); | ||
| const filter = createFilter(include, exclude); | ||
|
|
||
| return { | ||
| name: 'eslint', | ||
|
|
||
| // eslint-disable-next-line consistent-return | ||
| transform(code, id) { | ||
| async transform(_, id: string) { | ||
| const file = normalizePath(id); | ||
| if (!filter(id) || cli.isPathIgnored(file)) { | ||
| if (!filter(id) || (await eslintInstance.isPathIgnored(file))) { | ||
| return null; | ||
| } | ||
|
|
||
| const report = cli.executeOnText(code, file); | ||
| const hasWarnings = options.throwOnWarning && report.warningCount !== 0; | ||
| const hasErrors = options.throwOnError && report.errorCount !== 0; | ||
| const results = await eslintInstance.lintFiles(file); | ||
| const [result] = results; | ||
|
|
||
| if (options.fix && report) { | ||
| CLIEngine.outputFixes(report); | ||
| if (eslintOptions.fix) { | ||
| await ESLint.outputFixes(results); | ||
| } | ||
|
|
||
| if (report.warningCount === 0 && report.errorCount === 0) { | ||
| if (result.warningCount === 0 && result.errorCount === 0) { | ||
| return null; | ||
| } | ||
|
|
||
| const result = formatter(report.results); | ||
| const eslintFormatter: ESLint.Formatter = | ||
| typeof formatter === 'string' | ||
| ? await eslintInstance.loadFormatter(formatter) | ||
| : { format: formatter }; | ||
| const output = eslintFormatter.format(results); | ||
|
|
||
| if (result) { | ||
| if (output) { | ||
| // eslint-disable-next-line no-console | ||
| console.log(result); | ||
| console.log(output); | ||
| } | ||
|
|
||
| if (hasWarnings && hasErrors) { | ||
| throw Error('Warnings or errors were found'); | ||
| const errorMessages = []; | ||
| if (result.warningCount > 0 && throwOnWarning) { | ||
| errorMessages.push(`${result.warningCount} warning${result.warningCount > 1 ? 's' : ''}`); | ||
| } | ||
|
|
||
| if (hasWarnings) { | ||
| throw Error('Warnings were found'); | ||
| if (result.errorCount > 0 && throwOnError) { | ||
| errorMessages.push(`${result.errorCount} error${result.errorCount > 1 ? 's' : ''}`); | ||
| } | ||
|
|
||
| if (hasErrors) { | ||
| throw Error('Errors were found'); | ||
| if (errorMessages.length > 0) { | ||
| throw new Error( | ||
| `Found ${errorMessages.join(' and ')} in ${relative('.', result.filePath)}` | ||
| ); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
| }; | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.