@isentinel/eslint-config 3.4.0 → 3.5.0

package/dist/cli.js

@@ -11,7 +11,7 @@ import { execSync } from "node:child_process";
 
 //#region package.json
 var name = "@isentinel/eslint-config";
-var version = "3.4.0";
+var version = "3.5.0";
 var description = "iSentinel's ESLint config";
 var keywords = [
 	"eslint-config",

package/dist/index.d.ts

@@ -15562,6 +15562,25 @@ declare function interopDefault<T>(dynamicImport: ModuleImport<T>): Promise<T>;
 declare function isInEditorEnvironment(): boolean;
 declare function isInGitHooksOrLintStaged(): boolean;
 declare function mergePrettierOptions(options: PrettierOptions, overrides?: PrettierRuleOptions): Record<string, any>;
+/**
+ * Merge custom root glob patterns with the default GLOB_ROOT.
+ *
+ * - Patterns starting with "!" are used to remove matching patterns from the
+ *   default GLOB_ROOT
+ * - Other patterns are added to the result.
+ *
+ * @example
+ *
+ * ```ts
+ * const result = mergeRootGlobs(GLOB_ROOT, ["places/**", "!apps/**"]);
+ * // Returns: ["*", "packages/**", "libs/**", "places/**"]
+ * ```
+ *
+ * @param defaultRoot - The default root glob patterns.
+ * @param customRoot - Custom root patterns to merge (optional).
+ * @returns The merged array of glob patterns.
+ */
+declare function mergeRootGlobs(defaultRoot: Array<string>, customRoot?: Array<string>): Array<string>;
 /**
  * Rename plugin names a flat configs array.
  *
@@ -15755,6 +15774,22 @@ interface OptionsConfig extends OptionsComponentExtensions, OptionsProjectType {
    * @default true
    */
   roblox?: boolean | OptionsOverridesTypeAware;
+  /**
+   * Customize root-level glob patterns.
+   *
+   * These patterns are merged with the default `GLOB_ROOT`. Use "!" prefix to
+   * exclude patterns.
+   *
+   * @example
+   *
+   * ```ts
+   * root: ["places/**", "!apps/**"];
+   * // Results in: ["*", "packages/**", "libs/**", "places/**"]
+   * ```
+   *
+   * @default undefined
+   */
+  root?: Array<string>;
   /**
    * Enable CSpell support.
    *
@@ -16116,7 +16151,9 @@ declare function toml(options?: OptionsFiles & OptionsOverrides & OptionsStylist
 declare function typescript(options?: OptionsComponentExtensions & OptionsFiles & OptionsOverridesTypeAware & OptionsStylistic & OptionsTypeScriptErasableOnly & OptionsTypeScriptParserOptions & OptionsTypeScriptWithTypes): Promise<Array<TypedFlatConfigItem>>;
 //#endregion
 //#region src/configs/unicorn.d.ts
-declare function unicorn(options?: OptionsStylistic): Promise<Array<TypedFlatConfigItem>>;
+declare function unicorn(options?: OptionsStylistic & {
+  root?: Array<string>;
+}): Promise<Array<TypedFlatConfigItem>>;
 //#endregion
 //#region src/configs/yaml.d.ts
 declare function yaml(options?: OptionsFiles & OptionsOverrides & OptionsStylistic): Promise<Array<TypedFlatConfigItem>>;
@@ -16145,6 +16182,7 @@ declare function isentinel(options?: OptionsConfig & TypedFlatConfigItem, ...use
 //#endregion
 //#region src/globs.d.ts
 declare const GLOB_ROOT: string[];
+declare const GLOB_ROOT_SRC: string[];
 declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
 declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
 declare const GLOB_LUA = "**/*.lua?(u)";
@@ -16176,4 +16214,4 @@ declare const GLOB_BUILD_TOOLS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 //#endregion
-export { Awaitable, type ConfigNames, ExtractRuleOptions, 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_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, OptionsProjectType, OptionsRoblox, OptionsStylistic, OptionsTestFramework, OptionsTypeScriptErasableOnly, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypescript, PerfectionistConfig, type PrettierOptions, PrettierRuleOptions, ReactConfig, ResolvedOptions, Rules, SpellCheckConfig, StylisticConfig, StylisticConfigDefaults, TypedFlatConfigItem, combine, comments, createTsParser, isentinel as default, defaultPluginRenaming, disables, ensurePackages, eslintPlugin, flawless, getOverrides, getTsConfig, gitignore, ignores, imports, interopDefault, isInEditorEnvironment, isInGitHooksOrLintStaged, isentinel, javascript, jsdoc, jsonc, markdown, mergePrettierOptions, node, packageJson, parserPlain, perfectionist, pnpm, prettier, promise, react, renamePluginInConfigs, renameRules, require, resolvePrettierConfigOptions, resolveSubOptions, resolveWithDefaults, roblox, shopify, shouldEnableFeature, sonarjs, sortGithubAction, sortRojoProject, sortTsconfig, spelling, stylistic, toml, typescript, unicorn, yaml };
+export { Awaitable, type ConfigNames, ExtractRuleOptions, 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, OptionsProjectType, OptionsRoblox, OptionsStylistic, OptionsTestFramework, OptionsTypeScriptErasableOnly, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypescript, PerfectionistConfig, type PrettierOptions, PrettierRuleOptions, ReactConfig, ResolvedOptions, Rules, SpellCheckConfig, StylisticConfig, StylisticConfigDefaults, TypedFlatConfigItem, combine, comments, createTsParser, isentinel as default, defaultPluginRenaming, disables, ensurePackages, eslintPlugin, flawless, getOverrides, getTsConfig, gitignore, ignores, imports, interopDefault, isInEditorEnvironment, isInGitHooksOrLintStaged, isentinel, javascript, jsdoc, jsonc, markdown, mergePrettierOptions, mergeRootGlobs, node, packageJson, parserPlain, perfectionist, pnpm, prettier, promise, react, renamePluginInConfigs, renameRules, require, resolvePrettierConfigOptions, resolveSubOptions, resolveWithDefaults, roblox, shopify, shouldEnableFeature, sonarjs, sortGithubAction, sortRojoProject, sortTsconfig, spelling, stylistic, toml, typescript, unicorn, yaml };

package/dist/index.js

@@ -12,6 +12,15 @@ import { fixupPluginRules } from "@eslint/compat";
 
 //#region src/globs.ts
 const GLOB_ROOT = [
+	"*",
+	"packages/*/*",
+	"apps/*/*",
+	"libs/*/*",
+	"packages/*/*/*",
+	"apps/*/*/*",
+	"libs/*/*/*"
+];
+const GLOB_ROOT_SRC = [
 	"*.?([cm])[jt]s?(x)",
 	"packages/*/*.?([cm])[jt]s?(x)",
 	"apps/*/*.?([cm])[jt]s?(x)",
@@ -223,6 +232,33 @@ function mergePrettierOptions(options, overrides = {}) {
 	};
 }
 /**
+* Merge custom root glob patterns with the default GLOB_ROOT.
+*
+* - Patterns starting with "!" are used to remove matching patterns from the
+*   default GLOB_ROOT
+* - Other patterns are added to the result.
+*
+* @example
+*
+* ```ts
+* const result = mergeRootGlobs(GLOB_ROOT, ["places/**", "!apps/**"]);
+* // Returns: ["*", "packages/**", "libs/**", "places/**"]
+* ```
+*
+* @param defaultRoot - The default root glob patterns.
+* @param customRoot - Custom root patterns to merge (optional).
+* @returns The merged array of glob patterns.
+*/
+function mergeRootGlobs(defaultRoot, customRoot) {
+	if (!customRoot || customRoot.length === 0) return [...defaultRoot];
+	let result = [...defaultRoot];
+	for (const pattern of customRoot) if (pattern.startsWith("!")) {
+		const patternToRemove = pattern.slice(1);
+		result = result.filter((item) => item !== patternToRemove);
+	} else result.push(pattern);
+	return result;
+}
+/**
 * Rename plugin names a flat configs array.
 *
 * @example
@@ -4793,7 +4829,7 @@ const defaultPluginRenaming = {
 * @returns A promise that resolves to an array of user configuration items.
 */
 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 = false, react: enableReact = false, spellCheck: enableSpellCheck, typescript: enableTypeScript } = options;
