perf: replace cosmiconfig with lilconfig (#981)

Replace 'cosmiconfig' with 'lilconfig' due to the smaller size and
dependency tree of the latter package. This also installs 'js-yaml',
since 'lilconfig' doesn't provide YAML parsing.

Author: kytta

README.md

@@ -105,7 +105,7 @@ Starting with v3.1 you can now use different ways of configuring lint-staged:
 - `lint-staged.config.js`, `.lintstagedrc.js`, or `.lintstagedrc.cjs` file in JS format
 - Pass a configuration file using the `--config` or `-c` flag
 
-See [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) for more details on what formats are supported.
+See [lilconfig](https://github.com/antonk52/lilconfig) for more details on what formats are supported.
 
 Configuration should be an object where each value is a command to run and its key is a glob pattern to use for this command. This package uses [micromatch](https://github.com/micromatch/micromatch) for glob patterns.
 

lib/index.js

@@ -1,6 +1,7 @@
 'use strict'
 
-const { cosmiconfig } = require('cosmiconfig')
+const { lilconfig } = require('lilconfig')
+const { yaml } = require('js-yaml')
 const debugLog = require('debug')('lint-staged')
 const stringifyObject = require('stringify-object')
 
@@ -24,8 +25,10 @@ const resolveConfig = (configPath) => {
   }
 }
 
+const jsYamlLoad = (filepath, content) => yaml.load(content)
+
 const loadConfig = (configPath) => {
-  const explorer = cosmiconfig('lint-staged', {
+  const explorer = lilconfig('lint-staged', {
     searchPlaces: [
       'package.json',
       '.lintstagedrc',
@@ -37,6 +40,11 @@ const loadConfig = (configPath) => {
       'lint-staged.config.js',
       'lint-staged.config.cjs',
     ],
+    loaders: {
+      '.yml': jsYamlLoad,
+      '.yaml': jsYamlLoad,
+      noExt: jsYamlLoad,
+    },
   })
 
   return configPath ? explorer.load(resolveConfig(configPath)) : explorer.search()
@@ -84,7 +92,7 @@ const lintStaged = async (
 ) => {
   await validateOptions({ shell }, logger)
 
-  debugLog('Loading config using `cosmiconfig`')
+  debugLog('Loading config using `lilconfig`')
 
   const resolved = configObject
     ? { config: configObject, filepath: '(input)' }

package-lock.json

@@ -30,10 +30,11 @@
     "cli-truncate": "2.1.0",
     "colorette": "^1.4.0",
     "commander": "^8.2.0",
-    "cosmiconfig": "^7.0.1",
     "debug": "^4.3.2",
     "enquirer": "^2.3.6",
     "execa": "^5.1.1",
+    "js-yaml": "^4.1.0",
+    "lilconfig": "^2.0.3",
     "listr2": "^3.12.2",
     "micromatch": "^4.0.4",
     "normalize-path": "^3.0.0",

package.json

@@ -0,0 +1,7 @@
+const actual = jest.requireActual('lilconfig')
+
+function lilconfig(name, options) {
+  return actual.lilconfig(name, options)
+}
+
+module.exports.lilconfig = jest.fn(lilconfig)

test/__mocks__/cosmiconfig.js

@@ -1,4 +1,4 @@
-import { cosmiconfig } from 'cosmiconfig'
+import { lilconfig } from 'lilconfig'
 import makeConsoleMock from 'consolemock'
 import path from 'path'
 
@@ -14,8 +14,8 @@ import { InvalidOptionsError } from '../lib/symbols'
 import validateOptions from '../lib/validateOptions'
 import { replaceSerializer } from './utils/replaceSerializer'
 
-const mockCosmiconfigWith = (result) => {
-  cosmiconfig.mockImplementationOnce(() => ({
+const mockLilconfigWith = (result) => {
+  lilconfig.mockImplementationOnce(() => ({
     search: () => Promise.resolve(result),
   }))
 }
@@ -33,11 +33,11 @@ describe('lintStaged', () => {
     logger.clearHistory()
   })
 
-  it('should use cosmiconfig if no params are passed', async () => {
+  it('should use lilconfig if no params are passed', async () => {
     expect.assertions(1)
 
     const config = { '*': 'mytask' }
-    mockCosmiconfigWith({ config })
+    mockLilconfigWith({ config })
 
     await lintStaged(undefined, logger)
 
@@ -60,7 +60,7 @@ describe('lintStaged', () => {
   it('should use use the console if no logger is passed', async () => {
     expect.assertions(2)
 
-    mockCosmiconfigWith({ config: {} })
+    mockLilconfigWith({ config: {} })
 
     const previousConsole = console
     const mockedConsole = makeConsoleMock()
@@ -79,7 +79,7 @@ describe('lintStaged', () => {
     expect.assertions(1)
 
     const config = { '*': 'mytask' }
-    mockCosmiconfigWith({ config })
+    mockLilconfigWith({ config })
 
     await lintStaged({ debug: true, quiet: true }, logger)
 
@@ -96,7 +96,7 @@ describe('lintStaged', () => {
     expect.assertions(1)
 
     const config = { '*': 'mytask' }
-    mockCosmiconfigWith({ config })
+    mockLilconfigWith({ config })
 
     await lintStaged({ quiet: true }, logger)
 
@@ -119,7 +119,7 @@ describe('lintStaged', () => {
 
   it('should throw when invalid config is provided', async () => {
     const config = {}
-    mockCosmiconfigWith({ config })
+    mockLilconfigWith({ config })
 
     await expect(lintStaged({ quiet: true }, logger)).rejects.toMatchInlineSnapshot(
       `[Error: Configuration should not be empty!]`
@@ -200,7 +200,7 @@ describe('lintStaged', () => {
   it('should print helpful error message when config file is not found', async () => {
     expect.assertions(2)
 
-    mockCosmiconfigWith(null)
+    mockLilconfigWith(null)
 
     await expect(lintStaged({ quiet: true }, logger)).rejects.toMatchInlineSnapshot(
       `[Error: Config could not be found]`

test/__mocks__/lilconfig.js

@@ -4,7 +4,7 @@ import ansiSerializer from 'jest-snapshot-serializer-ansi'
 import normalize from 'normalize-path'
 import path from 'path'
 
-jest.unmock('cosmiconfig')
+jest.unmock('lilconfig')
 jest.unmock('execa')
 
 import execGitBase from '../lib/execGit'