@vinicunca/eslint-config 1.10.1 → 2.0.0-beta.2

package/dist/index.d.ts

@@ -0,0 +1,145 @@
+import { FlatESLintConfigItem } from 'eslint-define-config';
+
+interface OptionsConfig {
+    /**
+     * Enable TypeScript support.
+     *
+     * Passing an object to enable TypeScript Language Server support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: boolean | OptionsTypeScriptWithLanguageServer;
+    /**
+     * Enable test support.
+     *
+     * @default true
+     */
+    test?: boolean;
+    /**
+     * Enable Vue support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    vue?: boolean;
+    /**
+     * Enable JSONC support.
+     *
+     * @default true
+     */
+    jsonc?: boolean;
+    /**
+     * Enable YAML support.
+     *
+     * @default true
+     */
+    yaml?: boolean;
+    /**
+     * Enable Markdown support.
+     *
+     * @default true
+     */
+    markdown?: boolean;
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean;
+    /**
+     * Enable sonarjs rules.
+     *
+     * @default true
+     */
+    sonar?: boolean;
+    /**
+     * Enable react support.
+     * In This plugin, react is not supported as a first class citizen. 😎
+     *
+     * @default false
+     */
+    react?: boolean;
+    /**
+     * Control to disable some rules in editors.
+     * @default auto-detect based on the process.env
+     */
+    isInEditor?: boolean;
+}
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
+interface OptionsComponentExts {
+    /**
+     * Additional extensions for components.
+     *
+     * @example ['vue']
+     * @default []
+     */
+    componentExts?: string[];
+}
+interface OptionsTypeScriptWithLanguageServer {
+    tsconfigPath: string;
+    tsconfigRootDir?: string;
+}
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+
+declare function vinicuncaESLint({ options, userConfigs }: {
+    options?: OptionsConfig;
+    userConfigs: (FlatESLintConfigItem | FlatESLintConfigItem[])[];
+}): FlatESLintConfigItem[];
+
+declare const comments: FlatESLintConfigItem[];
+
+declare const ignores: FlatESLintConfigItem[];
+
+declare const imports: FlatESLintConfigItem[];
+
+declare function javascript(options?: OptionsIsInEditor): FlatESLintConfigItem[];
+
+declare const jsdoc: FlatESLintConfigItem[];
+
+declare const jsonc: FlatESLintConfigItem[];
+
+declare function markdown(options?: OptionsComponentExts): FlatESLintConfigItem[];
+
+declare const node: FlatESLintConfigItem[];
+
+declare const react: FlatESLintConfigItem[];
+
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+declare const sortPackageJson: FlatESLintConfigItem[];
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare const sortTsconfig: FlatESLintConfigItem[];
+
+declare const javascriptStylistic: FlatESLintConfigItem[];
+declare const typescriptStylistic: FlatESLintConfigItem[];
+
+declare function test(options?: OptionsIsInEditor): FlatESLintConfigItem[];
+
+declare function typescript(options?: OptionsComponentExts): FlatESLintConfigItem[];
+declare function typescriptWithLanguageServer(options: OptionsTypeScriptWithLanguageServer & OptionsComponentExts): FlatESLintConfigItem[];
+
+declare const unicorn: FlatESLintConfigItem[];
+
+declare function vue(options?: OptionsHasTypeScript): FlatESLintConfigItem[];
+
+declare const yml: FlatESLintConfigItem[];
+
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combineConfigs(...configs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
+declare function renameRules(rules: Record<string, any>, from: string, to: string): {
+    [k: string]: any;
+};
+
+export { OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIsInEditor, OptionsTypeScriptWithLanguageServer, combineConfigs, comments, vinicuncaESLint as default, ignores, imports, javascript, javascriptStylistic, jsdoc, jsonc, markdown, node, react, renameRules, sortPackageJson, sortTsconfig, test, typescript, typescriptStylistic, typescriptWithLanguageServer, unicorn, vinicuncaESLint, vue, yml };