Added CLI option to enable and clear the cache 🧣

.gitignore

@@ -5,6 +5,7 @@ lib/
 node_modules
 
 # tests
+.lintpilotcache/
 coverage/
 
 # logs

jest-config/setup.ts

@@ -32,8 +32,11 @@ expect.extend({
       isCalledWithExpected = expected.every((arg, index) => this.equals(received.mock.calls[0][index], arg))
     }
 
+    const printExpected = this.utils.printExpected(expected)
+    const printReceived = this.utils.printReceived(received.mock.calls[0])
+
     return {
-      message: () => `expected ${received.getMockName()} to have been called exactly once with "${expected}" but received "${received.mock.calls[0]}"`,
+      message: () => `expected ${received.getMockName()} to have been called exactly once with arguments. Expected:\n\n${printExpected}\n\nReceived:\n\n${printReceived}\n`,
       pass: isCalledOnce && isCalledWithExpected,
     }
   },

src/index.ts

@@ -2,6 +2,7 @@
 import { Command } from 'commander'
 
 import { Events, Linter } from '@Types'
+import { clearCacheDirectory } from '@Utils/cache'
 import colourLog from '@Utils/colourLog'
 import { notifyResults } from '@Utils/notifier'
 import { clearTerminal } from '@Utils/terminal'
@@ -22,7 +23,7 @@ program
   .addHelpText('beforeAll', '\n✈️ Lint Pilot ✈️\n')
   .showHelpAfterError('\n💡 Run `lint-pilot --help` for more information.\n')
 
