@w5s/eslint-config 2.4.4 → 3.0.0

package/src/typegen/import.d.ts

@@ -0,0 +1,501 @@
+/* eslint-disable unicorn/no-abusive-eslint-disable */
+/* eslint-disable */
+/* prettier-ignore */
+import type { Linter } from 'eslint'
+
+declare module 'eslint' {
+  namespace Linter {
+    interface RulesRecord extends RuleOptions {}
+  }
+}
+
+export interface RuleOptions {
+  /**
+   * Enforce or ban the use of inline type-only markers for named imports.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/consistent-type-specifier-style.md
+   */
+  'import/consistent-type-specifier-style'?: Linter.RuleEntry<ImportConsistentTypeSpecifierStyle>
+  /**
+   * Ensure a default export is present, given a default import.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/default.md
+   */
+  'import/default'?: Linter.RuleEntry<[]>
+  /**
+   * Enforce a leading comment with the webpackChunkName for dynamic imports.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/dynamic-import-chunkname.md
+   */
+  'import/dynamic-import-chunkname'?: Linter.RuleEntry<ImportDynamicImportChunkname>
+  /**
+   * Enforce either using, or omitting, the `node:` protocol when importing Node.js builtin modules.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/enforce-node-protocol-usage.md
+   */
+  'import/enforce-node-protocol-usage'?: Linter.RuleEntry<ImportEnforceNodeProtocolUsage>
+  /**
+   * Forbid any invalid exports, i.e. re-export of the same name.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/export.md
+   */
+  'import/export'?: Linter.RuleEntry<[]>
+  /**
+   * Ensure all exports appear after other statements.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/exports-last.md
+   */
+  'import/exports-last'?: Linter.RuleEntry<[]>
+  /**
+   * Ensure consistent use of file extension within the import path.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/extensions.md
+   */
+  'import/extensions'?: Linter.RuleEntry<ImportExtensions>
+  /**
+   * Ensure all imports appear before other statements.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/first.md
+   */
+  'import/first'?: Linter.RuleEntry<ImportFirst>
+  /**
+   * Prefer named exports to be grouped together in a single export declaration
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/group-exports.md
+   */
+  'import/group-exports'?: Linter.RuleEntry<[]>
+  /**
+   * Replaced by `import/first`.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/7b25c1cb95ee18acc1531002fd343e1e6031f9ed/docs/rules/imports-first.md
+   * @deprecated
+   */
+  'import/imports-first'?: Linter.RuleEntry<ImportImportsFirst>
+  /**
+   * Enforce the maximum number of dependencies a module can have.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/max-dependencies.md
+   */
+  'import/max-dependencies'?: Linter.RuleEntry<ImportMaxDependencies>
+  /**
+   * Ensure named imports correspond to a named export in the remote file.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/named.md
+   */
+  'import/named'?: Linter.RuleEntry<ImportNamed>
+  /**
+   * Ensure imported namespaces contain dereferenced properties as they are dereferenced.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/namespace.md
+   */
+  'import/namespace'?: Linter.RuleEntry<ImportNamespace>
+  /**
+   * Enforce a newline after import statements.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/newline-after-import.md
+   */
+  'import/newline-after-import'?: Linter.RuleEntry<ImportNewlineAfterImport>
+  /**
+   * Forbid import of modules using absolute paths.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-absolute-path.md
+   */
+  'import/no-absolute-path'?: Linter.RuleEntry<ImportNoAbsolutePath>
+  /**
+   * Forbid AMD `require` and `define` calls.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-amd.md
+   */
+  'import/no-amd'?: Linter.RuleEntry<[]>
+  /**
+   * Forbid anonymous values as default exports.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-anonymous-default-export.md
+   */
+  'import/no-anonymous-default-export'?: Linter.RuleEntry<ImportNoAnonymousDefaultExport>
+  /**
+   * Forbid CommonJS `require` calls and `module.exports` or `exports.*`.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-commonjs.md
+   */
+  'import/no-commonjs'?: Linter.RuleEntry<ImportNoCommonjs>
+  /**
+   * Forbid a module from importing a module with a dependency path back to itself.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-cycle.md
+   */
+  'import/no-cycle'?: Linter.RuleEntry<ImportNoCycle>
+  /**
+   * Forbid default exports.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-default-export.md
+   */
+  'import/no-default-export'?: Linter.RuleEntry<[]>
+  /**
+   * Forbid imported names marked with `@deprecated` documentation tag.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-deprecated.md
+   */
+  'import/no-deprecated'?: Linter.RuleEntry<[]>
+  /**
+   * Forbid repeated import of the same module in multiple places.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-duplicates.md
+   */
+  'import/no-duplicates'?: Linter.RuleEntry<ImportNoDuplicates>
+  /**
+   * Forbid `require()` calls with expressions.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-dynamic-require.md
+   */
+  'import/no-dynamic-require'?: Linter.RuleEntry<ImportNoDynamicRequire>
+  /**
+   * Forbid empty named import blocks.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-empty-named-blocks.md
+   */
+  'import/no-empty-named-blocks'?: Linter.RuleEntry<[]>
+  /**
+   * Forbid the use of extraneous packages.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-extraneous-dependencies.md
+   */
+  'import/no-extraneous-dependencies'?: Linter.RuleEntry<ImportNoExtraneousDependencies>
+  /**
+   * Forbid import statements with CommonJS module.exports.
+   */
+  'import/no-import-module-exports'?: Linter.RuleEntry<ImportNoImportModuleExports>
+  /**
+   * Forbid importing the submodules of other modules.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-internal-modules.md
+   */
+  'import/no-internal-modules'?: Linter.RuleEntry<ImportNoInternalModules>
+  /**
+   * Forbid the use of mutable exports with `var` or `let`.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-mutable-exports.md
+   */
+  'import/no-mutable-exports'?: Linter.RuleEntry<[]>
+  /**
+   * Forbid use of exported name as identifier of default export.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-named-as-default.md
+   */
+  'import/no-named-as-default'?: Linter.RuleEntry<[]>
+  /**
+   * Forbid use of exported name as property of default export.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-named-as-default-member.md
+   */
+  'import/no-named-as-default-member'?: Linter.RuleEntry<[]>
+  /**
+   * Forbid named default exports.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-named-default.md
+   */
+  'import/no-named-default'?: Linter.RuleEntry<[]>
+  /**
+   * Forbid named exports.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-named-export.md
+   */
+  'import/no-named-export'?: Linter.RuleEntry<[]>
+  /**
+   * Forbid namespace (a.k.a. "wildcard" `*`) imports.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-namespace.md
+   */
+  'import/no-namespace'?: Linter.RuleEntry<ImportNoNamespace>
+  /**
+   * Forbid Node.js builtin modules.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-nodejs-modules.md
+   */
+  'import/no-nodejs-modules'?: Linter.RuleEntry<ImportNoNodejsModules>
+  /**
+   * Forbid importing packages through relative paths.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-relative-packages.md
+   */
+  'import/no-relative-packages'?: Linter.RuleEntry<ImportNoRelativePackages>
+  /**
+   * Forbid importing modules from parent directories.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-relative-parent-imports.md
+   */
+  'import/no-relative-parent-imports'?: Linter.RuleEntry<ImportNoRelativeParentImports>
+  /**
+   * Enforce which files can be imported in a given folder.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-restricted-paths.md
+   */
+  'import/no-restricted-paths'?: Linter.RuleEntry<ImportNoRestrictedPaths>
+  /**
+   * Forbid a module from importing itself.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-self-import.md
+   */
+  'import/no-self-import'?: Linter.RuleEntry<[]>
+  /**
+   * Forbid unassigned imports
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-unassigned-import.md
+   */
+  'import/no-unassigned-import'?: Linter.RuleEntry<ImportNoUnassignedImport>
+  /**
+   * Ensure imports point to a file/module that can be resolved.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-unresolved.md
+   */
+  'import/no-unresolved'?: Linter.RuleEntry<ImportNoUnresolved>
+  /**
+   * Forbid modules without exports, or exports without matching import in another module.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-unused-modules.md
+   */
+  'import/no-unused-modules'?: Linter.RuleEntry<ImportNoUnusedModules>
+  /**
+   * Forbid unnecessary path segments in import and require statements.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-useless-path-segments.md
+   */
+  'import/no-useless-path-segments'?: Linter.RuleEntry<ImportNoUselessPathSegments>
+  /**
+   * Forbid webpack loader syntax in imports.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/no-webpack-loader-syntax.md
+   */
+  'import/no-webpack-loader-syntax'?: Linter.RuleEntry<[]>
+  /**
+   * Enforce a convention in module import order.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/order.md
+   */
+  'import/order'?: Linter.RuleEntry<ImportOrder>
+  /**
+   * Prefer a default export if module exports a single name or multiple names.
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/prefer-default-export.md
+   */
+  'import/prefer-default-export'?: Linter.RuleEntry<ImportPreferDefaultExport>
+  /**
+   * Forbid potentially ambiguous parse goal (`script` vs. `module`).
+   * @see https://github.com/import-js/eslint-plugin-import/blob/v2.32.0/docs/rules/unambiguous.md
+   */
+  'import/unambiguous'?: Linter.RuleEntry<[]>
+}
+
+/* ======= Declarations ======= */
+// ----- import/consistent-type-specifier-style -----
+type ImportConsistentTypeSpecifierStyle = []|[("prefer-inline" | "prefer-top-level")]
+// ----- import/dynamic-import-chunkname -----
+type ImportDynamicImportChunkname = []|[{
+  importFunctions?: string[]
+  allowEmpty?: boolean
+  webpackChunknameFormat?: string
+  [k: string]: unknown | undefined
+}]
+// ----- import/enforce-node-protocol-usage -----
+type ImportEnforceNodeProtocolUsage = [("always" | "never")]
+// ----- import/extensions -----
+type ImportExtensions = ([]|[("always" | "ignorePackages" | "never")] | []|[("always" | "ignorePackages" | "never")]|[("always" | "ignorePackages" | "never"), {
+  pattern?: {
+    [k: string]: ("always" | "ignorePackages" | "never")
+  }
+  checkTypeImports?: boolean
+  ignorePackages?: boolean
+  pathGroupOverrides?: {
+    pattern: string
+    patternOptions?: {
+      [k: string]: unknown | undefined
+    }
+    action: ("enforce" | "ignore")
+  }[]
+  [k: string]: unknown | undefined
+}] | []|[{
+  pattern?: {
+    [k: string]: ("always" | "ignorePackages" | "never")
+  }
+  checkTypeImports?: boolean
+  ignorePackages?: boolean
+  pathGroupOverrides?: {
+    pattern: string
+    patternOptions?: {
+      [k: string]: unknown | undefined
+    }
+    action: ("enforce" | "ignore")
+  }[]
+  [k: string]: unknown | undefined
+}] | []|[{
+  [k: string]: ("always" | "ignorePackages" | "never")
+}] | []|[("always" | "ignorePackages" | "never")]|[("always" | "ignorePackages" | "never"), {
+  [k: string]: ("always" | "ignorePackages" | "never")
+}])
+// ----- import/first -----
+type ImportFirst = []|[("absolute-first" | "disable-absolute-first")]
+// ----- import/imports-first -----
+type ImportImportsFirst = []|[("absolute-first" | "disable-absolute-first")]
+// ----- import/max-dependencies -----
+type ImportMaxDependencies = []|[{
+  max?: number
+  ignoreTypeImports?: boolean
+}]
+// ----- import/named -----
+type ImportNamed = []|[{
+  commonjs?: boolean
+}]
+// ----- import/namespace -----
+type ImportNamespace = []|[{
+  
+  allowComputed?: boolean
+}]
+// ----- import/newline-after-import -----
+type ImportNewlineAfterImport = []|[{
+  count?: number
+  exactCount?: boolean
+  considerComments?: boolean
+}]
+// ----- import/no-absolute-path -----
+type ImportNoAbsolutePath = []|[{
+  commonjs?: boolean
+  amd?: boolean
+  esmodule?: boolean
+  
+  ignore?: [string, ...(string)[]]
+}]
+// ----- import/no-anonymous-default-export -----
+type ImportNoAnonymousDefaultExport = []|[{
+  
+  allowArray?: boolean
+  
+  allowArrowFunction?: boolean
+  
+  allowCallExpression?: boolean
+  
+  allowAnonymousClass?: boolean
+  
+  allowAnonymousFunction?: boolean
+  
+  allowLiteral?: boolean
+  
+  allowObject?: boolean
+  
+  allowNew?: boolean
+}]
+// ----- import/no-commonjs -----
+type ImportNoCommonjs = ([]|["allow-primitive-modules"] | []|[{
+  allowPrimitiveModules?: boolean
+  allowRequire?: boolean
+  allowConditionalRequire?: boolean
+}])
+// ----- import/no-cycle -----
+type ImportNoCycle = []|[{
+  commonjs?: boolean
+  amd?: boolean
+  esmodule?: boolean
+  
+  ignore?: [string, ...(string)[]]
+  maxDepth?: (number | "∞")
+  
+  ignoreExternal?: boolean
+  
+  allowUnsafeDynamicCyclicDependency?: boolean
+  
+  disableScc?: boolean
+}]
+// ----- import/no-duplicates -----
+type ImportNoDuplicates = []|[{
+  considerQueryString?: boolean
+  "prefer-inline"?: boolean
+}]
+// ----- import/no-dynamic-require -----
+type ImportNoDynamicRequire = []|[{
+  esmodule?: boolean
+}]
+// ----- import/no-extraneous-dependencies -----
+type ImportNoExtraneousDependencies = []|[{
+  devDependencies?: (boolean | unknown[])
+  optionalDependencies?: (boolean | unknown[])
+  peerDependencies?: (boolean | unknown[])
+  bundledDependencies?: (boolean | unknown[])
+  packageDir?: (string | unknown[])
+  includeInternal?: boolean
+  includeTypes?: boolean
+}]
+// ----- import/no-import-module-exports -----
+type ImportNoImportModuleExports = []|[{
+  exceptions?: unknown[]
+}]
+// ----- import/no-internal-modules -----
+type ImportNoInternalModules = []|[({
+  allow?: string[]
+} | {
+  forbid?: string[]
+})]
+// ----- import/no-namespace -----
+type ImportNoNamespace = []|[{
+  ignore?: string[]
+  [k: string]: unknown | undefined
+}]
+// ----- import/no-nodejs-modules -----
+type ImportNoNodejsModules = []|[{
+  allow?: string[]
+}]
+// ----- import/no-relative-packages -----
+type ImportNoRelativePackages = []|[{
+  commonjs?: boolean
+  amd?: boolean
+  esmodule?: boolean
+  
+  ignore?: [string, ...(string)[]]
+}]
+// ----- import/no-relative-parent-imports -----
+type ImportNoRelativeParentImports = []|[{
+  commonjs?: boolean
+  amd?: boolean
+  esmodule?: boolean
+  
+  ignore?: [string, ...(string)[]]
+}]
+// ----- import/no-restricted-paths -----
+type ImportNoRestrictedPaths = []|[{
+  
+  zones?: [{
+    target?: (string | string[])
+    from?: (string | string[])
+    except?: string[]
+    message?: string
+  }, ...({
+    target?: (string | string[])
+    from?: (string | string[])
+    except?: string[]
+    message?: string
+  })[]]
+  basePath?: string
+}]
+// ----- import/no-unassigned-import -----
+type ImportNoUnassignedImport = []|[{
+  devDependencies?: (boolean | unknown[])
+  optionalDependencies?: (boolean | unknown[])
+  peerDependencies?: (boolean | unknown[])
+  allow?: string[]
+}]
+// ----- import/no-unresolved -----
+type ImportNoUnresolved = []|[{
+  commonjs?: boolean
+  amd?: boolean
+  esmodule?: boolean
+  
+  ignore?: [string, ...(string)[]]
+  caseSensitive?: boolean
+  caseSensitiveStrict?: boolean
+}]
+// ----- import/no-unused-modules -----
+type ImportNoUnusedModules = []|[({
+  unusedExports: true
+  src?: {
+    [k: string]: unknown | undefined
+  }
+  [k: string]: unknown | undefined
+} | {
+  missingExports: true
+  [k: string]: unknown | undefined
+})]
+// ----- import/no-useless-path-segments -----
+type ImportNoUselessPathSegments = []|[{
+  commonjs?: boolean
+  noUselessIndex?: boolean
+}]
+// ----- import/order -----
+type ImportOrder = []|[{
+  groups?: (("builtin" | "external" | "internal" | "unknown" | "parent" | "sibling" | "index" | "object" | "type") | ("builtin" | "external" | "internal" | "unknown" | "parent" | "sibling" | "index" | "object" | "type")[])[]
+  pathGroupsExcludedImportTypes?: unknown[]
+  distinctGroup?: boolean
+  pathGroups?: {
+    pattern: string
+    patternOptions?: {
+      [k: string]: unknown | undefined
+    }
+    group: ("builtin" | "external" | "internal" | "unknown" | "parent" | "sibling" | "index" | "object" | "type")
+    position?: ("after" | "before")
+  }[]
+  "newlines-between"?: ("ignore" | "always" | "always-and-inside-groups" | "never")
+  "newlines-between-types"?: ("ignore" | "always" | "always-and-inside-groups" | "never")
+  consolidateIslands?: ("inside-groups" | "never")
+  sortTypesGroup?: boolean
+  named?: (boolean | {
+    enabled?: boolean
+    import?: boolean
+    export?: boolean
+    require?: boolean
+    cjsExports?: boolean
+    types?: ("mixed" | "types-first" | "types-last")
+  })
+  alphabetize?: {
+    caseInsensitive?: boolean
+    order?: ("ignore" | "asc" | "desc")
+    orderImportKind?: ("ignore" | "asc" | "desc")
+  }
+  warnOnUnassignedImports?: boolean
+}]
+// ----- import/prefer-default-export -----
+type ImportPreferDefaultExport = []|[{
+  target?: ("single" | "any")
+}]