mirror of
https://github.com/hanzoai/lint-staged.git
synced 2026-10-30 19:37:36 +00:00
366 lines
8.6 KiB
JavaScript
366 lines
8.6 KiB
JavaScript
import fs from 'node:fs/promises'
|
|
import path from 'node:path'
|
|
import { fileURLToPath } from 'node:url'
|
|
|
|
import makeConsoleMock from 'consolemock'
|
|
import { beforeEach, describe, it } from 'vitest'
|
|
|
|
import { dynamicImport, loadConfig } from '../../lib/loadConfig.js'
|
|
import { createTempDir } from '../__utils__/createTempDir.js'
|
|
|
|
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
|
|
|
describe('loadConfig', () => {
|
|
const logger = makeConsoleMock()
|
|
|
|
beforeEach(() => {
|
|
logger.clearHistory()
|
|
})
|
|
|
|
it('should load JSON config file', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const { config } = await loadConfig(path.join(__dirname, '__mocks__', 'my-config.json'), logger)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*": "mytask",
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should load YAML config file', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const { config } = await loadConfig(path.join(__dirname, '__mocks__', 'my-config.yml'), logger)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*": "mytask",
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should not return config when YAML config file is invalid', async ({ expect }) => {
|
|
expect.assertions(2)
|
|
|
|
const { config } = await loadConfig(
|
|
path.join(__dirname, '__mocks__', 'invalid-config-file.yml'),
|
|
logger
|
|
)
|
|
|
|
expect(logger.printHistory()).toMatch('Failed to read config from file')
|
|
|
|
expect(config).toBeUndefined()
|
|
})
|
|
|
|
it('should load advanced config from absolute .js filepath', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const { config } = await loadConfig(
|
|
path.join(__dirname, '__mocks__', 'advanced-esm-config.js'),
|
|
logger
|
|
)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*.css": [Function],
|
|
"*.js": [Function],
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should load advanced config file from relative .js filepath', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const { config } = await loadConfig(
|
|
path.join('test', 'unit', '__mocks__', 'advanced-esm-config.js'),
|
|
logger
|
|
)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*.css": [Function],
|
|
"*.js": [Function],
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should load CommonJS config from absolute .cjs file', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const { config } = await loadConfig(
|
|
path.join(__dirname, '__mocks__', 'advanced-cjs-config.cjs'),
|
|
logger
|
|
)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*.css": [Function],
|
|
"*.js": [Function],
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should load CommonJS config file from relative path', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const { config } = await loadConfig(
|
|
path.join('test', 'unit', '__mocks__', 'advanced-cjs-config.cjs'),
|
|
logger
|
|
)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*.css": [Function],
|
|
"*.js": [Function],
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should load CommonJS from relative .cjs file', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const { config } = await loadConfig(
|
|
path.join('test', 'unit', '__mocks__', 'cjs', 'my-config.cjs'),
|
|
logger
|
|
)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*": "mytask",
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should load EMS config file from .mjs file', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const { config } = await loadConfig(
|
|
path.join('test', 'unit', '__mocks__', 'esm-config.mjs'),
|
|
logger
|
|
)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*": "mytask",
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should load EMS config file from .js file', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const { config } = await loadConfig(
|
|
path.join('test', 'unit', '__mocks__', 'esm-config-in-js.js'),
|
|
logger
|
|
)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*": "mytask",
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should load a CJS module when specified', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const { config } = await loadConfig(
|
|
path.join(__dirname, '__mocks__', 'my-lint-staged-config'),
|
|
logger
|
|
)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*": "mytask",
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should return empty object when config file is not found', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const result = await loadConfig({}, logger)
|
|
|
|
expect(result).toMatchInlineSnapshot(`{}`)
|
|
})
|
|
|
|
it('should return empty object when explicit config file is not found', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const result = await loadConfig('fake-config-file.yml', logger)
|
|
|
|
expect(result).toMatchInlineSnapshot(`{}`)
|
|
})
|
|
|
|
it('should return empty object ".lintstagedrc.json" file is invalid', async ({ expect }) => {
|
|
expect.assertions(1)
|
|
|
|
const result = await loadConfig(
|
|
path.join(__dirname, '__mocks__', 'invalid-json-config.json'),
|
|
logger
|
|
)
|
|
|
|
expect(result).toMatchInlineSnapshot(`{}`)
|
|
})
|
|
|
|
it('should read config from package.json', async ({ expect }) => {
|
|
const tempDir = await createTempDir()
|
|
const configPath = path.join(tempDir, 'package.json')
|
|
|
|
try {
|
|
expect.assertions(1)
|
|
|
|
await fs.writeFile(
|
|
configPath,
|
|
JSON.stringify({
|
|
'lint-staged': {
|
|
'*': 'mytask',
|
|
},
|
|
})
|
|
)
|
|
|
|
const { config } = await loadConfig(configPath, logger)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*": "mytask",
|
|
}
|
|
`)
|
|
} finally {
|
|
await fs.rm(tempDir, { recursive: true })
|
|
}
|
|
})
|
|
|
|
it('should not return config when package.json file is invalid', async ({ expect }) => {
|
|
const tempDir = await createTempDir()
|
|
const configPath = path.join(tempDir, 'package.json')
|
|
|
|
try {
|
|
expect.assertions(1)
|
|
|
|
await fs.writeFile(configPath, '{')
|
|
|
|
const { config } = await loadConfig(configPath, logger)
|
|
|
|
expect(config).toBeNull()
|
|
} finally {
|
|
await fs.rm(tempDir, { recursive: true })
|
|
}
|
|
})
|
|
|
|
it('should read "lint-staged" key from package.yaml', async ({ expect }) => {
|
|
const tempDir = await createTempDir()
|
|
const configPath = path.join(tempDir, 'package.yaml')
|
|
|
|
try {
|
|
expect.assertions(1)
|
|
|
|
await fs.writeFile(
|
|
configPath,
|
|
`lint-staged:
|
|
"*": mytask
|
|
`
|
|
)
|
|
|
|
const { config } = await loadConfig(configPath, logger)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*": "mytask",
|
|
}
|
|
`)
|
|
} finally {
|
|
await fs.rm(tempDir, { recursive: true })
|
|
}
|
|
})
|
|
|
|
it('should read "lint-staged" key from package.yml', async ({ expect }) => {
|
|
const tempDir = await createTempDir()
|
|
const configPath = path.join(tempDir, 'package.yml')
|
|
|
|
try {
|
|
expect.assertions(1)
|
|
|
|
await fs.writeFile(
|
|
configPath,
|
|
`lint-staged:
|
|
"*": mytask
|
|
`
|
|
)
|
|
|
|
const { config } = await loadConfig(configPath, logger)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*": "mytask",
|
|
}
|
|
`)
|
|
} finally {
|
|
await fs.rm(tempDir, { recursive: true })
|
|
}
|
|
})
|
|
|
|
it('should not return config when package.yaml file is invalid', async ({ expect }) => {
|
|
const tempDir = await createTempDir()
|
|
const configPath = path.join(tempDir, 'package.yaml')
|
|
|
|
try {
|
|
expect.assertions(1)
|
|
|
|
await fs.writeFile(configPath, '{')
|
|
|
|
const { config } = await loadConfig(configPath, logger)
|
|
|
|
expect(config).toBeNull()
|
|
} finally {
|
|
await fs.rm(tempDir, { recursive: true })
|
|
}
|
|
})
|
|
|
|
it('should treat config file without extension as YAML', async ({ expect }) => {
|
|
const tempDir = await createTempDir()
|
|
const configPath = path.join(tempDir, 'lint-staged-config')
|
|
|
|
try {
|
|
expect.assertions(1)
|
|
|
|
await fs.writeFile(configPath, `"*": mytask`)
|
|
|
|
const { config } = await loadConfig(configPath, logger)
|
|
|
|
expect(config).toMatchInlineSnapshot(`
|
|
{
|
|
"*": "mytask",
|
|
}
|
|
`)
|
|
} finally {
|
|
await fs.rm(tempDir, { recursive: true })
|
|
}
|
|
})
|
|
|
|
it('should not return config when invalid file without extension', async ({ expect }) => {
|
|
const tempDir = await createTempDir()
|
|
const configPath = path.join(tempDir, 'lint-staged-config')
|
|
|
|
try {
|
|
expect.assertions(1)
|
|
|
|
await fs.writeFile(configPath, `{`)
|
|
|
|
const { config } = await loadConfig(configPath, logger)
|
|
|
|
expect(config).toBeUndefined()
|
|
} finally {
|
|
await fs.rm(tempDir, { recursive: true })
|
|
}
|
|
})
|
|
})
|
|
|
|
describe('dynamicImport', () => {
|
|
it('should log errors into console', async ({ expect }) => {
|
|
await expect(() => dynamicImport('not-found.js')).rejects.toThrow(`Cannot find module`)
|
|
})
|
|
})
|