-const runLinter = async ({ filePattern, fix, linter, ignore }: RunLinter) => {
+const runLinter = async ({ cache, filePattern, fix, linter, ignore }: RunLinter) => {
   const startTime = new Date().getTime()
   colourLog.info(`Running ${linter.toLowerCase()}...`)
 
@@ -33,6 +34,7 @@ const runLinter = async ({ filePattern, fix, linter, ignore }: RunLinter) => {
   })
 
   const report: LintReport = await linters[linter].lintFiles({
+    cache,
     files,
     fix,
   })
@@ -42,24 +44,27 @@ const runLinter = async ({ filePattern, fix, linter, ignore }: RunLinter) => {
   return report
 }
 
-const runLintPilot = ({ filePatterns, fix, title, watch }: RunLintPilot) => {
+const runLintPilot = ({ cache, filePatterns, fix, title, watch }: RunLintPilot) => {
+  const commonArgs = {
+    cache,
+    fix,
+    ignore: filePatterns.ignorePatterns,
+  }
+
   Promise.all([
     runLinter({
+      ...commonArgs,
       filePattern: filePatterns.includePatterns[Linter.ESLint],
-      fix,
-      ignore: filePatterns.ignorePatterns,
       linter: Linter.ESLint,
     }),
     runLinter({
+      ...commonArgs,
       filePattern: filePatterns.includePatterns[Linter.Markdownlint],
-      fix,
-      ignore: filePatterns.ignorePatterns,
       linter: Linter.Markdownlint,
     }),
     runLinter({
+      ...commonArgs,
       filePattern: filePatterns.includePatterns[Linter.Stylelint],
-      fix,
-      ignore: filePatterns.ignorePatterns,
       linter: Linter.Stylelint,
     }),
   ]).then((reports) => {
@@ -88,24 +93,31 @@ program
   .option('--fix', 'automatically fix problems', false)
   .option('-w, --watch', 'watch for file changes and re-run the linters', false)
 
+  .option('--cache', 'cache linting results', false)
+  .option('--clearCache', 'clear the cache', false)
+
   .option('--ignore-dirs <directories...>', 'Directories to ignore globally')
   .option('--ignore-patterns <patterns...>', 'File patterns to ignore globally')
   .option('--eslint-include <patterns...>', 'File patterns to include for ESLint')
 
   .option('--debug', 'output additional debug information including the list of files being linted', false)
-  .action(({ debug, emoji, eslintInclude, fix, ignoreDirs, ignorePatterns, title, watch }) => {
+  .action(({ cache, clearCache, debug, emoji, eslintInclude, fix, ignoreDirs, ignorePatterns, title, watch }) => {
     clearTerminal()
     colourLog.title(`${emoji} ${title} ${emoji}`)
     console.log()
 
+    if (clearCache) {
+      clearCacheDirectory()
+    }
+
     global.debug = debug
 
     const filePatterns = getFilePatterns({
       eslintInclude,
       ignoreDirs,
       ignorePatterns,
     })
-    runLintPilot({ filePatterns, fix, title, watch })
+    runLintPilot({ cache, filePatterns, fix, title, watch })
 
     if (watch) {
       watchFiles({
@@ -117,7 +129,7 @@ program
         clearTerminal()
         colourLog.info(message)
         console.log()
-        runLintPilot({ filePatterns, fix, title, watch })
+        runLintPilot({ cache, filePatterns, fix, title, watch })
       })
     }
   })

src/linters/__tests__/eslint.spec.ts

@@ -32,12 +32,30 @@ describe('eslint', () => {
     lintFilesMock.mockImplementationOnce(() => [])
 
     await eslintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false
     })
 
     expect(ESLint).toHaveBeenCalledOnceWith({
       cache: false,
+      cacheLocation: undefined,
+      fix: false,
+    })
+  })
+
+  it('creates a new ESLint instance with cacheing enabled', async () => {
+    lintFilesMock.mockImplementationOnce(() => [])
+
+    await eslintLib.lintFiles({
+      cache: true,
+      files: testFiles,
+      fix: false
+    })
+
+    expect(ESLint).toHaveBeenCalledOnceWith({
+      cache: true,
+      cacheLocation: expect.stringContaining('.lintpilotcache/.eslintcache'),
       fix: false,
     })
   })
@@ -46,6 +64,7 @@ describe('eslint', () => {
     lintFilesMock.mockImplementationOnce(() => [])
 
     await eslintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false
     })
@@ -64,6 +83,7 @@ describe('eslint', () => {
 
     try {
       await eslintLib.lintFiles({
+        cache: false,
         files: testFiles,
         fix: false
       })
@@ -79,6 +99,7 @@ describe('eslint', () => {
     lintFilesMock.mockImplementationOnce(() => lintResults)
 
     expect(await eslintLib.lintFiles({
+      cache: false,
       files: [],
       fix: false
     })).toStrictEqual({
@@ -99,6 +120,7 @@ describe('eslint', () => {
     lintFilesMock.mockImplementationOnce(() => noErrorLintResults)
 
     expect(await eslintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false
     })).toStrictEqual({
@@ -204,6 +226,7 @@ describe('eslint', () => {
     lintFilesMock.mockImplementationOnce(() => lintResults)
 
     expect(await eslintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false
     })).toStrictEqual({
@@ -263,6 +286,7 @@ describe('eslint', () => {
     lintFilesMock.mockImplementationOnce(() => noErrorLintResults)
 
     await eslintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false
     })
@@ -278,6 +302,7 @@ describe('eslint', () => {
     lintFilesMock.mockImplementationOnce(() => noErrorLintResults)
 
     await eslintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: true
     })

src/linters/__tests__/stylelint.spec.ts

@@ -32,19 +32,49 @@ describe('stylelint', () => {
     }))
 
     await stylelintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false,
     })
 
-    expect(stylelint.lint).toHaveBeenCalledOnceWith(expect.objectContaining({
+    expect(stylelint.lint).toHaveBeenCalledOnceWith({
       allowEmptyInput: true,
+      cache: false,
+      cacheLocation: undefined,
+      config: expect.anything(),
       files: testFiles,
       fix: false,
       quietDeprecationWarnings: true,
       reportDescriptionlessDisables: true,
       reportInvalidScopeDisables: true,
       reportNeedlessDisables: true,
+    })
+  })
+
+  it('calls stylelint.lint with cacheing enabled', async () => {
+    lintFilesMock.mockImplementationOnce(() => ({
+      results: [],
+      ruleMetadata: {},
     }))
+
+    await stylelintLib.lintFiles({
+      cache: true,
+      files: testFiles,
+      fix: false,
+    })
+
+    expect(stylelint.lint).toHaveBeenCalledOnceWith({
+      allowEmptyInput: true,
+      cache: true,
+      cacheLocation: expect.stringContaining('.lintpilotcache/.stylelintcache'),
+      config: expect.anything(),
+      files: testFiles,
+      fix: false,
+      quietDeprecationWarnings: true,
+      reportDescriptionlessDisables: true,
+      reportInvalidScopeDisables: true,
+      reportNeedlessDisables: true,
+    })
   })
 
   it('exists the process when stylelint throws an error', async () => {
@@ -58,6 +88,7 @@ describe('stylelint', () => {
 
     try {
       await stylelintLib.lintFiles({
+        cache: false,
         files: testFiles,
         fix: false,
       })
@@ -76,6 +107,7 @@ describe('stylelint', () => {
     }))
 
     expect(await stylelintLib.lintFiles({
+      cache: false,
       files: [],
       fix: false,
     })).toStrictEqual({
@@ -99,6 +131,7 @@ describe('stylelint', () => {
     }))
 
     expect(await stylelintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false,
     })).toStrictEqual({
@@ -203,6 +236,7 @@ describe('stylelint', () => {
     }))
 
     expect(await stylelintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false,
     })).toStrictEqual({
@@ -260,6 +294,7 @@ describe('stylelint', () => {
     }))
 
     await stylelintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false,
     })
@@ -277,6 +312,7 @@ describe('stylelint', () => {
     }))
 
     await stylelintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: true,
     })

src/linters/eslint.ts

@@ -1,15 +1,17 @@
 import { ESLint } from 'eslint'
 
 import { Linter, RuleSeverity } from '@Types'
+import { getCacheDirectory } from '@Utils/cache'
 import colourLog from '@Utils/colourLog'
 import { formatResult } from '@Utils/transform'
 
 import type { LintFiles, LintReport, ReportResults, ReportSummary } from '@Types'
 
-const lintFiles = async ({ files, fix }: LintFiles): Promise<LintReport> => {
+const lintFiles = async ({ cache, files, fix }: LintFiles): Promise<LintReport> => {
   try {
     const eslint = new ESLint({
-      cache: false,
+      cache,
+      cacheLocation: cache ? getCacheDirectory('.eslintcache') : undefined,
       fix,
     })
 

src/linters/markdownlint/__tests__/index.spec.ts

@@ -28,6 +28,7 @@ describe('markdownlint', () => {
     jest.mocked(markdownlintAsync).mockResolvedValueOnce({})
 
     await markdownlintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false,
     })
@@ -40,6 +41,7 @@ describe('markdownlint', () => {
     jest.mocked(markdownlintAsync).mockResolvedValueOnce({})
 
     await markdownlintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false,
     })
@@ -61,6 +63,7 @@ describe('markdownlint', () => {
 
     try {
       await markdownlintLib.lintFiles({
+        cache: false,
         files: testFiles,
         fix: false,
       })
@@ -78,6 +81,7 @@ describe('markdownlint', () => {
     jest.mocked(markdownlintAsync).mockResolvedValueOnce(lintResults)
 
     await markdownlintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: false,
     })
@@ -97,6 +101,7 @@ describe('markdownlint', () => {
     jest.mocked(markdownlintAsync).mockResolvedValueOnce(lintResults)
 
     await markdownlintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: true,
     })
@@ -121,6 +126,7 @@ describe('markdownlint', () => {
       .mockResolvedValueOnce(lintResultsWithoutError)
 
     await markdownlintLib.lintFiles({
+      cache: false,
       files: testFiles,
       fix: true,
     })