@modyqyw/fabric
Version:
Opinionated shareable specifications for git-based JavaScript/TypeScript projects.
71 lines (68 loc) • 1.68 kB
TypeScript
type Commands = string | string[];
type ConfigFn = (filenames: string[]) => Commands | Promise<Commands>;
type Config = ConfigFn | Record<string, Commands | ConfigFn>;
interface Options {
/**
* Use Biome.
*
* Enabled by default if you have Biome installed.
*/
biome?: boolean;
/**
* Use ESLint without Biome.
*
* Enabled by default if you have ESLint installed and biome disabled.
*/
eslint?: boolean;
/**
* Lint jsonc files.
*
* @default true
*/
lintJsonc?: boolean;
/**
* Lint yml files.
*
* @default true
*/
lintYml?: boolean;
/**
* Lint toml files.
*
* @default true
*/
lintToml?: boolean;
/**
* Use oxlint without Biome.
*
* Enabled by default if you have oxlint installed and biome disabled.
*/
oxlint?: boolean;
/**
* Use markdownlint without Biome.
*
* Enabled by default if you have markdownlint-cli installed and biome
* disabled.
*/
markdownlint?: boolean;
/**
* Format changelog files.
*
* @default false
*/
formatChangelog?: boolean;
/**
* Use Prettier without Biome.
*
* Enabled by default if you have Prettier installed and biome disabled.
*/
prettier?: boolean;
/**
* Use Stylelint without Biome.
*
* Enabled by default if you have Stylelint installed and biome disabled.
*/
stylelint?: boolean;
}
declare function lintStaged(options?: Options, userConfig?: Config): Config;
export { type Commands as C, type Options as O, type ConfigFn as a, type Config as b, lintStaged as l };