@vinicunca/eslint-config 2.0.13 → 2.1.0

package/dist/index.d.ts

@@ -6,6 +6,8 @@ import { UnprefixedRuleOptions, StylisticCustomizeOptions } from '@stylistic/esl
 import { ParserOptions } from '@typescript-eslint/parser';
 import { Rules as Rules$1 } from '@vinicunca/eslint-plugin-vinicunca';
 export { default as pluginVinicunca } from '@vinicunca/eslint-plugin-vinicunca';
+import { Linter } from 'eslint';
+import { Options } from 'eslint-processor-vue-blocks';
 export { default as pluginComments } from 'eslint-plugin-eslint-comments';
 import * as eslintPluginI from 'eslint-plugin-i';
 export { eslintPluginI as pluginImport };
@@ -14,6 +16,105 @@ export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
 
+/**
+ * Vendor types from Prettier so we don't rely on the dependency.
+ */
+type VendoredPrettierOptions = Partial<VendoredPrettierOptionsRequired>;
+interface VendoredPrettierOptionsRequired {
+    /**
+     * Include parentheses around a sole arrow function parameter.
+     * @default "always"
+     */
+    arrowParens: 'always' | 'avoid';
+    /**
+     * 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;
+    /**
+     * Print spaces between brackets in object literals.
+     */
+    bracketSpacing: boolean;
+    /**
+     * Which end of line characters to apply.
+     * @default "lf"
+     */
+    endOfLine: 'auto' | 'cr' | 'crlf' | 'lf';
+    /**
+     * How to handle whitespaces in HTML.
+     * @default "css"
+     */
+    htmlWhitespaceSensitivity: 'css' | 'ignore' | 'strict';
+    /**
+     * 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;
+    /**
+     * Use single quotes in JSX.
+     */
+    jsxSingleQuote: boolean;
+    /**
+     * Provide ability to support new languages to prettier.
+     */
+    plugins: Array<any | string>;
+    /**
+     * Specify the line length that the printer will wrap on.
+     * @default 120
+     */
+    printWidth: 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';
+    /**
+     * Change when properties in objects are quoted.
+     * @default "as-needed"
+     */
+    quoteProps: 'as-needed' | 'consistent' | 'preserve';
+    /**
+     * Format only a segment of a file.
+     * @default Number.POSITIVE_INFINITY
+     */
+    rangeEnd: number;
+    /**
+     * Format only a segment of a file.
+     */
+    rangeStart: number;
+    /**
+     * Print semicolons at the ends of statements.
+     */
+    semi: boolean;
+    /**
+     * Enforce single attribute per line in HTML, Vue and JSX.
+     * @default false
+     */
+    singleAttributePerLine: boolean;
+    /**
+     * Use single quotes instead of double quotes.
+     */
+    singleQuote: boolean;
+    /**
+     * Specify the number of spaces per indentation-level.
+     */
+    tabWidth: number;
+    /**
+     * Print trailing commas wherever possible.
+     */
+    trailingComma: 'all' | 'es5' | 'none';
+    /**
+     * Indent lines with tabs instead of spaces
+     */
+    useTabs?: boolean;
+    /**
+     * Whether or not to indent the code inside <script> and <style> tags in Vue files.
+     * @default false
+     */
+    vueIndentScriptAndStyle: boolean;
+}
+
 type WrapRuleConfig<T extends {
     [key: string]: any;
 }> = {
@@ -25,7 +126,7 @@ type Rules = WrapRuleConfig<MergeIntersection<RenamePrefix<RuleOptions, '@typesc
 }>>;
 type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'> & {
     /**
-     * The name of the configuration object.
+     * Custom name of each config item
      */
     name?: string;
     /**
@@ -35,12 +136,67 @@ type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'> & {
      */
     plugins?: Record<string, any>;
 };
+type UserConfigItem = FlatConfigItem | Linter.FlatConfig;
 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?: Options | boolean;
