@isentinel/eslint-config 4.6.1 → 4.7.1

package/README.md

@@ -297,6 +297,32 @@ export default isentinel({
 });
 ```
 
+### Named Configs
+
+Enable `namedConfigs` to require all config items to have a `name` property.
+This improves debugging and makes the
+[ESLint Config Inspector](https://github.com/eslint/config-inspector) much more
+useful by displaying meaningful names instead of anonymous configs.
+
+```ts
+// eslint.config.ts
+import isentinel from "@isentinel/eslint-config";
+
+export default isentinel(
+	{
+		name: "project/root",
+		namedConfigs: true,
+	},
+	{
+		name: "project/custom-rules",
+		files: ["**/*.ts"],
+		rules: {},
+	},
+);
+```
+
+> **Note:** This will become the default in a future major version.
+
 ### Plugins Renaming
 
 Since flat config requires us to explicitly provide the plugin names (instead of

package/dist/index.d.mts

@@ -6,6 +6,7 @@ import { ParserOptions } from "@typescript-eslint/parser";
 import { Linter } from "eslint";
 import { ESLintReactSettings } from "@eslint-react/shared";
 import { FlatGitignoreOptions } from "eslint-config-flat-gitignore";
+import { SetRequired } from "type-fest";
 
 //#region src/typegen.d.ts
 interface RuleOptions {
@@ -16866,6 +16867,22 @@ interface JsdocOptions {
    */
   full?: boolean;
 }
+/**
+ * A TypedFlatConfigItem that requires a name property. All configs should have
+ * a name for better debugging and tooling support.
+ */
+type NamedFlatConfigItem = SetRequired<TypedFlatConfigItem, "name">;
+/**
+ * Options type that requires `name` on the options config and all user configs.
+ *
+ * @remarks
+ * This will become the default in a future major version.
+ * @see {@link OptionsConfig.namedConfigs}
+ */
+type NamedOptionsConfig = OptionsConfig & TypedFlatConfigItem & {
+  name: string;
+  namedConfigs: true;
+};
 interface OptionsComponentExtensions {
   /** Additional extensions for components. */
   componentExts?: Array<string>;
@@ -16954,6 +16971,16 @@ interface OptionsConfig extends OptionsComponentExtensions, OptionsProjectType {
    * @default true
    */
   markdown?: boolean | OptionsOverrides;
+  /**
+   * Require all config items to have a `name` property for better debugging
+   * and tooling support.
+   *
+   * @remarks
+   * This will default to `true` in a future major version and this option
+   * will be removed.
+   * @default false
+   */
+  namedConfigs?: boolean;
   /** Supply custom options for eslint-plugin-perfectionist. */
   perfectionist?: PerfectionistConfig;
   /**
@@ -17422,12 +17449,19 @@ declare const defaultPluginRenaming: {
  * Generates an array of user configuration items based on the provided options
  * and user configs.
  *
+ * @template NamedConfigs - When `true`, requires all config items to have a
+ *   name.
  * @param options - The options for generating the user configuration items.
  * @param userConfigs - Additional user configuration items.
  * @returns A promise that resolves to an array of user configuration items.
  * @rejects Will throw an error if configuration generation fails.
  */
-declare function isentinel(options?: OptionsConfig & TypedFlatConfigItem, ...userConfigs: Array<Awaitable<Array<Linter.Config> | Array<TypedFlatConfigItem> | FlatConfigComposer<any, any> | TypedFlatConfigItem>>): Promise<FlatConfigComposer<TypedFlatConfigItem, ConfigNames>>;
+declare function isentinel(options: Omit<OptionsConfig, "namedConfigs"> & TypedFlatConfigItem & {
+  namedConfigs?: false;
+}, ...userConfigs: Array<Awaitable<Array<TypedFlatConfigItem> | FlatConfigComposer<any, any> | TypedFlatConfigItem>>): Promise<FlatConfigComposer<TypedFlatConfigItem, ConfigNames>>;
+declare function isentinel(options: NamedOptionsConfig, ...userConfigs: Array<Awaitable<FlatConfigComposer<any, any>>>): Promise<FlatConfigComposer<TypedFlatConfigItem, ConfigNames>>;
+declare function isentinel(options: NamedOptionsConfig, ...userConfigs: Array<Awaitable<Array<NamedFlatConfigItem>>>): Promise<FlatConfigComposer<TypedFlatConfigItem, ConfigNames>>;
+declare function isentinel(options: NamedOptionsConfig, ...userConfigs: Array<Awaitable<NamedFlatConfigItem>>): Promise<FlatConfigComposer<TypedFlatConfigItem, ConfigNames>>;
 //#endregion
 //#region src/globs.d.ts
 declare const GLOB_ROOT: string[];
@@ -17463,4 +17497,4 @@ declare const GLOB_BUILD_TOOLS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 //#endregion
-export { Awaitable, type ConfigNames, ExtractRuleOptions, type FlatConfigComposer, GLOB_ALL_JSON, GLOB_ALL_SRC, GLOB_BUILD_TOOLS, GLOB_CSS, GLOB_DTS, GLOB_EXCLUDE, GLOB_GRAPHQL, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LUA, GLOB_MARKDOWN, GLOB_MARKDOWN_BLOCKS, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_ROOT, GLOB_ROOT_SRC, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_XML, GLOB_YAML, GitignoreOptions, JsdocOptions, OptionsComponentExtensions, OptionsConfig, OptionsFiles, OptionsFormatters, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsOverridesTypeAware, OptionsPnpm, OptionsProjectType, OptionsRoblox, OptionsStylistic, OptionsTestFramework, OptionsTypeScriptErasableOnly, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypescript, OptionsVitest, PerfectionistConfig, type PrettierOptions, PrettierRuleOptions, ReactConfig, ResolvedOptions, Rules, SpellCheckConfig, StylisticConfig, StylisticConfigDefaults, TypedFlatConfigItem, combine, comments, createTsParser, isentinel as default, isentinel, defaultPluginRenaming, disables, ensurePackages, eslintPlugin, flawless, getOverrides, getTsConfig, gitignore, ignores, imports, interopDefault, isInEditorEnvironment, isInGitHooksOrLintStaged, javascript, jsdoc, jsonc, markdown, mergeGlobs, mergePrettierOptions, node, packageJson, parserPlain, perfectionist, pnpm, prettier, promise, react, renamePluginInConfigs, renameRules, require, resolvePrettierConfigOptions, resolveSubOptions, resolveWithDefaults, roblox, shopify, shouldEnableFeature, sonarjs, sortGithubAction, sortPnpmWorkspace, sortRojoProject, sortTsconfig, spelling, stylistic, test, toml, typescript, unicorn, yaml };
+export { Awaitable, type ConfigNames, ExtractRuleOptions, type FlatConfigComposer, GLOB_ALL_JSON, GLOB_ALL_SRC, GLOB_BUILD_TOOLS, GLOB_CSS, GLOB_DTS, GLOB_EXCLUDE, GLOB_GRAPHQL, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LUA, GLOB_MARKDOWN, GLOB_MARKDOWN_BLOCKS, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_ROOT, GLOB_ROOT_SRC, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_XML, GLOB_YAML, GitignoreOptions, JsdocOptions, NamedFlatConfigItem, NamedOptionsConfig, OptionsComponentExtensions, OptionsConfig, OptionsFiles, OptionsFormatters, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsOverridesTypeAware, OptionsPnpm, OptionsProjectType, OptionsRoblox, OptionsStylistic, OptionsTestFramework, OptionsTypeScriptErasableOnly, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypescript, OptionsVitest, PerfectionistConfig, type PrettierOptions, PrettierRuleOptions, ReactConfig, ResolvedOptions, Rules, SpellCheckConfig, StylisticConfig, StylisticConfigDefaults, TypedFlatConfigItem, combine, comments, createTsParser, isentinel as default, isentinel, defaultPluginRenaming, disables, ensurePackages, eslintPlugin, flawless, getOverrides, getTsConfig, gitignore, ignores, imports, interopDefault, isInEditorEnvironment, isInGitHooksOrLintStaged, javascript, jsdoc, jsonc, markdown, mergeGlobs, mergePrettierOptions, node, packageJson, parserPlain, perfectionist, pnpm, prettier, promise, react, renamePluginInConfigs, renameRules, require, resolvePrettierConfigOptions, resolveSubOptions, resolveWithDefaults, roblox, shopify, shouldEnableFeature, sonarjs, sortGithubAction, sortPnpmWorkspace, sortRojoProject, sortTsconfig, spelling, stylistic, test, toml, typescript, unicorn, yaml };

package/dist/index.mjs

@@ -141,16 +141,22 @@ const GLOB_EXCLUDE = [
 	"**/.history",
 	"**/.idea",
 	"**/.next",
+	"**/.nuxt",
 	"**/.output",
+	"**/.svelte-kit",
 	"**/.temp",
 	"**/.tmp",
 	"**/.vercel",
 	"**/.vite-inspect",
+	"**/.vitepress/cache",
+	"**/.worktree",
+	"**/.yarn",
 	"**/coverage",
 	"**/out",
 	"**/output",
 	"**/temp",
 	"**/tmp",
+	"**/vite.config.*.timestamp-*",
 	"**/*.min.*",
 	"**/CHANGELOG*.md",
 	"**/LICENSE*",
@@ -4618,17 +4624,17 @@ async function packageJson(options = {}) {
 				"package-json/require-attribution": "error",
 				"package-json/require-author": "error",
 				"package-json/require-description": "error",
-				"package-json/require-exports": "error",
+				"package-json/require-exports": ["error", { ignorePrivate: true }],
 				"package-json/require-files": ["error", { ignorePrivate: true }],
 				"package-json/require-keywords": "error",
-				"package-json/require-license": "error",
+				"package-json/require-license": ["error", { ignorePrivate: true }],
 				"package-json/require-name": "error",
-				"package-json/require-types": "error",
+				"package-json/require-types": ["error", { ignorePrivate: true }],
 				"package-json/require-version": "error"
 			} : {},
 			...type === "package" && !roblox$1 ? {
 				"package-json/require-engines": "error",
-				"package-json/require-sideEffects": "error"
+				"package-json/require-sideEffects": ["error", { ignorePrivate: true }]
 			} : {}
 		}
 	}];
@@ -4930,16 +4936,7 @@ const defaultPluginRenaming = {
 	"n": "node",
 	"yml": "yaml"
 };
-/**
-* Generates an array of user configuration items based on the provided options
-* and user configs.
-*
-* @param options - The options for generating the user configuration items.
-* @param userConfigs - Additional user configuration items.
-* @returns A promise that resolves to an array of user configuration items.
-* @rejects Will throw an error if configuration generation fails.
-*/
-async function isentinel(options = {}, ...userConfigs) {
+async function isentinel(options, ...userConfigs) {
 	const { autoRenamePlugins = true, componentExts: componentExtensions = [], eslintPlugin: enableEslintPlugin = false, formatters, gitignore: enableGitignore = true, jsdoc: enableJsdoc = true, jsx: enableJsx = true, pnpm: enableCatalogs = findUpSync("pnpm-workspace.yaml") !== void 0, react: enableReact = false, root: customRootGlobs, spellCheck: enableSpellCheck, typescript: enableTypeScript } = options;
 	const rootGlobs = mergeGlobs(GLOB_ROOT, customRootGlobs);
 	const enableRoblox = options.roblox !== false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isentinel/eslint-config",
-  "version": "4.6.1",
+  "version": "4.7.1",
   "description": "iSentinel's ESLint config",
   "keywords": [
     "eslint-config",
@@ -121,11 +121,11 @@
     "pnpm-workspace-yaml": "1.4.2",
     "rimraf": "6.1.2",
     "simple-git-hooks": "2.13.1",
-    "tsdown": "0.17.2",
+    "tsdown": "0.17.3",
     "tsx": "4.21.0",
     "type-fest": "5.3.1",
     "typescript": "5.9.3",
-    "@isentinel/eslint-config": "4.6.1"
+    "@isentinel/eslint-config": "4.7.1"
   },
   "peerDependencies": {
     "@vitest/eslint-plugin": "^1.0.0",