Lint action

.eslintrc

@@ -2,11 +2,11 @@
   "extends": [
     "./lib/all-legacy"
   ],
-  "rules": {
-    // "semi": [1, "always"]
-  },
   "parserOptions": {
     "ecmaVersion": 2018,
     "sourceType": "module"
+  },
+  "rules": {
+    // "semi": [1, "always"]
   }
 }

.github/workflows/test.yml

@@ -25,15 +25,15 @@ jobs:
         node-version: ${{ matrix.node-version }}
 
     - name: Install Dependencies
-      run: yarn install --immutable
+      run: yarn install --frozen-lockfile --ignore-scripts --no-progress --prefer-offline
 
     - name: Run Tests
       run: yarn test --coverage
 
-    - name: Run Build
+    - name: Build Lint Pilot
       run: yarn build
 
-    - name: Lint
+    - name: Run Lint Pilot
       run: |
         yarn lint --ignore-patterns '**/*.ts'
         yarn lint --eslint-use-legacy-config --ignore-patterns '**/*.ts'

eslint.config.js

@@ -5,6 +5,6 @@ export default [
   {
     rules: {
       // semi: [1, 'always'],
-    }
-  }
+    },
+  },
 ]

jest-config/setup.ts

@@ -2,11 +2,6 @@
  * MOCKS AND SPIES
  */
 
-jest.mock('log-symbols', () => ({
-  warning: '!',
-  error: 'X',
-}))
-
 jest.spyOn(process, 'exit').mockImplementation(code => {
   throw new Error(`process.exit(${code})`)
 })

jest.config.ts

@@ -6,9 +6,6 @@ const config: JestConfigWithTsJest = {
   clearMocks: true,
   collectCoverageFrom: [
     'src/**/*',
-    // TODO: Write tests for these files when they are less likely to change
-    '!src/index.ts',
-    '!src/linters/index.ts',
   ],
   coverageDirectory: 'coverage',
   coverageThreshold: {
@@ -36,7 +33,7 @@ const config: JestConfigWithTsJest = {
   },
   transformIgnorePatterns: [
     './node_modules/(?!(chalk)/)',
-  ]
+  ],
 }
 
 export default config

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-pilot",
-  "description": "Lint Pilot: Your co-pilot for maintaining high code quality with seamless ESLint, Stylelint, and MarkdownLint integration.",
+  "description": "Lint Pilot: Your co-pilot for maintaining high code quality with seamless ESLint, Stylelint, and Markdownlint integration.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/01taylop/lint-pilot.git"
@@ -33,7 +33,6 @@
     "eslint-plugin-sort-destructure-keys": "2.0.0",
     "eslint-plugin-sort-exports": "0.9.1",
     "glob": "10.4.5",
-    "log-symbols": "7.0.0",
     "markdownlint": "0.35.0",
     "markdownlint-rule-helpers": "0.26.0",
     "node-notifier": "10.0.1",
@@ -50,6 +49,7 @@
     "@babel/core": "7.25.2",
     "@babel/preset-env": "7.25.4",
     "@babel/preset-typescript": "7.24.7",
+    "@rollup/plugin-json": "6.1.0",
     "@rollup/plugin-node-resolve": "15.2.3",
     "@rollup/plugin-typescript": "11.1.6",
     "@types/eslint": "9.6.1",

rollup.config.js

@@ -1,6 +1,7 @@
 import { readFileSync } from 'node:fs'
 import { resolve } from 'node:path'
 
+import json from '@rollup/plugin-json'
 import { nodeResolve } from '@rollup/plugin-node-resolve'
 import typescript from '@rollup/plugin-typescript'
 import copy from 'rollup-plugin-copy'
