@gobstones/gobstones-scripts/dist/cjs/typings/Tasks/eslint.d.ts

Scripts to abstract away build configuration of Gobstones Project's libraries and modules.

/**
 * This type represents the options that you can pass to the eslint task.
 */
export interface TaskEslintOptions {
    /**
     * The files on which to run eslint, may be a glob pattern.
     */
    files?: string;
    /**
     * Whether to fix the issues found if possible. Defaults to false.
     */
    fix?: boolean;
    /**
     * The file extensions to consider when running eslint.
     * Defaults to js,jsx,ts,tsx
     */
    extensions?: string;
}
/**
 * Returns the string for the bash command  to run
 * eslint with the project's configuration. And optional
 * `fix` option set to true may be given to attempt
 * fixing all errors instead of just reporting them.
 *
 * @param options - The options applied when running eslint.
 *
 * @example eslint({files: './src/** /*' })
 * @example eslint({ files: './src/** /*', fix: true })
 *
 * @returns The bash command string.
 */
export declare const eslint: (options?: TaskEslintOptions) => string;
//# sourceMappingURL=eslint.d.ts.map