@ntnyq/eslint-config 3.7.0 → 3.7.2

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ESLintPluginCommandOptions } from 'eslint-plugin-command/types';
+import { RecommendedOptions } from 'eslint-plugin-github-action';
+export { default as pluginGitHubAction } from 'eslint-plugin-github-action';
 import { Options } from 'eslint-processor-vue-blocks';
 export { default as processorVueBlocks } from 'eslint-processor-vue-blocks';
 import { Linter } from 'eslint';
@@ -26,7 +28,6 @@ export { default as pluginImport } from 'eslint-plugin-import-x';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginPrettier } from 'eslint-plugin-prettier';
 export { default as pluginStylistic } from '@stylistic/eslint-plugin';
-export { default as pluginGitHubAction } from 'eslint-plugin-github-action';
 export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
 export { default as pluginComments } from '@eslint-community/eslint-plugin-eslint-comments';
@@ -50,25 +51,17 @@ type Arrayable<T> = T | T[];
 /**
  * Promise or not
  */
-type Awaitable<T> = T | Promise<T>;
+type Awaitable<T> = Promise<T> | T;
 /**
  * Make types human readable
  */
+type InteropModuleDefault<T> = T extends {
+    default: infer U;
+} ? U : T;
 type Pretty<T> = {
     [P in keyof T]: T[P];
 } & {};
 type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
