vite-plus 0.1.2 → 0.1.4

package/dist/oxlint-config.d.ts

@@ -1,498 +0,0 @@
-/**
- * Oxlint Configuration File
- *
- * This configuration is aligned with ESLint v8's configuration schema (`eslintrc.json`).
- *
- * Usage: `oxlint -c oxlintrc.json --import-plugin`
- *
- * ::: danger NOTE
- *
- * Only the `.json` format is supported. You can use comments in configuration files.
- *
- * :::
- *
- * Example
- *
- * `.oxlintrc.json`
- *
- * ```json
- * {
- * "$schema": "./node_modules/oxlint/configuration_schema.json",
- * "plugins": ["import", "typescript", "unicorn"],
- * "env": {
- * "browser": true
- * },
- * "globals": {
- * "foo": "readonly"
- * },
- * "settings": {
- * },
- * "rules": {
- * "eqeqeq": "warn",
- * "import/no-cycle": "error",
- * "react/self-closing-comp": ["error", { "html": false }]
- * },
- * "overrides": [
- * {
- * "files": ["*.test.ts", "*.spec.ts"],
- * "rules": {
- * "@typescript-eslint/no-explicit-any": "off"
- * }
- * }
- * ]
- * }
- * ```
- */
-export interface OxlintConfig {
-    /**
-     * Schema URI for editor tooling.
-     */
-    $schema?: null | string;
-    categories?: RuleCategories;
-    /**
-     * Environments enable and disable collections of global variables.
-     */
-    env?: {
-        [key: string]: boolean;
-    };
-    /**
-     * Paths of configuration files that this configuration file extends (inherits from). The
-     * files
-     * are resolved relative to the location of the configuration file that contains the
-     * `extends`
-     * property. The configuration files are merged from the first to the last, with the last
-     * file
-     * overriding the previous ones.
-     */
-    extends?: string[];
-    /**
-     * Enabled or disabled specific global variables.
-     */
-    globals?: {
-        [key: string]: GlobalValue;
-    };
-    /**
-     * Globs to ignore during linting. These are resolved from the configuration file path.
-     */
-    ignorePatterns?: string[];
-    /**
-     * JS plugins, allows usage of ESLint plugins with Oxlint.
-     *
-     * Read more about JS plugins in
-     * [the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).
-     *
-     * Note: JS plugins are experimental and not subject to semver.
-     * They are not supported in the language server (and thus editor integrations) at present.
-     */
-    jsPlugins?: Array<ExternalPluginEntryClass | string> | null;
-    /**
-     * Add, remove, or otherwise reconfigure rules for specific files or groups of files.
-     */
-    overrides?: OxlintOverride[];
-    /**
-     * Enabled built-in plugins for Oxlint.
-     * You can view the list of available plugins on
-     * [the website](https://oxc.rs/docs/guide/usage/linter/plugins.html#supported-plugins).
-     *
-     * NOTE: Setting the `plugins` field will overwrite the base set of plugins.
-     * The `plugins` array should reflect all of the plugins you want to use.
-     */
-    plugins?: LintPluginOptionsSchema[] | null;
-    /**
-     * Example
-     *
-     * `.oxlintrc.json`
-     *
-     * ```json
-     * {
-     * "$schema": "./node_modules/oxlint/configuration_schema.json",
-     * "rules": {
-     * "eqeqeq": "warn",
-     * "import/no-cycle": "error",
-     * "prefer-const": ["error", { "ignoreReadBeforeAssign": true }]
-     * }
-     * }
-     * ```
-     *
-     * See [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html) for the list of
-     * rules.
-     */
-    rules?: {
-        [key: string]: any[] | AllowWarnDenyEnum | number;
-    };
-    settings?: OxlintPluginSettings;
-}
-/**
- * Configure an entire category of rules all at once.
- *
- * Rules enabled or disabled this way will be overwritten by individual rules in the `rules`
- * field.
- *
- * Example
- * ```json
- * {
- * "$schema": "./node_modules/oxlint/configuration_schema.json",
- * "categories": {
- * "correctness": "warn"
- * },
- * "rules": {
- * "eslint/no-unused-vars": "error"
- * }
- * }
- * ```
- */
-export interface RuleCategories {
-    correctness?: AllowWarnDenyEnum | number;
-    nursery?: AllowWarnDenyEnum | number;
-    pedantic?: AllowWarnDenyEnum | number;
-    perf?: AllowWarnDenyEnum | number;
-    restriction?: AllowWarnDenyEnum | number;
-    style?: AllowWarnDenyEnum | number;
-    suspicious?: AllowWarnDenyEnum | number;
-}
-/**
- * Oxlint rule.
- * - "allow" or "off": Turn off the rule.
- * - "warn": Turn the rule on as a warning (doesn't affect exit code).
- * - "error" or "deny": Turn the rule on as an error (will exit with a failure code).
- */
-export type AllowWarnDenyEnum = 'allow' | 'off' | 'warn' | 'error' | 'deny';
-export type GlobalValue = 'readonly' | 'writable' | 'off';
-/**
- * Plugin with custom name/alias
- */
-export interface ExternalPluginEntryClass {
-    /**
-     * Custom name/alias for the plugin.
-     *
-     * Note: The following plugin names are reserved because they are implemented natively in
-     * Rust within oxlint and cannot be used for JS plugins:
-     * - react (includes react-hooks)
-     * - unicorn
-     * - typescript (includes @typescript-eslint)
-     * - oxc
-     * - import (includes import-x)
-     * - jsdoc
-     * - jest
-     * - vitest
-     * - jsx-a11y
-     * - nextjs
-     * - react-perf
-     * - promise
-     * - node
-     * - vue
-     * - eslint
-     *
-     * If you need to use the JavaScript version of any of these plugins, provide a custom alias
-     * to avoid conflicts.
-     */
-    name: string;
-    /**
-     * Path or package name of the plugin
-     */
-    specifier: string;
-}
-export interface OxlintOverride {
-    /**
-     * Environments enable and disable collections of global variables.
-     */
-    env?: {
-        [key: string]: boolean;
-    } | null;
-    /**
-     * A list of glob patterns to override.
-     *
-     * ## Example
-     * `[ "*.test.ts", "*.spec.ts" ]`
-     */
-    files: string[];
-    /**
-     * Enabled or disabled specific global variables.
-     */
-    globals?: {
-        [key: string]: GlobalValue;
-    } | null;
-    /**
-     * JS plugins for this override, allows usage of ESLint plugins with Oxlint.
-     *
-     * Read more about JS plugins in
-     * [the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).
-     *
-     * Note: JS plugins are experimental and not subject to semver.
-     * They are not supported in the language server (and thus editor integrations) at present.
-     */
-    jsPlugins?: Array<ExternalPluginEntryClass | string> | null;
-    /**
-     * Optionally change what plugins are enabled for this override. When
-     * omitted, the base config's plugins are used.
-     */
-    plugins?: LintPluginOptionsSchema[] | null;
-    rules?: {
-        [key: string]: any[] | AllowWarnDenyEnum | number;
-    };
-}
-export type LintPluginOptionsSchema = 'eslint' | 'react' | 'unicorn' | 'typescript' | 'oxc' | 'import' | 'jsdoc' | 'jest' | 'vitest' | 'jsx-a11y' | 'nextjs' | 'react-perf' | 'promise' | 'node' | 'vue';
-/**
- * Configure the behavior of linter plugins.
- *
- * Here's an example if you're using Next.js in a monorepo:
- *
- * ```json
- * {
- * "settings": {
- * "next": {
- * "rootDir": "apps/dashboard/"
- * },
- * "react": {
- * "linkComponents": [
- * { "name": "Link", "linkAttribute": "to" }
- * ]
- * },
- * "jsx-a11y": {
- * "components": {
- * "Link": "a",
- * "Button": "button"
- * }
- * }
- * }
- * }
- * ```
- */
-export interface OxlintPluginSettings {
-    jsdoc?: JSDocPluginSettings;
-    'jsx-a11y'?: JSXA11YPluginSettings;
-    next?: NextPluginSettings;
-    react?: ReactPluginSettings;
-    vitest?: VitestPluginSettings;
-    [property: string]: any;
-}
-export interface JSDocPluginSettings {
-    /**
-     * Only for `require-(yields|returns|description|example|param|throws)` rule
-     */
-    augmentsExtendsReplacesDocs?: boolean;
-    /**
-     * Only for `require-param-type` and `require-param-description` rule
-     */
-    exemptDestructuredRootsFromChecks?: boolean;
-    /**
-     * For all rules but NOT apply to `empty-tags` rule
-     */
-    ignoreInternal?: boolean;
-    /**
-     * For all rules but NOT apply to `check-access` and `empty-tags` rule
-     */
-    ignorePrivate?: boolean;
-    /**
-     * Only for `require-(yields|returns|description|example|param|throws)` rule
-     */
-    ignoreReplacesDocs?: boolean;
-    /**
-     * Only for `require-(yields|returns|description|example|param|throws)` rule
-     */
-    implementsReplacesDocs?: boolean;
-    /**
-     * Only for `require-(yields|returns|description|example|param|throws)` rule
-     */
-    overrideReplacesDocs?: boolean;
-    tagNamePreference?: {
-        [key: string]: boolean | TagNamePreferenceObject | string;
-    };
-    [property: string]: any;
-}
-export interface TagNamePreferenceObject {
-    message: string;
-    replacement?: string;
-    [property: string]: any;
-}
-/**
- * Configure JSX A11y plugin rules.
- *
- * See
- *
- * [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y#configurations)'s
- * configuration for a full reference.
- */
-export interface JSXA11YPluginSettings {
-    /**
-     * Map of attribute names to their DOM equivalents.
-     * This is useful for non-React frameworks that use different attribute names.
-     *
-     * Example:
-     *
-     * ```json
-     * {
-     * "settings": {
-     * "jsx-a11y": {
-     * "attributes": {
-     * "for": ["htmlFor", "for"]
-     * }
-     * }
-     * }
-     * }
-     * ```
-     */
-    attributes?: {
-        [key: string]: string[];
-    };
-    /**
-     * To have your custom components be checked as DOM elements, you can
-     * provide a mapping of your component names to the DOM element name.
-     *
-     * Example:
-     *
-     * ```json
-     * {
-     * "settings": {
-     * "jsx-a11y": {
-     * "components": {
-     * "Link": "a",
-     * "IconButton": "button"
-     * }
-     * }
-     * }
-     * }
-     * ```
-     */
-    components?: {
-        [key: string]: string;
-    };
-    /**
-     * An optional setting that define the prop your code uses to create polymorphic components.
-     * This setting will be used to determine the element type in rules that
-     * require semantic context.
-     *
-     * For example, if you set the `polymorphicPropName` to `as`, then this element:
-     *
-     * ```jsx
-     * <Box as="h3">Hello</Box>
-     * ```
-     *
-     * Will be treated as an `h3`. If not set, this component will be treated
-     * as a `Box`.
-     */
-    polymorphicPropName?: null | string;
-    [property: string]: any;
-}
-/**
- * Configure Next.js plugin rules.
- */
-export interface NextPluginSettings {
-    /**
-     * The root directory of the Next.js project.
-     *
-     * This is particularly useful when you have a monorepo and your Next.js
-     * project is in a subfolder.
-     *
-     * Example:
-     *
-     * ```json
-     * {
-     * "settings": {
-     * "next": {
-     * "rootDir": "apps/dashboard/"
-     * }
-     * }
-     * }
-     * ```
-     */
-    rootDir?: string[] | string;
-    [property: string]: any;
-}
-/**
- * Configure React plugin rules.
- *
- * Derived from
- * [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react#configuration-legacy-eslintrc-)
- */
-export interface ReactPluginSettings {
-    /**
-     * Components used as alternatives to `<form>` for forms, such as `<Formik>`.
-     *
-     * Example:
-     *
-     * ```jsonc
-     * {
-     * "settings": {
-     * "react": {
-     * "formComponents": [
-     * "CustomForm",
-     * // OtherForm is considered a form component and has an endpoint attribute
-     * { "name": "OtherForm", "formAttribute": "endpoint" },
-     * // allows specifying multiple properties if necessary
-     * { "name": "Form", "formAttribute": ["registerEndpoint", "loginEndpoint"] }
-     * ]
-     * }
-     * }
-     * }
-     * ```
-     */
-    formComponents?: Array<CustomComponentObject | string>;
-    /**
-     * Components used as alternatives to `<a>` for linking, such as `<Link>`.
-     *
-     * Example:
-     *
-     * ```jsonc
-     * {
-     * "settings": {
-     * "react": {
-     * "linkComponents": [
-     * "HyperLink",
-     * // Use `linkAttribute` for components that use a different prop name
-     * // than `href`.
-     * { "name": "MyLink", "linkAttribute": "to" },
-     * // allows specifying multiple properties if necessary
-     * { "name": "Link", "linkAttribute": ["to", "href"] }
-     * ]
-     * }
-     * }
-     * }
-     * ```
-     */
-    linkComponents?: Array<CustomComponentObject | string>;
-    /**
-     * React version to use for version-specific rules.
-     *
-     * Accepts semver versions (e.g., "18.2.0", "17.0").
-     *
-     * Example:
-     *
-     * ```jsonc
-     * {
-     * "settings": {
-     * "react": {
-     * "version": "18.2.0"
-     * }
-     * }
-     * }
-     * ```
-     */
-    version?: null | string;
-    [property: string]: any;
-}
-export interface CustomComponentObject {
-    attribute?: string;
-    name: string;
-    attributes?: string[];
-    [property: string]: any;
-}
-/**
- * Configure Vitest plugin rules.
- *
- * See [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest)'s
- * configuration for a full reference.
- */
-export interface VitestPluginSettings {
-    /**
-     * Whether to enable typecheck mode for Vitest rules.
-     * When enabled, some rules will skip certain checks for describe blocks
-     * to accommodate TypeScript type checking scenarios.
-     */
-    typecheck?: boolean;
-    [property: string]: any;
-}
-export declare class Convert {
-    static toOxlintConfig(json: string): OxlintConfig;
-    static oxlintConfigToJson(value: OxlintConfig): string;
-}