+    /**
+     * Vue version. Apply different rules set from `eslint-plugin-vue`.
+     *
+     * @default 3
+     */
+    vueVersion?: 2 | 3;
+}
+type OptionsTypescript = (OptionsTypeScriptParserOptions & OptionsOverrides) | (OptionsTypeScriptWithTypes & OptionsOverrides);
+interface OptionsFormatters {
+    /**
+     * Enable formatting support for CSS, Less, Sass, and SCSS.
+     *
+     * Currently only support Prettier.
+     */
+    css?: 'prettier' | boolean;
+    /**
+     * Custom options for dprint.
+     *
+     * By default it's controlled by our own config.
+     */
+    dprintOptions?: boolean;
+    /**
+     * Enable formatting support for GraphQL.
+     */
+    graphql?: '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?: 'dprint' | 'prettier' | boolean;
+    /**
+     * Custom options for Prettier.
+     *
+     * By default it's controlled by our own config.
+     */
+    prettierOptions?: VendoredPrettierOptions;
+}
 interface OptionsComponentExts {
     /**
      * Additional extensions for components.
@@ -51,20 +207,25 @@ interface OptionsComponentExts {
     componentExts?: string[];
 }
 interface OptionsTypeScriptParserOptions {
+    /**
+     * Glob patterns for files that should be type aware.
+     * @default ['**\/*.{ts,tsx}']
+     */
+    filesTypeAware?: string[];
     /**
      * Additional parser options for TypeScript.
      */
     parserOptions?: Partial<ParserOptions>;
 }
