Autofix eslint errors 🚗

01taylop · Jul 23, 2024 · b34098a · b34098a
1 parent 351d456
commit b34098a
Show file tree

Hide file tree

Showing 5 changed files with 132 additions and 16 deletions.
diff --git a/babel.config.cjs b/babel.config.cjs
@@ -9,6 +9,6 @@ module.exports = {
   plugins: [
     ['babel-plugin-transform-import-meta', {
       module: 'ES6',
-    }]
-  ]
+    }],
+  ],
 }
diff --git a/eslint.config.js b/eslint.config.js
@@ -1,5 +1,6 @@
 export default [{
   rules: {
+    'comma-dangle': [2, 'always-multiline'],
     quotes: [2, 'single'],
     semi: [2, 'never'],
   },

diff --git a/package.json b/package.json
@@ -16,7 +16,7 @@
   "scripts": {
     "build": "rimraf lib && mkdir lib && rollup -c && yarn buildConfig",
     "buildConfig": "tsx ./scripts/build-config.ts",
-    "lint": "NODE_ENV=development tsx src/index.js",
+    "lint": "NODE_ENV=development tsx src/index.js --ignore-dirs lib",
     "publishLib": "yarn test --coverage && yarn build && cd lib && npm publish",
     "test": "jest"
   },

diff --git a/src/linters/__tests__/eslint.spec.ts b/src/linters/__tests__/eslint.spec.ts
@@ -13,11 +13,21 @@ describe('eslint', () => {
 
   const testFiles = ['index.ts']
   const lintFilesMock = ESLint.prototype.lintFiles as jest.Mock
+  const outputFixesMock = ESLint.outputFixes as jest.Mock
+
+  const resultThemes = {
+    messageTheme: expect.any(Function),
+    positionTheme: expect.any(Function),
+    ruleTheme: expect.any(Function),
+  }
 
   it('creates a new ESLint instance', async () => {
     lintFilesMock.mockImplementationOnce(() => [])
 
-    await eslintLib.lintFiles(testFiles)
+    await eslintLib.lintFiles({
+      files: testFiles,
+      fix: false
+    })
 
     expect(ESLint).toHaveBeenCalledOnceWith({
       cache: false,
@@ -28,7 +38,10 @@ describe('eslint', () => {
   it('calls ESLint.lintFiles with the files', async () => {
     lintFilesMock.mockImplementationOnce(() => [])
 
-    await eslintLib.lintFiles(testFiles)
+    await eslintLib.lintFiles({
+      files: testFiles,
+      fix: false
+    })
 
     expect(ESLint.prototype.lintFiles).toHaveBeenCalledOnceWith(testFiles)
   })
@@ -43,7 +56,10 @@ describe('eslint', () => {
     })
 
     try {
-      await eslintLib.lintFiles(testFiles)
+      await eslintLib.lintFiles({
+        files: testFiles,
+        fix: false
+      })
     } catch {
       expect(colourLog.error).toHaveBeenCalledOnceWith('An error occurred while running eslint', error)
       expect(process.exit).toHaveBeenCalledWith(1)
@@ -55,7 +71,10 @@ describe('eslint', () => {
 
     lintFilesMock.mockImplementationOnce(() => lintResults)
 
-    expect(await eslintLib.lintFiles([])).toStrictEqual({
+    expect(await eslintLib.lintFiles({
+      files: [],
+      fix: false
+    })).toStrictEqual({
       results: {},
       summary: {
         deprecatedRules: [],
@@ -84,7 +103,10 @@ describe('eslint', () => {
 
     lintFilesMock.mockImplementationOnce(() => lintResults)
 
-    expect(await eslintLib.lintFiles(testFiles)).toStrictEqual({
+    expect(await eslintLib.lintFiles({
+      files: testFiles,
+      fix: false
+    })).toStrictEqual({
       results: {},
       summary: {
         deprecatedRules: [],
@@ -184,15 +206,12 @@ describe('eslint', () => {
       warningCount: 0,
     }]
 
-    const resultThemes = {
-      messageTheme: expect.any(Function),
-      positionTheme: expect.any(Function),
-      ruleTheme: expect.any(Function),
-    }
-
     lintFilesMock.mockImplementationOnce(() => lintResults)
 
-    expect(await eslintLib.lintFiles(testFiles)).toStrictEqual({
+    expect(await eslintLib.lintFiles({
+      files: testFiles,
+      fix: false
+    })).toStrictEqual({
       results: {
         'index.ts': [{
           ...resultThemes,
@@ -245,4 +264,96 @@ describe('eslint', () => {
     })
   })
 
+  it('does not fix lint errors when the fix option is disabled', async () => {
+    const lintResults: Array<ESLint.LintResult> = [{
+      errorCount: 1,
+      fatalErrorCount: 0,
+      filePath: `${process.cwd()}/index.ts`,
+      fixableErrorCount: 1,
+      fixableWarningCount: 0,
+      messages: [{
+        column: 1,
+        line: 1,
+        message: 'Fixable error rule',
+        ruleId: 'fixable-error-rule',
+        severity: 2,
+      }],
+      suppressedMessages: [],
+      usedDeprecatedRules: [],
+      warningCount: 0,
+    }]
+
+    lintFilesMock.mockImplementationOnce(() => lintResults)
+
+    const result = await eslintLib.lintFiles({
+      files: testFiles,
+      fix: false
+    })
+
+    expect(ESLint).toHaveBeenCalledOnceWith({
+      cache: false,
+      fix: false,
+    })
+    expect(result).toStrictEqual({
+      results: {
+        'index.ts': [{
+          ...resultThemes,
+          message: 'Fixable error rule',
+          position: '1:1',
+          rule: 'fixable-error-rule',
+          severity: 'X',
+        }],
+      },
+      summary: {
+        deprecatedRules: [],
+        errorCount: 1,
+        fileCount: 1,
+        fixableErrorCount: 1,
+        fixableWarningCount: 0,
+        linter: 'ESLint',
+        warningCount: 0,
+      },
+    })
+    expect(outputFixesMock).not.toHaveBeenCalled()
+  })
+
+  it('fixes lint errors when the fix option is enabled', async () => {
+    const lintResults: Array<ESLint.LintResult> = [{
+      errorCount: 0,
+      fatalErrorCount: 0,
+      filePath: `${process.cwd()}/index.ts`,
+      fixableErrorCount: 0,
+      fixableWarningCount: 0,
+      messages: [],
+      suppressedMessages: [],
+      usedDeprecatedRules: [],
+      warningCount: 0,
+    }]
+
+    lintFilesMock.mockImplementationOnce(() => lintResults)
+
+    const result = await eslintLib.lintFiles({
+      files: testFiles,
+      fix: true
+    })
+
+    expect(ESLint).toHaveBeenCalledOnceWith({
+      cache: false,
+      fix: true,
+    })
+    expect(result).toStrictEqual({
+      results: {},
+      summary: {
+        deprecatedRules: [],
+        errorCount: 0,
+        fileCount: 1,
+        fixableErrorCount: 0,
+        fixableWarningCount: 0,
+        linter: 'ESLint',
+        warningCount: 0,
+      },
+    })
+    expect(outputFixesMock).toHaveBeenCalledOnceWith(lintResults)
+  })
+
 })
diff --git a/src/linters/eslint.ts b/src/linters/eslint.ts
@@ -10,7 +10,7 @@ const lintFiles = async ({ files, fix }: LintFiles): Promise<LintReport> => {
   try {
     const eslint = new ESLint({
       cache: false,
-      fix: false,
+      fix,
     })
 
     const lintResults: Array<ESLint.LintResult> = await eslint.lintFiles(files)
@@ -51,6 +51,10 @@ const lintFiles = async ({ files, fix }: LintFiles): Promise<LintReport> => {
       })
     })
 
+    if (fix) {
+      await ESLint.outputFixes(lintResults)
+    }
+
     return {
       results: reportResults,
       summary: reportSummary,