+	const { autoRenamePlugins = true, componentExts: componentExtensions = [], eslintPlugin: enableEslintPlugin = false, formatters, gitignore: enableGitignore = true, jsdoc: enableJsdoc = true, jsx: enableJsx = true, pnpm: enableCatalogs = false, react: enableReact = false, root: customRootGlobs, spellCheck: enableSpellCheck, typescript: enableTypeScript } = options;
 	const enableRoblox = options.roblox !== false;
 	let { isInEditor } = options;
 	if (isInEditor === void 0) {
@@ -4851,7 +4887,10 @@ async function isentinel(options = {}, ...userConfigs) {
 		...getOverrides(options, "typescript"),
 		componentExts: componentExtensions,
 		stylistic: stylisticOptions
-	}), unicorn({ stylistic: stylisticOptions }));
+	}), unicorn({
+		root: customRootGlobs,
+		stylistic: stylisticOptions
+	}));
 	if (options.flawless === true) configs.push(flawless({ ...getOverrides(options, "flawless") }));
 	if (enableJsdoc !== false) configs.push(jsdoc({
 		stylistic: stylisticOptions,
@@ -6269,10 +6308,12 @@ const abbreviations = {
 	utils: false
 };
 async function unicorn(options = {}) {
-	const { stylistic: stylistic$1 = true } = options;
+	const { root: customRootGlobs, stylistic: stylistic$1 = true } = options;
+	const pluginUnicorn = await interopDefault(import("eslint-plugin-unicorn"));
+	const rootGlobs = mergeRootGlobs(GLOB_ROOT, customRootGlobs);
 	return [{
 		name: "isentinel/unicorn",
-		plugins: { unicorn: await interopDefault(import("eslint-plugin-unicorn")) },
+		plugins: { unicorn: pluginUnicorn },
 		rules: {
 			"unicorn/catch-error-name": ["error", { name: "err" }],
 			"unicorn/consistent-destructuring": "error",
@@ -6318,7 +6359,7 @@ async function unicorn(options = {}) {
 			...stylistic$1 !== false ? { "unicorn/switch-case-braces": "error" } : {}
 		}
 	}, {
-		files: [GLOB_ROOT],
+		files: rootGlobs,
 		name: "isentinel/unicorn/root",
 		rules: { "unicorn/prevent-abbreviations": ["error", {
 			checkFilenames: false,
@@ -6375,4 +6416,4 @@ async function yaml(options = {}) {
 }
 
 //#endregion
-export { 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_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_XML, GLOB_YAML, StylisticConfigDefaults, combine, comments, createTsParser, isentinel as default, defaultPluginRenaming, disables, ensurePackages, eslintPlugin, flawless, getOverrides, getTsConfig, gitignore, ignores, imports, interopDefault, isInEditorEnvironment, isInGitHooksOrLintStaged, isentinel, javascript, jsdoc, jsonc, markdown, mergePrettierOptions, node, packageJson, parserPlain, perfectionist, pnpm, prettier, promise, react, renamePluginInConfigs, renameRules, require$1 as require, resolvePrettierConfigOptions, resolveSubOptions, resolveWithDefaults, roblox, shopify, shouldEnableFeature, sonarjs, sortGithubAction, sortRojoProject, sortTsconfig, spelling, stylistic, toml, typescript, unicorn, yaml };
+export { 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, StylisticConfigDefaults, combine, comments, createTsParser, isentinel as default, defaultPluginRenaming, disables, ensurePackages, eslintPlugin, flawless, getOverrides, getTsConfig, gitignore, ignores, imports, interopDefault, isInEditorEnvironment, isInGitHooksOrLintStaged, isentinel, javascript, jsdoc, jsonc, markdown, mergePrettierOptions, mergeRootGlobs, node, packageJson, parserPlain, perfectionist, pnpm, prettier, promise, react, renamePluginInConfigs, renameRules, require$1 as require, resolvePrettierConfigOptions, resolveSubOptions, resolveWithDefaults, roblox, shopify, shouldEnableFeature, sonarjs, sortGithubAction, sortRojoProject, sortTsconfig, spelling, stylistic, toml, typescript, unicorn, yaml };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isentinel/eslint-config",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "iSentinel's ESLint config",
   "keywords": [
     "eslint-config",
@@ -119,7 +119,7 @@
     "tsdown": "0.14.2",
     "type-fest": "4.41.0",
     "typescript": "5.9.2",
-    "@isentinel/eslint-config": "3.4.0"
+    "@isentinel/eslint-config": "3.5.0"
   },
   "peerDependencies": {
     "@eslint-react/eslint-plugin": "^1.45.0",