-interface OptionsHasTypeScript {
-    typescript?: OptionsConfig['typescript'];
-}
 interface OptionsTypeScriptWithTypes {
     /**
      * When this options is provided, type aware rules will be enabled.
      * @see https://typescript-eslint.io/linting/typed-linting/
      */
-    tsconfigPath?: string[];
+    tsconfigPath?: string | string[];
+}
+interface OptionsHasTypeScript {
+    typescript?: boolean;
 }
 interface OptionsStylistic {
     stylistic?: StylisticConfig | boolean;
@@ -77,7 +238,7 @@ interface OptionsOverrides {
 interface OptionsIsInEditor {
     isInEditor?: boolean;
 }
-interface OptionsUnoCSS {
+interface OptionsUnoCSS extends OptionsOverrides {
     /**
      * Enable attributify support.
      * @default true
@@ -95,6 +256,17 @@ interface OptionsIgnores {
     replace?: boolean;
 }
 interface OptionsConfig extends OptionsComponentExts {
+    /**
+     * Use external formatters to format files.
+     *
+     * Requires installing:
+     * - `eslint-plugin-format`
+     *
+     * When set to `true`, it will enable all formatters.
+     *
+     * @default false
+     */
+    formatters?: OptionsFormatters | boolean;
     /**
      * Additional options for the ignore rules.
      */
@@ -104,12 +276,16 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default auto-detect based on the process.env
      */
     isInEditor?: boolean;
+    /**
+     * Core rules. Can't be disabled.
+     */
+    javascript?: OptionsOverrides;
     /**
      * Enable JSONC support.
      *
      * @default true
      */
-    jsonc?: boolean;
+    jsonc?: OptionsOverrides | boolean;
     /**
      * Enable JSX related rules.
      *
@@ -119,31 +295,20 @@ interface OptionsConfig extends OptionsComponentExts {
      */
     jsx?: boolean;
     /**
-     * Enable Markdown support.
+     * Enable linting for **code snippets** in Markdown.
+     *
+     * For formatting Markdown content, enable also `formatters.markdown`.
      *
      * @default true
      */
-    markdown?: boolean;
-    /**
-     * Provide overrides for rules for each integration.
-     */
-    overrides?: {
-        javascript?: FlatConfigItem['rules'];
-        jsonc?: FlatConfigItem['rules'];
-        markdown?: FlatConfigItem['rules'];
-        react?: FlatConfigItem['rules'];
-        test?: FlatConfigItem['rules'];
-        typescript?: FlatConfigItem['rules'];
-        vue?: FlatConfigItem['rules'];
-        yaml?: FlatConfigItem['rules'];
-    };
+    markdown?: OptionsOverrides | boolean;
     /**
      * Enable react support.
      * In This plugin, react is not supported as a first class citizen. 😎
      *
      * @default false
      */
-    react?: boolean;
+    react?: OptionsOverrides | boolean;
     /**
      * Enable stylistic rules.
      *
@@ -155,7 +320,7 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default true
      */
-    test?: boolean;
+    test?: OptionsOverrides | boolean;
     /**
      * Enable TypeScript support.
      *
@@ -163,9 +328,7 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default auto-detect based on the dependencies
      */
-    typescript?: OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & {
-        enabled?: boolean;
-    };
+    typescript?: OptionsTypescript | boolean;
     /**
      * Enable unocss rules.
      *
@@ -180,19 +343,16 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default auto-detect based on the dependencies
      */
-    vue?: boolean;
+    vue?: OptionsVue | boolean;
     /**
      * Enable YAML support.
      *
      * @default true
      */
-    yaml?: boolean;
+    yaml?: OptionsOverrides | boolean;
 }
 
-declare function vinicuncaESLint({ options, userConfigs }?: {
-    options?: OptionsConfig & FlatConfigItem;
-    userConfigs?: Awaitable<FlatConfigItem | FlatConfigItem[]>[];
-}): Promise<FlatConfigItem[]>;
+declare function vinicuncaESLint(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
 
 declare function comments(): Promise<FlatConfigItem[]>;
 
@@ -202,7 +362,7 @@ declare function imports(): Promise<FlatConfigItem[]>;
 
 declare function javascript(options?: OptionsIsInEditor & OptionsOverrides): Promise<FlatConfigItem[]>;
 
-declare function jsdoc(): Promise<FlatConfigItem[]>;
+declare function jsdoc(options?: OptionsStylistic): Promise<FlatConfigItem[]>;
 
 declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<FlatConfigItem[]>;
 
@@ -225,46 +385,80 @@ declare function sortPackageJson(): Promise<FlatConfigItem[]>;
  */
 declare function sortTsconfig(): FlatConfigItem[];
 
-declare function stylistic(options?: StylisticConfig): Promise<FlatConfigItem[]>;
+declare const STYLISTIC_CONFIG_DEFAULTS: 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): Promise<FlatConfigItem[]>;
 
-declare function unicorn(options?: OptionsOverrides): Promise<FlatConfigItem[]>;
+declare function unicorn(): Promise<FlatConfigItem[]>;
 
 declare function unocss(options?: OptionsUnoCSS): Promise<FlatConfigItem[]>;
 
-declare function vue(options?: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
+declare function vue(options?: OptionsVue & OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
 
 declare function yaml(options?: OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
 
 /**
  * Combine array and non-array configs into a single array.
  */
-declare function combineConfigs(...configs: Awaitable<FlatConfigItem | FlatConfigItem[]>[]): Promise<FlatConfigItem[]>;
+declare function combineConfigs(...configs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
 declare function renameRules(rules: Record<string, any>, from: string, to: string): {
     [k: string]: any;
 };
 declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
     default: infer U;
 } ? U : T>;
+declare const parserPlain: {
+    meta: {
+        name: string;
+    };
+    parseForESLint: (code: string) => {
+        ast: {
+            body: never[];
+            comments: never[];
+            loc: {
+                end: number;
+                start: number;
+            };
+            range: number[];
+            tokens: never[];
+            type: string;
+        };
+        scopeManager: null;
+        services: {
+            isPlain: boolean;
+        };
+        visitorKeys: {
+            Program: never[];
+        };
+    };
+};
+declare function toArray<T>(value: T | T[]): T[];
 
+declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+declare const GLOB_SRC_EXT = "?([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_EXCLUDE: string[];
-declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
-declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
-declare const GLOB_TESTS: string[];
-declare const GLOB_VUE = "**/*.vue";
+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_YAML = "**/*.y?(a)ml";
 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_TESTS: string[];
+declare const GLOB_ALL_SRC: string[];
+declare const GLOB_EXCLUDE: string[];
 
-export { type Awaitable, type FlatConfigItem, GLOB_EXCLUDE, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_SRC, GLOB_SRC_EXT, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIgnores, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsUnoCSS, type Rules, type StylisticConfig, type WrapRuleConfig, combineConfigs, comments, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, typescript, unicorn, unocss, vinicuncaESLint, vue, yaml };
+export { type Awaitable, type FlatConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsHasTypeScript, type OptionsIgnores, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript, type OptionsUnoCSS, type OptionsVue, type Rules, STYLISTIC_CONFIG_DEFAULTS, type StylisticConfig, type UserConfigItem, type WrapRuleConfig, combineConfigs, comments, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, parserPlain, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, vinicuncaESLint, vue, yaml };