mirror of
https://github.com/hanzoai/lint-staged.git
synced 2026-10-30 19:37:36 +00:00
131 lines
3.4 KiB
TypeScript
131 lines
3.4 KiB
TypeScript
type SyncGenerateTask = (stagedFileNames: readonly string[]) => string | string[]
|
||
|
||
type AsyncGenerateTask = (stagedFileNames: readonly string[]) => Promise<string | string[]>
|
||
|
||
type GenerateTask = SyncGenerateTask | AsyncGenerateTask
|
||
|
||
type TaskFunction = {
|
||
title: string
|
||
task: (stagedFileNames: readonly string[]) => void | Promise<void>
|
||
}
|
||
|
||
export type Configuration =
|
||
| Record<string, string | TaskFunction | GenerateTask | (string | GenerateTask)[]>
|
||
| GenerateTask
|
||
|
||
export type Options = {
|
||
/**
|
||
* Allow empty commits when tasks revert all staged changes
|
||
* @default false
|
||
*/
|
||
allowEmpty?: boolean
|
||
/**
|
||
* Enable or disable ANSI color codes in output. By default value is auto-detected
|
||
* and controlled by `FORCE_COLOR` or `NO_COLOR` env variables.
|
||
*/
|
||
color?: boolean
|
||
/**
|
||
* The number of tasks to run concurrently, or `false` to run tasks serially
|
||
* @default true
|
||
*/
|
||
concurrent?: boolean | number
|
||
/**
|
||
* Manual task configuration; disables automatic config file discovery when used
|
||
*/
|
||
config?: Configuration
|
||
/**
|
||
* Path to single configuration file; disables automatic config file discovery when used
|
||
*/
|
||
configPath?: string
|
||
/**
|
||
* Run all tasks to completion even if one fails
|
||
* @default false
|
||
*/
|
||
continueOnError?: boolean
|
||
/**
|
||
* Working directory to run all tasks in, defaults to current working directory
|
||
*/
|
||
cwd?: string
|
||
/**
|
||
* Whether or not to enable debug output
|
||
* @default false
|
||
*/
|
||
debug?: boolean
|
||
/**
|
||
* Override the default `--staged` flag of `git diff` to get list of files.
|
||
* @warn changing this also implies `stash: false`.
|
||
* @example HEAD...origin/main
|
||
*/
|
||
diff?: string
|
||
/**
|
||
* Override the default `--diff-filter=ACMR` flag of `git diff` to get list of files
|
||
* @default "ACMR"
|
||
*/
|
||
diffFilter?: string
|
||
/**
|
||
* Fail with exit code 1 when tasks modify tracked files
|
||
* @default false
|
||
*/
|
||
failOnChanges?: boolean
|
||
/**
|
||
* Maximum argument string length, by default automatically detected
|
||
*/
|
||
maxArgLength?: number
|
||
/**
|
||
* Whether to hide unstaged changes from partially staged files before running tasks
|
||
* @default true
|
||
*/
|
||
hidePartiallyStaged?: boolean
|
||
/**
|
||
* Whether to hide all unstaged changes before running tasks
|
||
* @default false
|
||
*/
|
||
hideUnstaged?: boolean
|
||
/**
|
||
* Whether to hide all unstaged changes and untracked files before running tasks
|
||
* @default false
|
||
*/
|
||
hideAll?: boolean
|
||
/**
|
||
* Disable lint-staged’s own console output
|
||
* @default false
|
||
*/
|
||
quiet?: boolean
|
||
/**
|
||
* Pass filepaths relative to `CWD` to tasks, instead of absolute
|
||
* @default false
|
||
*/
|
||
relative?: boolean
|
||
/**
|
||
* Revert to original state in case of errors
|
||
* @default true
|
||
*/
|
||
revert?: boolean
|
||
/**
|
||
* Enable the backup stash, and revert in case of errors.
|
||
* @warn Disabling this also implies `hidePartiallyStaged: false`.
|
||
* @default true
|
||
*/
|
||
stash?: boolean
|
||
/**
|
||
* Show task output even when tasks succeed; by default only failed output is shown
|
||
* @default false
|
||
*/
|
||
verbose?: boolean
|
||
}
|
||
|
||
type LogFunction = typeof console.log
|
||
|
||
type Logger = {
|
||
log: LogFunction
|
||
warn: LogFunction
|
||
error: LogFunction
|
||
debug: LogFunction
|
||
}
|
||
|
||
/**
|
||
* @returns {boolean} `true` when all tasks were successful, `false` when some tasks failed with errors
|
||
* @throws {Error} when failed to some other errors
|
||
*/
|
||
export default function lintStaged(options: Options, logger?: Logger): Promise<boolean>
|