@kcws/lintstaged-config/lib/index.d.ts

kamontat's lintstaged config

/**
 * A programming config for lintstaged.
 *
 * @packageDocumentation
 */
import type { IConfigBuilder, ConfigFn } from "./models/IConfig";
/**
 * This is a function to define a configuration for lintstaged file.
 *
 * @param builder - a setting for configure lintstaged.
 * @returns a lintstaged configuration.
 *
 * @example
 *
 * Use lintstaged-config with default configuration
 * ```ts
 * const { default: defineConfig, Config } = require("@kcws/lintstaged-config");
 * module.exports = defineConfig(Config.default());
 * ```
 *
 * @example
 *
 * Use lintstaged-config with custom configuration
 * ```ts
 * const { default: defineConfig, Config } = require("@kcws/lintstaged-config");
 * module.exports = defineConfig(Config.builder().append("group_name", {}));
 * ```
 *
 * @beta
 */
declare function defineConfig(builder: IConfigBuilder): ConfigFn;
export default defineConfig;
export * from "./models/IConfig";
export * from "./actions/_base";
export * from "./actions";
export { Config } from "./models/Config";
export type { DefaultKey, CustomDefaultConfig, OnlyAppOptions, } from "./constants/default";
export type { Builder } from "./models/Config";
export type { _WalkCallback } from "./actions/rush";
//# sourceMappingURL=index.d.ts.map