@stanfordspezi/spezi-web-configurations/dist/index.d.ts

Stanford Biodesign Digital Health Spezi Web Configurations

import { InfiniteDepthConfigWithExtends, FlatConfig } from "typescript-eslint";
type EslintConfigParams = {
    /**
     * Root of the project, where tsconfig exists.
     * Most likely it's going to be `import.meta.dirname` or `__dirname`.
     * */
    tsconfigRootDir: string;
    /**
     * List of TypeScript configuration files.
     * Required if there are multiple files with references.
     * */
    tsConfigsDirs?: string[];
    /**
     * Changes every rule to "warning" instead of "error".
     * This prevents ESLint to fail if any rule fails.
     * Useful when migrating large codebases. Use with caution.
     * */
    changeEveryRuleToWarning?: boolean;
};
/**
 * Completely ignores these directories
 * */
export const getIgnoredDirs: () => InfiniteDepthConfigWithExtends;
/**
 * Basic recommended ESLint rules with overrides
 * */
export const getEslintRules: () => InfiniteDepthConfigWithExtends[];
export const getImportRules: (tsConfigsDirs: string[]) => InfiniteDepthConfigWithExtends[];
/**
 * Injects Node globals for Node-based configuration files
 * */
export const getNodeGlobals: () => InfiniteDepthConfigWithExtends;
/**
 * Enforces arrow functions instead of named function
 * Automatically replaces every named function with an arrow function.
 * */
export const getPreferArrowFunctions: () => InfiniteDepthConfigWithExtends;
/**
 * Configures TypeScript ESLint rules.
 * This config is very strict, some repositories might need overrides.
 *
 * It relies on TSC type-checking, which might slow down linting for large codebases.
 * Read more: https://typescript-eslint.io/getting-started/typed-linting/
 * */
export const getTslint: () => InfiniteDepthConfigWithExtends;
/**
 * Configures react, react hooks plugin and customized rules
 * */
export const getReactPlugins: () => InfiniteDepthConfigWithExtends[];
/**
 * Disables default export rule for tools that need to use it.
 * */
export const getIgnoreDefaultExportRule: () => InfiniteDepthConfigWithExtends;
/**
 * Transforms ALL rules severities to 'warn'
 * */
export const getTransformAllRulesToWarn: () => InfiniteDepthConfigWithExtends;
export const getEslintReactConfig: ({ tsconfigRootDir, tsConfigsDirs, changeEveryRuleToWarning, }: EslintConfigParams) => FlatConfig.ConfigArray;
export const getEslintNodeConfig: ({ tsconfigRootDir, tsConfigsDirs, changeEveryRuleToWarning, }: EslintConfigParams) => FlatConfig.ConfigArray;
export const prettierConfig: {
    plugins: string[];
    experimentalTernaries: boolean;
};

//# sourceMappingURL=index.d.ts.map