import type { BettererESLintConfig } from './types.js'; import { BettererFileTest } from '@betterer/betterer'; /** * @public Use this test to incrementally introduce new {@link https://eslint.org/ | **ESLint**} configuration to * your codebase. * * From {@link https://www.npmjs.com/package/@betterer/eslint | `@betterer/eslint@6.0.0``}, this test only works with ESLint's new flat config, so if you are * using the old configuration format, you'll need to use an older version of `@betterer/eslint`. * * @remarks {@link @betterer/eslint#eslint | `eslint`} is a {@link @betterer/betterer#BettererFileTest | `BettererFileTest`}, * so you can use {@link @betterer/betterer#BettererResolverTest.include | `include()`}, * {@link @betterer/betterer#BettererResolverTest.exclude | `exclude()`}, {@link @betterer/betterer#BettererTest.only | `only()`}, * and {@link @betterer/betterer#BettererTest.skip | `skip()`}. * * @example * ```typescript * import { eslint } from '@betterer/eslint'; * * export default { * 'new eslint rules': () => * eslint({ * rules: { * 'no-debugger': 'error', * 'no-unsafe-finally': 'error', * } * }) * .include('./src/*.ts') * }; * ``` * * @param config - Additional {@link https://eslint.org/ | **ESLint**} {@link https://eslint.org/docs/latest/use/configure/configuration-files#configuration-objects | configuration objects} * to enable. * * @throws {@link @betterer/errors#BettererError | `BettererError` } * Will throw if the user doesn't pass `config`. */ export declare function eslint(...overrideConfig: BettererESLintConfig): BettererFileTest; //# sourceMappingURL=eslint.d.ts.map