@rotki/eslint-config 1.1.2 → 2.0.0

package/dist/index.d.cts

@@ -0,0 +1,523 @@
+import { RuleConfig, FlatESLintConfigItem, MergeIntersection, Prefix, RenamePrefix, VitestRules, YmlRules, NRules, ImportRules, EslintRules, JsoncRules, VueRules, EslintCommentsRules } from '@antfu/eslint-define-config';
+import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
+import { ParserOptions } from '@typescript-eslint/parser';
+import { Options } from 'eslint-processor-vue-blocks';
+import { Linter } from 'eslint';
+import { RuleOptions } from '@eslint-types/typescript-eslint/types';
+import { RuleOptions as RuleOptions$1 } from '@eslint-types/unicorn/types';
+import { Rules as Rules$1 } from 'eslint-plugin-antfu';
+export { default as pluginAntfu } from 'eslint-plugin-antfu';
+import { StylisticCustomizeOptions, UnprefixedRuleOptions } from '@stylistic/eslint-plugin';
+export { default as pluginComments } from 'eslint-plugin-eslint-comments';
+import * as eslintPluginI from 'eslint-plugin-i';
+export { eslintPluginI as pluginImport };
+export { default as pluginNode } from 'eslint-plugin-n';
+export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
+export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
+export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
+
+type ValidVLostConfiguration = [
+    {
+        allowModifiers?: boolean;
+    }
+];
+interface VuetifyRules {
+    'vue/valid-v-slot': RuleConfig<ValidVLostConfiguration>;
+    'vuetify/no-deprecated-classes': RuleConfig<[]>;
+    'vuetify/no-deprecated-colors': RuleConfig<[]>;
+    'vuetify/no-deprecated-components': RuleConfig<[]>;
+    'vuetify/no-deprecated-events': RuleConfig<[]>;
+    'vuetify/no-deprecated-props': RuleConfig<[]>;
+    'vuetify/no-deprecated-slots': RuleConfig<[]>;
+    'vuetify/grid-unknown-attributes': RuleConfig<[]>;
+}
+
+interface VueI18nRules {
+    'key-format-style': RuleConfig<['camelCase' | 'kebab-case' | 'snake_case', {
+        'allowArray'?: boolean;
+        'splitByDots'?: boolean;
+    }]>;
+    'no-deprecated-i18n-component': RuleConfig<[]>;
+    'no-deprecated-i18n-place-attr': RuleConfig<[]>;
+    'no-deprecated-i18n-places-prop': RuleConfig<[]>;
+    'no-duplicate-keys-in-locale': RuleConfig<[{
+        'ignoreI18nBlock'?: boolean;
+    }]>;
+    'no-dynamic-keys': RuleConfig<[]>;
+    'no-html-messages': RuleConfig<[]>;
+    'no-i18n-t-path-prop': RuleConfig<[]>;
+    'no-missing-keys': RuleConfig<[]>;
+    'no-missing-keys-in-other-locales': RuleConfig<[{
+        'ignoreLocales'?: string[];
+    }]>;
+    'no-raw-text': RuleConfig<[
+        {
+            'attributes'?: Record<string, string[]>;
+            'ignoreNodes'?: string[];
+            'ignorePattern'?: string;
+            'ignoreText'?: string[];
+        }
+    ]>;
+    'no-unknown-locale': RuleConfig<[
+        {
+            'locales'?: string[];
+            'disableRFC5646'?: boolean;
+        }
+    ]>;
+    'no-unused-keys': RuleConfig<[
+        {
+            'src'?: string;
+            'extensions'?: string[];
+            'ignores'?: string[];
+            'enableFix'?: boolean;
+        }
+    ]>;
+    'no-v-html': RuleConfig<[]>;
+    'prefer-linked-key-with-paren': RuleConfig<[]>;
+    'prefer-sfc-lang-attr': RuleConfig<[]>;
+    'sfc-locale-attr': RuleConfig<['always' | 'never']>;
+    'valid-message-syntax': RuleConfig<[]>;
+}
+
+/**
+ * Vendor types from Prettier so we don't rely on the dependency.
+ */
+type VendoredPrettierOptions = Partial<VendoredPrettierOptionsRequired>;
+interface VendoredPrettierOptionsRequired {
+    /**
+       * Specify the line length that the printer will wrap on.
+       * @default 120
+       */
+    printWidth: number;
+    /**
+       * Specify the number of spaces per indentation-level.
+       */
+    tabWidth: number;
+    /**
+       * Indent lines with tabs instead of spaces
+       */
+    useTabs?: boolean;
+    /**
+       * Print semicolons at the ends of statements.
+       */
+    semi: boolean;
+    /**
+       * Use single quotes instead of double quotes.
+       */
+    singleQuote: boolean;
+    /**
+       * Use single quotes in JSX.
+       */
+    jsxSingleQuote: boolean;
+    /**
+       * Print trailing commas wherever possible.
+       */
+    trailingComma: 'none' | 'es5' | 'all';
+    /**
+       * Print spaces between brackets in object literals.
+       */
+    bracketSpacing: boolean;
+    /**
+       * Put the `>` of a multi-line HTML (HTML, JSX, Vue, Angular) element at the end of the last line instead of being
+       * alone on the next line (does not apply to self closing elements).
+       */
+    bracketSameLine: boolean;
+    /**
+       * Put the `>` of a multi-line JSX element at the end of the last line instead of being alone on the next line.
+       * @deprecated use bracketSameLine instead
+       */
+    jsxBracketSameLine: boolean;
+    /**
+       * Format only a segment of a file.
+       */
+    rangeStart: number;
+    /**
+       * Format only a segment of a file.
+       * @default Number.POSITIVE_INFINITY
+       */
+    rangeEnd: number;
+    /**
+       * By default, Prettier will wrap markdown text as-is since some services use a linebreak-sensitive renderer.
+       * In some cases you may want to rely on editor/viewer soft wrapping instead, so this option allows you to opt out.
+       * @default "preserve"
+       */
+    proseWrap: 'always' | 'never' | 'preserve';
+    /**
+       * Include parentheses around a sole arrow function parameter.
+       * @default "always"
+       */
+    arrowParens: 'avoid' | 'always';
+    /**
+       * Provide ability to support new languages to prettier.
+       */
+    plugins: Array<string | any>;
+    /**
+       * How to handle whitespaces in HTML.
+       * @default "css"
+       */
+    htmlWhitespaceSensitivity: 'css' | 'strict' | 'ignore';
+    /**
+       * Which end of line characters to apply.
+       * @default "lf"
+       */
+    endOfLine: 'auto' | 'lf' | 'crlf' | 'cr';
+    /**
+       * Change when properties in objects are quoted.
+       * @default "as-needed"
+       */
+    quoteProps: 'as-needed' | 'consistent' | 'preserve';
+    /**
+       * Whether or not to indent the code inside <script> and <style> tags in Vue files.
+       * @default false
+       */
+    vueIndentScriptAndStyle: boolean;
+    /**
+       * Enforce single attribute per line in HTML, Vue and JSX.
+       * @default false
+       */
+    singleAttributePerLine: boolean;
+}
+
+type WrapRuleConfig<T extends {
+    [key: string]: any;
+}> = {
+    [K in keyof T]: T[K] extends RuleConfig ? T[K] : RuleConfig<T[K]>;
+};
+type Awaitable<T> = T | Promise<T>;
+type Rules = WrapRuleConfig<MergeIntersection<Prefix<RuleOptions, '@typescript-eslint/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<YmlRules, 'yml/', 'yaml/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<UnprefixedRuleOptions, '@stylestic'> & Prefix<Rules$1, 'antfu/'> & ImportRules & EslintRules & JsoncRules & VueRules & RuleOptions$1 & EslintCommentsRules & {
+    'test/no-only-tests': RuleConfig<[]>;
+} & {
+    'cypress/no-assigning-return-values': RuleConfig<[]>;
+    'cypress/no-unnecessary-waiting': RuleConfig<[]>;
+    'cypress/assertion-before-screenshot': RuleConfig<[]>;
+    'cypress/no-force': RuleConfig<[]>;
+    'cypress/no-async-tests': RuleConfig<[]>;
+    'cypress/no-pause': RuleConfig<[]>;
+} & {
+    '@rotki/no-deprecated-classes': RuleConfig<[]>;
+} & VuetifyRules & Prefix<VueI18nRules, '@intlify/vue-i18n/'>>>;
+type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'> & {
+    plugins?: Record<string, any>;
+};
+type UserConfigItem = FlatConfigItem | Linter.FlatConfig;
+type OptionsTypescript = (OptionsTypeScriptWithTypes & OptionsOverrides) | (OptionsTypeScriptParserOptions & OptionsOverrides);
+interface OptionsFormatters {
+    /**
+       * Enable formatting support for CSS, Less, Sass, and SCSS.
+       *
+       * Currently only support Prettier.
+       */
+    css?: 'prettier' | boolean;
+    /**
+       * Enable formatting support for HTML.
+       *
+       * Currently only support Prettier.
+       */
+    html?: 'prettier' | boolean;
+    /**
+       * Enable formatting support for Markdown.
+       *
+       * Support both Prettier and dprint.
+       *
+       * When set to `true`, it will use Prettier.
+       */
+    markdown?: 'prettier' | 'dprint' | boolean;
+    /**
+       * Custom options for Prettier.
+       *
+       * By default it's controlled by our own config.
+       */
+    prettierOptions?: VendoredPrettierOptions;
+    /**
+       * Custom options for dprint.
+       *
+       * By default it's controlled by our own config.
+       */
+    dprintOptions?: boolean;
+}
+interface OptionsFiles {
+    /**
+       * Override the `files` option to provide custom globs.
+       */
+    files?: string[];
+}
+interface OptionsVue extends OptionsOverrides {
+    /**
+       * Create virtual files for Vue SFC blocks to enable linting.
+       *
+       * @see https://github.com/antfu/eslint-processor-vue-blocks
+       * @default true
+       */
+    sfcBlocks?: boolean | Options;
+    /**
+       * Vue version. Apply different rules set from `eslint-plugin-vue`.
+       *
+       * @default 3
+       */
+    vueVersion?: 2 | 3;
+}
+interface OptionsCypress extends OptionsOverrides {
+    testDirectory?: string;
+}
+interface OptionsVueI18n extends OptionsOverrides {
+    /**
+     * The source directory where of the project where vue-i18n is setup.
+     */
+    src?: string;
+    /**
+     * The locales directory under the source directory
+     *
+     * @default locales
+     */
+    localesDirectory?: string;
+    /**
+     * Patterns that will be ignored by @intlify/vue-i18n/no-unused-keys.
+     */
+    ignores?: string[];
+}
+interface OptionsOverrides {
+    overrides?: FlatConfigItem['rules'];
+}
+interface OptionsComponentExts {
+    /**
+       * Additional extensions for components.
+       *
+       * @example ['vue']
+       * @default []
+       */
+    componentExts?: string[];
+}
+interface OptionsTypeScriptParserOptions {
+    /**
+       * Additional parser options for TypeScript.
+       */
+    parserOptions?: Partial<ParserOptions>;
+    /**
+       * Glob patterns for files that should be type aware.
+       * @default ['**\/*.{ts,tsx}']
+       */
+    filesTypeAware?: string[];
+}
+interface OptionsTypeScriptWithTypes {
+    /**
+       * When this options is provided, type aware rules will be enabled.
+       * @see https://typescript-eslint.io/linting/typed-linting/
+       */
+    tsconfigPath?: string | string[];
+}
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+interface OptionsStylistic {
+    stylistic?: boolean | StylisticConfig;
+}
+interface StylisticConfig extends Pick<StylisticCustomizeOptions, 'indent' | 'quotes' | 'jsx' | 'semi'> {
+}
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
+interface OptionsConfig extends OptionsComponentExts {
+    /**
+       * Enable gitignore support.
+       *
+       * Passing an object to configure the options.
+       *
+       * @see https://github.com/antfu/eslint-config-flat-gitignore
+       * @default true
+       */
+    gitignore?: boolean | FlatGitignoreOptions;
+    /**
+       * Core rules. Can't be disabled.
+       */
+    javascript?: OptionsOverrides;
+    /**
+       * Enable TypeScript support.
+       *
+       * Passing an object to enable TypeScript Language Server support.
+       *
+       * @default auto-detect based on the dependencies
+       */
+    typescript?: boolean | OptionsTypescript;
+    /**
+       * Enable JSX related rules.
+       *
+       * Currently only stylistic rules are included.
+       *
+       * @default true
+       */
+    jsx?: boolean;
+    /**
+       * Enable test support.
+       *
+       * @default true
+       */
+    test?: boolean | OptionsOverrides;
+    /**
+       * Enable Vue support.
+       *
+       * @default auto-detect based on the dependencies
+       */
+    vue?: boolean | OptionsVue;
+    /**
+       * Enable JSONC support.
+       *
+       * @default true
+       */
+    jsonc?: boolean | OptionsOverrides;
+    /**
+       * Enable YAML support.
+       *
+       * @default true
+       */
+    yaml?: boolean | OptionsOverrides;
+    /**
+       * Enable linting for **code snippets** in Markdown.
+       *
+       * For formatting Markdown content, enable also `formatters.markdown`.
+       *
+       * @default true
+       */
+    markdown?: boolean | OptionsOverrides;
+    /**
+       * Enable stylistic rules.
+       *
+       * @default true
+       */
+    stylistic?: boolean | StylisticConfig;
+    /**
+       * Use external formatters to format files.
+       *
+       * Requires installing:
+       * - `eslint-plugin-format`
+       *
+       * When set to `true`, it will enable all formatters.
+       *
+       * @default false
+       */
+    formatters?: boolean | OptionsFormatters;
+    /**
+     * Enable cypress test linting
+     * Requires installing:
+     * - `eslint-plugin-cypress`
+     *
+     * When set to `true` it will run on the whole project
+     *
+     * @default false
+     */
+    cypress?: boolean | OptionsCypress;
+    /**
+     * Enable rotki linting
+     * Requires installing:
+     * - `@rotki/eslint-plugin`
+     *
+     *
+     * @default false
+     */
+    rotki?: boolean;
+    /**
+     * Enable vuetify linting support.
+     * Requires installing:
+     * - `eslint-plugin-vuetify`
+     *
+     *
+     * @default false
+     */
+    vuetify?: boolean | OptionsOverrides;
+    /**
+     * Enable vue-i18n linting support.
+     * Requires installing:
+     * - `eslint-plugin-vuetify`
+     *
+     *
+     * @default false
+     */
+    vueI18n?: boolean | OptionsVueI18n;
+    /**
+       * Control to disable some rules in editors.
+       * @default auto-detect based on the process.env
+       */
+    isInEditor?: boolean;
+}
+
+/**
+ * Construct an array of ESLint flat config items.
+ */
+declare function rotki(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
+
+declare function comments(): FlatConfigItem[];
+
+declare function cypress(options?: OptionsOverrides & OptionsFiles & OptionsHasTypeScript & OptionsCypress): Promise<FlatConfigItem[]>;
+
+declare function formatters(options?: OptionsFormatters | true, stylistic?: StylisticConfig): Promise<FlatConfigItem[]>;
+
+declare function ignores(): FlatConfigItem[];
+
+declare function imports(options?: OptionsStylistic): FlatConfigItem[];
+
+declare function javascript(options?: OptionsIsInEditor & OptionsOverrides): FlatConfigItem[];
+
+declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<FlatConfigItem[]>;
+
+declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides): Promise<FlatConfigItem[]>;
+
+declare function node(): FlatConfigItem[];
+
+/**
+ * Perfectionist plugin for props and items sorting.
+ *
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
+ */
+declare function perfectionist(): FlatConfigItem[];
+
+declare function rotkiPlugin(options?: OptionsOverrides & OptionsHasTypeScript & OptionsFiles): Promise<FlatConfigItem[]>;
+
+declare function sortPackageJson(): FlatConfigItem[];
+declare function sortTsconfig(): FlatConfigItem[];
+
+declare const StylisticConfigDefaults: StylisticConfig;
+declare function stylistic(options?: StylisticConfig & OptionsOverrides): Promise<FlatConfigItem[]>;
+
+declare function test(options?: OptionsFiles & OptionsIsInEditor & OptionsOverrides): Promise<FlatConfigItem[]>;
+
+declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsIsInEditor): Promise<FlatConfigItem[]>;
+
+declare function unicorn(): FlatConfigItem[];
+
+declare function vue(options?: OptionsVue & OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
+
+declare function vueI18n(options?: OptionsHasTypeScript & OptionsIsInEditor & OptionsFiles & OptionsVueI18n): Promise<FlatConfigItem[]>;
+
+declare function vuetify(options?: OptionsOverrides & OptionsHasTypeScript & OptionsFiles): Promise<FlatConfigItem[]>;
+
+declare function yaml(options?: OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
+
+declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+declare const GLOB_JS = "**/*.?([cm])js";
+declare const GLOB_JSX = "**/*.?([cm])jsx";
+declare const GLOB_TS = "**/*.?([cm])ts";
+declare const GLOB_TSX = "**/*.?([cm])tsx";
+declare const GLOB_STYLE = "**/*.{c,le,sc}ss";
+declare const GLOB_CSS = "**/*.css";
+declare const GLOB_POSTCSS = "**/*.{p,post}css";
+declare const GLOB_LESS = "**/*.less";
+declare const GLOB_SCSS = "**/*.scss";
+declare const GLOB_JSON = "**/*.json";
+declare const GLOB_JSON5 = "**/*.json5";
+declare const GLOB_JSONC = "**/*.jsonc";
+declare const GLOB_MARKDOWN = "**/*.md";
+declare const GLOB_MARKDOWN_IN_MARKDOWN = "**/*.md/*.md";
+declare const GLOB_VUE = "**/*.vue";
+declare const GLOB_YAML = "**/*.y?(a)ml";
+declare const GLOB_HTML = "**/*.htm?(l)";
+declare const GLOB_MARKDOWN_CODE = "**/*.md/**/*.?([cm])[jt]s?(x)";
+declare const GLOB_CYPRESS = "**/*.cy.?([cm])[jt]s?(x)";
+declare const GLOB_TESTS: string[];
+declare const GLOB_ALL_SRC: string[];
+declare const GLOB_NODE_MODULES: "**/node_modules";
+declare const GLOB_DIST: "**/dist";
+declare const GLOB_LIB: "**/lib";
+declare const GLOB_LOCKFILE: string[];
+declare const GLOB_EXCLUDE: string[];
+
+export { GLOB_ALL_SRC, GLOB_CSS, GLOB_CYPRESS, GLOB_DIST, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LIB, GLOB_LOCKFILE, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_NODE_MODULES, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, StylisticConfigDefaults, comments, cypress, rotki as default, formatters, ignores, imports, javascript, jsonc, markdown, node, perfectionist, rotkiPlugin, sortPackageJson, sortTsconfig, stylistic, test, typescript, unicorn, vue, vueI18n, vuetify, yaml };