-type InteropModuleDefault<T> = T extends {
-    default: infer U;
-} ? U : T;
-/**
- * A literal type that supports custom further strings but preserves autocompletion in IDEs.
- *
- * @see https://github.com/microsoft/TypeScript/issues/29729#issuecomment-471566609
- */
-type LiteralUnion<Union extends Base, Base = string> = Union | (Base & {
-    zz_IGNORE_ME?: never;
-});
 
 interface RuleOptions {
     /**
@@ -1549,6 +1542,16 @@ interface RuleOptions {
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/max-jobs-per-action.html
      */
     'github-action/max-jobs-per-action'?: Linter.RuleEntry<GithubActionMaxJobsPerAction>;
+    /**
+     * disallow using external job.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-external-job.html
+     */
+    'github-action/no-external-job'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow using invalid key.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-invalid-key.html
+     */
+    'github-action/no-invalid-key'?: Linter.RuleEntry<[]>;
     /**
      * disallow using top level env.
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-top-level-env.html
@@ -1559,6 +1562,16 @@ interface RuleOptions {
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-top-level-permissions.html
      */
     'github-action/no-top-level-permissions'?: Linter.RuleEntry<[]>;
+    /**
+     * enforce action file extension.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/prefer-file-extension.html
+     */
+    'github-action/prefer-file-extension'?: Linter.RuleEntry<GithubActionPreferFileExtension>;
+    /**
+     * enforce the style of job step uses.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/prefer-step-uses-style.html
+     */
+    'github-action/prefer-step-uses-style'?: Linter.RuleEntry<GithubActionPreferStepUsesStyle>;
     /**
      * require action name to be set.
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/require-action-name.html
@@ -9425,6 +9438,22 @@ type GithubActionJobIdCasing = [] | [
     })
 ];
 type GithubActionMaxJobsPerAction = [] | [number];
+type GithubActionPreferFileExtension = [] | [
+    (("yml" | "yaml") | {
+        extension?: ("yml" | "yaml");
+        caseSensitive?: boolean;
+    })
+];
+type GithubActionPreferStepUsesStyle = [] | [
+    (("release" | "commit" | "branch") | {
+        commit?: boolean;
+        release?: boolean;
+        branch?: boolean;
+        allowRepository?: boolean;
+        allowDocker?: boolean;
+        ignores?: string[];
+    })
+];
 type GroupedAccessorPairs = [] | [("anyOrder" | "getBeforeSet" | "setBeforeGet")];
 type HandleCallbackErr = [] | [string];
 type IdBlacklist = string[];
@@ -14720,88 +14749,83 @@ type ConfigIgnoresOptions = string[];
 /**
  * Options for overrides `files`
  */
-interface OptionsFiles {
-    files?: string[];
-}
 type ConfigCommandOptions = ESLintPluginCommandOptions;
 interface ConfigYmlOptions extends OptionsOverrides {
 }
+interface OptionsFiles {
+    files?: string[];
+}
 /**
  * Options for add `extensions` support
  */
-interface OptionsExtensions {
-    extensions?: string[];
+interface ConfigAntfuOptions extends OptionsOverrides {
 }
-interface ConfigNodeOptions extends OptionsOverrides {
+interface ConfigCommentsOptions extends OptionsOverrides {
 }
-interface ConfigTomlOptions extends OptionsOverrides {
+interface ConfigGitHubActionOptions extends RecommendedOptions, OptionsOverrides {
 }
-interface ConfigAntfuOptions extends OptionsOverrides {
+interface ConfigImportsOptions extends OptionsOverrides {
 }
-interface ConfigNtnyqOptions extends OptionsOverrides {
+interface ConfigJsdocOptions extends OptionsFeatures, OptionsOverrides {
 }
 interface ConfigJsoncOptions extends OptionsOverrides {
 }
-interface ConfigUnicornOptions extends OptionsOverrides {
-}
-interface ConfigImportsOptions extends OptionsOverrides {
+interface ConfigNodeOptions extends OptionsOverrides {
 }
-interface ConfigCommentsOptions extends OptionsOverrides {
+interface ConfigNtnyqOptions extends OptionsOverrides {
 }
 interface ConfigStylisticOptions extends OptionsOverrides {
 }
-interface ConfigGitHubActionOptions extends OptionsOverrides {
+interface ConfigTomlOptions extends OptionsOverrides {
+}
+interface ConfigUnicornOptions extends OptionsOverrides {
 }
 interface ConfigUnusedImportsOptions extends OptionsOverrides {
 }
-interface ConfigJsdocOptions extends OptionsFeatures, OptionsOverrides {
+interface OptionsExtensions {
+    extensions?: string[];
 }
 /**
  * Options for add `features` support
  */
+interface ConfigMarkdownOptions extends OptionsExtensions, OptionsFiles, OptionsOverrides {
+}
 type OptionsFeatures = {
     /**
      * Enable typescript support
      */
     typescript?: boolean;
 };
-interface ConfigMarkdownOptions extends OptionsExtensions, OptionsFiles, OptionsOverrides {
-}
 /**
  * Options for overrides `rules`
  */
-interface OptionsOverrides<Rules extends TypedConfigItem['rules'] = TypedConfigItem['rules']> {
-    overrides?: Rules;
-}
-interface ConfigRegexpOptions extends OptionsOverrides {
+interface ConfigFormatOptions {
     /**
-     * Prettier level
+     * Enable formatter support for css, less, scss, sass and etc.
      *
-     * @default 'error'
+     * @default 'prettier'
      */
-    level?: 'warn' | 'error';
-}
-interface ConfigUnoCSSOptions extends OptionsOverrides {
+    css?: 'prettier' | boolean;
     /**
-     * Enable attributify sort order
+     * Enable formatter support for html
      *
-     * @default false
+     * @default 'prettier'
      */
-    attributify?: boolean;
-}
-interface ConfigTestOptions extends OptionsOverrides {
+    html?: 'prettier' | boolean;
     /**
-     * Overrides built-in vitest rules
+     * Enable formatter support for markdown
+     *
+     * @default 'prettier'
      */
-    overridesVitestRules?: TypedConfigItem['rules'];
-}
-interface ConfigJavaScriptOptions extends OptionsOverrides {
+    markdown?: 'dprint' | 'prettier' | boolean;
     /**
-     * Enable strict checking for JavaScript files
-     *
-     * @default false
+     * Options for prettier
      */
-    strict?: boolean;
+    prettierOptions?: PrettierOptions;
+    /**
+     * Options for dprint
+     */
+    dprintOptions?: boolean;
 }
 type ConfigGitIgnoreOptions = Omit<FlatGitignoreOptions, 'strict'> & {
     /**
@@ -14811,23 +14835,45 @@ type ConfigGitIgnoreOptions = Omit<FlatGitignoreOptions, 'strict'> & {
      */
     strict?: boolean;
 };
-interface ConfigSortOptions {
+interface ConfigJavaScriptOptions extends OptionsOverrides {
     /**
-     * @default true
+     * Enable strict checking for JavaScript files
+     *
+     * @default false
      */
-    tsconfig?: boolean;
+    strict?: boolean;
+}
+interface ConfigPerfectionistOptions extends OptionsOverrides {
     /**
+     * Enable sort `constants`
+     *
      * @default true
      */
-    packageJson?: boolean;
+    sortConstants?: boolean;
     /**
+     * Enable sort `enums`
+     *
      * @default true
      */
-    i18nLocale?: boolean;
+    sortEnums?: boolean;
     /**
+     * Enable sort `types`
+     *
      * @default true
      */
-    pnpmWorkspace?: boolean;
+    sortTypes?: boolean;
+    /**
+     * Overrides rules for `constants`
+     */
+    overridesConstantsRules?: TypedConfigItem['rules'];
+    /**
+     * Overrides rules for `enums`
+     */
+    overridesEnumsRules?: TypedConfigItem['rules'];
+    /**
+     * Overrides rules for `types`
+     */
+    overridesTypesRules?: TypedConfigItem['rules'];
 }
 interface ConfigPrettierOptions extends OptionsOverrides {
     /**
@@ -14835,7 +14881,7 @@ interface ConfigPrettierOptions extends OptionsOverrides {
      *
      * @default 'warn'
      */
-    level?: 'warn' | 'error';
+    level?: 'error' | 'warn';
     /**
      * Glob of built-in disabled files
      */
@@ -14846,20 +14892,31 @@ interface ConfigPrettierOptions extends OptionsOverrides {
      */
     userDisabledFiles?: string[];
 }
-interface ConfigVueOptions extends OptionsFeatures, OptionsFiles, OptionsOverrides {
+interface ConfigRegexpOptions extends OptionsOverrides {
     /**
-     * Create virtual files for Vue SFC blocks to enable linting.
+     * Prettier level
      *
-     * @see https://github.com/antfu/eslint-processor-vue-blocks
+     * @default 'error'
+     */
+    level?: 'error' | 'warn';
+}
+interface ConfigSortOptions {
+    /**
      * @default true
      */
-    sfcBlocks?: boolean | Options;
+    tsconfig?: boolean;
     /**
-     * Vue version
-     *
-     * @default 3
+     * @default true
      */
-    vueVersion?: 2 | 3;
+    packageJson?: boolean;
+    /**
+     * @default true
+     */
+    i18nLocale?: boolean;
+    /**
+     * @default true
+     */
+    pnpmWorkspace?: boolean;
 }
 interface ConfigSpecialsOptions {
     /**
@@ -14883,65 +14940,11 @@ interface ConfigSpecialsOptions {
      */
     specialCaseConfigs?: TypedConfigItem[];
 }
-interface ConfigFormatOptions {
-    /**
-     * Enable formatter support for css, less, scss, sass and etc.
-     *
-     * @default 'prettier'
-     */
-    css?: boolean | 'prettier';
-    /**
-     * Enable formatter support for html
-     *
-     * @default 'prettier'
-     */
-    html?: boolean | 'prettier';
-    /**
-     * Enable formatter support for markdown
-     *
-     * @default 'prettier'
-     */
-    markdown?: boolean | 'dprint' | 'prettier';
-    /**
-     * Options for prettier
-     */
-    prettierOptions?: PrettierOptions;
-    /**
-     * Options for dprint
-     */
-    dprintOptions?: boolean;
-}
-interface ConfigPerfectionistOptions extends OptionsOverrides {
-    /**
-     * Enable sort `constants`
-     *
-     * @default true
-     */
-    sortConstants?: boolean;
-    /**
-     * Enable sort `enums`
-     *
-     * @default true
-     */
-    sortEnums?: boolean;
-    /**
-     * Enable sort `types`
-     *
-     * @default true
-     */
-    sortTypes?: boolean;
-    /**
-     * Overrides rules for `constants`
-     */
-    overridesConstantsRules?: TypedConfigItem['rules'];
-    /**
-     * Overrides rules for `enums`
-     */
-    overridesEnumsRules?: TypedConfigItem['rules'];
+interface ConfigTestOptions extends OptionsOverrides {
     /**
-     * Overrides rules for `types`
+     * Overrides built-in vitest rules
      */
-    overridesTypesRules?: TypedConfigItem['rules'];
+    overridesVitestRules?: TypedConfigItem['rules'];
 }
 interface ConfigTypeScriptOptions extends OptionsExtensions, OptionsFiles, OptionsOverrides {
     /**
@@ -14967,6 +14970,32 @@ interface ConfigTypeScriptOptions extends OptionsExtensions, OptionsFiles, Optio
      */
     overridesTypeAwareRules?: TypedConfigItem['rules'];
 }
+interface ConfigUnoCSSOptions extends OptionsOverrides {
+    /**
+     * Enable attributify sort order
+     *
+     * @default false
+     */
+    attributify?: boolean;
+}
+interface ConfigVueOptions extends OptionsFeatures, OptionsFiles, 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
+     *
+     * @default 3
+     */
+    vueVersion?: 2 | 3;
+}
+interface OptionsOverrides<Rules extends TypedConfigItem['rules'] = TypedConfigItem['rules']> {
+    overrides?: Rules;
+}
 /**
  * Config factory options
  */
@@ -15015,7 +15044,7 @@ interface ConfigOptionsInternal {
 /**
  * Prettier options
  */
-type PrettierOptions = Partial<Pick<RequiredOptions, 'semi' | 'useTabs' | 'plugins' | 'tabWidth' | 'rangeEnd' | 'proseWrap' | 'endOfLine' | 'rangeStart' | 'quoteProps' | 'printWidth' | 'arrowParens' | 'singleQuote' | 'insertPragma' | 'trailingComma' | 'requirePragma' | 'bracketSpacing' | 'jsxSingleQuote' | 'bracketSameLine' | 'experimentalTernaries' | 'singleAttributePerLine' | 'vueIndentScriptAndStyle' | 'htmlWhitespaceSensitivity' | 'embeddedLanguageFormatting'>> & {
+type PrettierOptions = Partial<Pick<RequiredOptions, 'arrowParens' | 'bracketSameLine' | 'bracketSpacing' | 'embeddedLanguageFormatting' | 'endOfLine' | 'experimentalTernaries' | 'htmlWhitespaceSensitivity' | 'insertPragma' | 'jsxSingleQuote' | 'plugins' | 'printWidth' | 'proseWrap' | 'quoteProps' | 'rangeEnd' | 'rangeStart' | 'requirePragma' | 'semi' | 'singleAttributePerLine' | 'singleQuote' | 'tabWidth' | 'trailingComma' | 'useTabs' | 'vueIndentScriptAndStyle'>> & {
     parser?: BuiltInParserName;
 };
 
@@ -15171,6 +15200,9 @@ declare const typescript: (options?: ConfigTypeScriptOptions) => TypedConfigItem
 
 declare const githubAction: (options?: ConfigGitHubActionOptions) => TypedConfigItem[];
 
+/**
+ * Prefer `alphabetical` sort type
+ */
 declare const perfectionist: (options?: ConfigPerfectionistOptions) => TypedConfigItem[];
 
 declare const unusedImports: (options?: ConfigUnusedImportsOptions) => TypedConfigItem[];
@@ -15180,4 +15212,4 @@ declare const unusedImports: (options?: ConfigUnusedImportsOptions) => TypedConf
  */
 declare const DEFAULT_PRETTIER_OPTIONS: PrettierOptions;
 
-export { type Arrayable, type Awaitable, type ConfigAntfuOptions, type ConfigCommandOptions, type ConfigCommentsOptions, type ConfigFormatOptions, type ConfigGitHubActionOptions, type ConfigGitIgnoreOptions, type ConfigIgnoresOptions, type ConfigImportsOptions, type ConfigJavaScriptOptions, type ConfigJsdocOptions, type ConfigJsoncOptions, type ConfigMarkdownOptions, type ConfigNames, type ConfigNodeOptions, type ConfigNtnyqOptions, type ConfigOptions, type ConfigPerfectionistOptions, type ConfigPrettierOptions, type ConfigRegexpOptions, type ConfigSortOptions, type ConfigSpecialsOptions, type ConfigStylisticOptions, type ConfigTestOptions, type ConfigTomlOptions, type ConfigTypeScriptOptions, type ConfigUnicornOptions, type ConfigUnoCSSOptions, type ConfigUnusedImportsOptions, type ConfigVueOptions, type ConfigYmlOptions, DEFAULT_PRETTIER_OPTIONS, type ESLintConfig, type ESLintParser, type ESLintParserOptions, type ESLintProcessor, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_DIST, GLOB_DTS, GLOB_EXCLUDE, GLOB_GITHUB_ACTION, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LOCKFILE, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_NESTED, GLOB_NODE_MODULES, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TEST, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_TYPES, GLOB_VUE, GLOB_YAML, type InteropModuleDefault, type LiteralUnion, type OptionsExtensions, type OptionsFeatures, type OptionsFiles, type OptionsOverrides, type PrettierOptions, type Pretty, type ResolvedOptions, type RuleOptions, type TSESLintParserOptions, type TypedConfigItem, antfu, command, comments, defineESLintConfig, format, getOverrides, githubAction, gitignore, hasTypeScript, hasUnoCSS, hasVitest, hasVue, ignores, imports, interopDefault, javascript, jsdoc, jsonc, jsx, loadPlugin, markdown, mergePrettierOptions, node, ntnyq, parserPlain, parserTypeScript, perfectionist, prettier, regexp, resolveSubOptions, sort, specials, stylistic, test, toArray, toml, typescript, unicorn, unocss, unusedImports, vitest, vue, yml };
+export { type Arrayable, type Awaitable, type ConfigAntfuOptions, type ConfigCommandOptions, type ConfigCommentsOptions, type ConfigFormatOptions, type ConfigGitHubActionOptions, type ConfigGitIgnoreOptions, type ConfigIgnoresOptions, type ConfigImportsOptions, type ConfigJavaScriptOptions, type ConfigJsdocOptions, type ConfigJsoncOptions, type ConfigMarkdownOptions, type ConfigNames, type ConfigNodeOptions, type ConfigNtnyqOptions, type ConfigOptions, type ConfigPerfectionistOptions, type ConfigPrettierOptions, type ConfigRegexpOptions, type ConfigSortOptions, type ConfigSpecialsOptions, type ConfigStylisticOptions, type ConfigTestOptions, type ConfigTomlOptions, type ConfigTypeScriptOptions, type ConfigUnicornOptions, type ConfigUnoCSSOptions, type ConfigUnusedImportsOptions, type ConfigVueOptions, type ConfigYmlOptions, DEFAULT_PRETTIER_OPTIONS, type ESLintConfig, type ESLintParser, type ESLintParserOptions, type ESLintProcessor, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_DIST, GLOB_DTS, GLOB_EXCLUDE, GLOB_GITHUB_ACTION, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LOCKFILE, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_NESTED, GLOB_NODE_MODULES, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TEST, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_TYPES, GLOB_VUE, GLOB_YAML, type InteropModuleDefault, type OptionsExtensions, type OptionsFeatures, type OptionsFiles, type OptionsOverrides, type PrettierOptions, type Pretty, type ResolvedOptions, type RuleOptions, type TSESLintParserOptions, type TypedConfigItem, antfu, command, comments, defineESLintConfig, format, getOverrides, githubAction, gitignore, hasTypeScript, hasUnoCSS, hasVitest, hasVue, ignores, imports, interopDefault, javascript, jsdoc, jsonc, jsx, loadPlugin, markdown, mergePrettierOptions, node, ntnyq, parserPlain, parserTypeScript, perfectionist, prettier, regexp, resolveSubOptions, sort, specials, stylistic, test, toArray, toml, typescript, unicorn, unocss, unusedImports, vitest, vue, yml };