@@ -37,6 +38,7 @@ export default [{
     format: 'es',
   },
   plugins: [
+    json(),
     nodeResolve({
       preferBuiltins: true,
     }),

src/__tests__/index.spec.ts

@@ -0,0 +1,119 @@
+import chalk from 'chalk'
+
+import { description, name, version } from '../../package.json'
+import { lint } from '../commands'
+import createProgram from '../index'
+
+import type { LintOptions } from '@Types/commands'
+
+jest.mock('chalk', () => ({
+  red: jest.fn(text => text),
+}))
+
+jest.mock('../commands', () => ({
+  lint: jest.fn(),
+}))
+
+describe('lint-pilot', () => {
+
+  it('displays the help text', () => {
+    const program = createProgram()
+    const helpInformation = program
+      .configureHelp({
+        helpWidth: -1,
+      })
+      .helpInformation()
+
+    expect(helpInformation).toStrictEqual(`Usage: ${name} [options] [command]
+
+${description}
+
+Options:
+  -V, --version   output the version number
+  -h, --help      display help for command
+
+Commands:
+  lint [options]  run all linters: ESLint, Stylelint, and Markdownlint (default)
+  help [command]  display help for command
+`)
+  })
+
+  it('displays the version', () => {
+    const program = createProgram()
+    program
+      .configureOutput({ writeOut: jest.fn() })
+      .exitOverride()
+
+    expect(() => {
+      program.parse(['node', './index.ts', '--version'])
+    }).toThrow(version)
+  })
+
+  it('handles unknown options', () => {
+    expect.assertions(4)
+
+    const writeErrMock = jest.fn()
+
+    const program = createProgram()
+    program
+      .configureOutput({
+        writeErr: writeErrMock,
+      })
+
+    try {
+      program.parse(['node', './index.ts', '--unknown'])
+    } catch (e: any) {
+      expect(e.message).toMatch('process.exit(1)')
+    }
+
+    expect(chalk.red).toHaveBeenCalledOnceWith(expect.stringContaining('✗ unknown option \'--unknown\''))
+    expect(writeErrMock).toHaveBeenNthCalledWith(1, expect.stringContaining('✗ unknown option \'--unknown\''))
+    expect(writeErrMock).toHaveBeenNthCalledWith(2, expect.stringContaining('💡 Run `lint-pilot --help` for more information.'))
+  })
+
+  it('calls the lint command by default', () => {
+    const program = createProgram()
+    program.parse(['node', './index.ts'])
+
+    expect(lint).toHaveBeenCalledTimes(1)
+  })
+
+  it('calls the lint command with default options', () => {
+    const program = createProgram()
+    program.parse(['node', './index.ts', 'lint'])
+
+    const expectedOptions: LintOptions = {
+      cache: false,
+      clearCache: false,
+      debug: false,
+      emoji: '✈️',
+      eslintUseLegacyConfig: false,
+      fix: false,
+      title: 'Lint Pilot',
+      watch: false,
+    }
+
+    expect(lint).toHaveBeenCalledOnceWith(expectedOptions)
+  })
+
+  it('calls the lint command with configured options', () => {
+    const program = createProgram()
+    program.parse(['node', './index.ts', 'lint', '--emoji', '🚀', '--title', 'Rocket Lint', '--fix', '--watch', '--cache', '--clearCache', '--ignore-dirs', 'node_modules', '--ignore-patterns', 'dist', '--eslint-include', '*.mdx', '--debug', '--eslint-use-legacy-config'])
+
+    const expectedOptions: LintOptions = {
+      cache: true,
+      clearCache: true,
+      debug: true,
+      emoji: '🚀',
+      eslintInclude: ['*.mdx'],
+      eslintUseLegacyConfig: true,
+      fix: true,
+      ignoreDirs: ['node_modules'],
+      ignorePatterns: ['dist'],
+      title: 'Rocket Lint',
+      watch: true,
+    }
+
+    expect(lint).toHaveBeenCalledOnceWith(expectedOptions)
+  })
+})

src/commands/index.ts

@@ -0,0 +1,5 @@
+import lint from './lint'
+
+export {
+  lint,
+}

src/__tests__/filePatterns.spec.ts → src/commands/lint/__tests__/file-patterns.spec.ts

@@ -1,14 +1,16 @@
-import colourLog from '@Utils/colourLog'
-import { Linter } from '@Types'
+import { Linter } from '@Types/lint'
+import colourLog from '@Utils/colour-log'
 
-import getFilePatterns from '../filePatterns'
+import { getFilePatterns } from '../file-patterns'
 
-describe('filePatterns', () => {
+describe('getFilePatterns', () => {
 
-  jest.spyOn(colourLog, 'config').mockImplementation(() => {})
-  jest.spyOn(console, 'log').mockImplementation(() => {})
+  beforeEach(() => {
+    jest.spyOn(colourLog, 'config').mockImplementation(() => true)
+    jest.spyOn(console, 'log').mockImplementation(() => true)
+  })
 
-  it('returns the correct file patterns for eslint', () => {
+  it('returns the default file patterns for ESLint', () => {
     const filePatterns = getFilePatterns({})
 
     const expectedPatterns = [
@@ -19,7 +21,7 @@ describe('filePatterns', () => {
     expect(colourLog.config).toHaveBeenCalledWith('ESLint Patterns', expectedPatterns)
   })
 
-  it('returns the correct file patterns for eslint with an additional include pattern', () => {
+  it('returns the file patterns for ESLint with an additional include pattern', () => {
     const filePatterns = getFilePatterns({
       eslintInclude: 'foo'
     })
@@ -33,7 +35,7 @@ describe('filePatterns', () => {
     expect(colourLog.config).toHaveBeenCalledWith('ESLint Patterns', expectedPatterns)
   })
 
-  it('returns the correct file patterns for eslint with several additional include patterns', () => {
+  it('returns the file patterns for ESLint with several additional include patterns', () => {
     const filePatterns = getFilePatterns({
       eslintInclude: ['foo', 'bar'],
     })
@@ -48,7 +50,7 @@ describe('filePatterns', () => {
     expect(colourLog.config).toHaveBeenCalledWith('ESLint Patterns', expectedPatterns)
   })
 
-  it('returns the correct file patterns for markdownlint', () => {
+  it('returns the default file patterns for Markdownlint', () => {
     const filePatterns = getFilePatterns({})
 
     const expectedPatterns = [
@@ -59,7 +61,7 @@ describe('filePatterns', () => {
     expect(colourLog.config).toHaveBeenCalledWith('Markdownlint Patterns', expectedPatterns)
   })
 
-  it('returns the correct file patterns for stylelint', () => {
+  it('returns the default file patterns for Stylelint', () => {
     const filePatterns = getFilePatterns({})
 
     const expectedPatterns = [
@@ -70,7 +72,7 @@ describe('filePatterns', () => {
     expect(colourLog.config).toHaveBeenCalledWith('Stylelint Patterns', expectedPatterns)
   })
 
-  it('returns the correct ignore file patterns', () => {
+  it('returns the default ignore file patterns', () => {
     const filePatterns = getFilePatterns({})
 
     const expectedPatterns = [
@@ -82,7 +84,7 @@ describe('filePatterns', () => {
     expect(colourLog.config).toHaveBeenCalledWith('Ignore', expectedPatterns)
   })
 
-  it('returns the correct ignore file patterns with an additional directory ignored', () => {
+  it('returns the ignore file patterns with an additional directory ignored', () => {
     const filePatterns = getFilePatterns({
       ignoreDirs: 'foo'
     })
@@ -96,7 +98,7 @@ describe('filePatterns', () => {
     expect(colourLog.config).toHaveBeenCalledWith('Ignore', expectedPatterns)
   })
 
-  it('returns the correct ignore file patterns with several additional directories ignored', () => {
+  it('returns the ignore file patterns with several additional directories ignored', () => {
     const filePatterns = getFilePatterns({
       ignoreDirs: ['foo', 'bar'],
     })
@@ -110,7 +112,7 @@ describe('filePatterns', () => {
     expect(colourLog.config).toHaveBeenCalledWith('Ignore', expectedPatterns)
   })
 
-  it('returns the correct ignore file patterns with an additional pattern ignored', () => {
+  it('returns the ignore file patterns with an additional pattern ignored', () => {
     const filePatterns = getFilePatterns({
       ignorePatterns: 'foo'
     })
@@ -125,7 +127,7 @@ describe('filePatterns', () => {
     expect(colourLog.config).toHaveBeenCalledWith('Ignore', expectedPatterns)
   })
 
-  it('returns the correct ignore file patterns with several additional patterns ignored', () => {
+  it('returns the ignore file patterns with several additional patterns ignored', () => {
     const filePatterns = getFilePatterns({
       ignorePatterns: ['foo', 'bar'],
     })