@isentinel/eslint-config 6.0.0-beta.43 → 6.0.0-beta.44

package/README.md

@@ -928,6 +928,10 @@ are `{nodeName}`, `{NodeName}`, `{node_name}` and `{NODE_NAME}`. A file already
 matching a template is exempt from it. A source file with no test disables the
 rule at the source.
 
+The rule needs no type information, so oxlint runs it too: the same option is
+accepted by the oxlint factory, and hybrid mode (`oxlint: true`) hands the check
+to oxlint.
+
 Two caveats. Deleting `foo.spec.ts` does not change `foo.ts`, so a cached run
 replays the old clean result — the check is only sound uncached. And the plugin
 writes `projectStructure.cache.json` into `projectRoot` while it has something

package/dist/cli.mjs

@@ -9,7 +9,7 @@ import path from "node:path";
 import { existsSync, readFileSync } from "fs";
 import { execSync } from "node:child_process";
 //#region package.json
-var version = "6.0.0-beta.43";
+var version = "6.0.0-beta.44";
 var package_default = {
 	name: "@isentinel/eslint-config",
 	version,

package/dist/index.mjs

@@ -3950,42 +3950,44 @@ async function detectCatalogUsage() {
 	return yaml.includes("catalog:") || yaml.includes("catalogs:");
 }
 //#endregion
-//#region src/eslint/configs/project-structure.ts
+//#region src/rules/project-structure.ts
 init_globs();
 /** Stands for the extension of the file a rule matched. */
 const EXTENSION_TOKEN = "{ext}";
 const DEFAULT_ENFORCE_EXISTENCE = [`{node-name}.spec.${EXTENSION_TOKEN}`];
 /** Reusable-rule id for "a folder of any name". */
 const ANY_FOLDER = "isentinelAnyFolder";
-async function projectStructure({ enforceExistence = DEFAULT_ENFORCE_EXISTENCE, files = [GLOB_SRC], ignores = [
+/** The files the co-location check runs on, before `ignores`. */
+const PROJECT_STRUCTURE_FILES = [GLOB_SRC];
+/** The files the co-location check skips. */
+const PROJECT_STRUCTURE_IGNORES = [
 	...GLOB_TESTS,
 	GLOB_DTS,
 	...GLOB_BUILD_CONFIGS
-], overrides = {}, projectRoot = process.cwd(), structureRoot } = {}) {
-	await ensurePackages(["eslint-plugin-project-structure"]);
-	const { projectStructurePlugin } = await import("eslint-plugin-project-structure");
+];
+/**
+* Co-location rules shared between the ESLint and oxlint factories.
+*
+* `folder-structure` is not type-aware and runs unchanged as an oxlint
+* jsPlugin, so both engines have to hand it the same options or they disagree
+* about which files are co-located.
+*
+* @param options - The templates to enforce, and the roots they resolve
+*   against.
+* @returns The rule map.
+*/
+function folderStructureRules({ enforceExistence = DEFAULT_ENFORCE_EXISTENCE, projectRoot = process.cwd(), structureRoot } = {}) {
 	const children = buildChildren(typeof enforceExistence === "string" ? [enforceExistence] : enforceExistence);
-	return [{
-		name: "isentinel/project-structure/setup",
-		plugins: { "project-structure": projectStructurePlugin }
-	}, {
-		name: "isentinel/project-structure/rules",
-		files,
-		ignores,
-		rules: {
-			"project-structure/folder-structure": ["error", {
-				longPathsInfo: false,
-				projectRoot,
-				rules: { [ANY_FOLDER]: {
-					name: "*",
-					children
-				} },
-				structure: children,
-				...structureRoot === void 0 ? {} : { structureRoot }
-			}],
-			...overrides
-		}
-	}];
+	return { "project-structure/folder-structure": ["error", {
+		longPathsInfo: false,
+		projectRoot,
+		rules: { [ANY_FOLDER]: {
+			name: "*",
+			children
+		} },
+		structure: children,
+		...structureRoot === void 0 ? {} : { structureRoot }
+	}] };
 }
 /**
 * The rules matching the files inside one folder, in the order
@@ -4012,6 +4014,28 @@ function buildChildren(templates) {
 	return children;
 }
 //#endregion
+//#region src/eslint/configs/project-structure.ts
+async function projectStructure({ enforceExistence, files = PROJECT_STRUCTURE_FILES, ignores = PROJECT_STRUCTURE_IGNORES, overrides = {}, projectRoot, structureRoot } = {}) {
+	await ensurePackages(["eslint-plugin-project-structure"]);
+	const { projectStructurePlugin } = await import("eslint-plugin-project-structure");
+	return [{
+		name: "isentinel/project-structure/setup",
+		plugins: { "project-structure": projectStructurePlugin }
+	}, {
+		name: "isentinel/project-structure/rules",
+		files,
+		ignores,
+		rules: {
+			...folderStructureRules({
+				enforceExistence,
+				projectRoot,
+				structureRoot
+			}),
+			...overrides
+		}
+	}];
+}
+//#endregion
 //#region src/rules/promise.ts
 /**
 * Promise rules shared between the ESLint and oxlint factories.
@@ -15660,6 +15684,7 @@ var init_adapters = __esmMin((() => {
 		"oxfmt": "eslint-plugin-oxfmt",
 		"oxlint-comments": "oxlint-plugin-oxlint-comments",
 		"perfectionist": "eslint-plugin-perfectionist",
+		"project-structure": "eslint-plugin-project-structure",
 		"promise-js": "eslint-plugin-promise",
 		"react-jsx": "eslint-plugin-react-jsx",
 		"react-naming-convention": "eslint-plugin-react-naming-convention",
@@ -16549,6 +16574,9 @@ var init_oxlint_capabilities = __esmMin((() => {
 		"prefer-spread",
 		"prefer-template",
 		"preserve-caught-error",
+		"project-structure/file-composition",
+		"project-structure/folder-structure",
+		"project-structure/independent-modules",
 		"promise/always-return",
 		"promise/avoid-new",
 		"promise/catch-or-return",

package/dist/lint-cli.mjs

@@ -38,7 +38,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 }) : target, mod));
 //#endregion
 //#region package.json
-var version = "6.0.0-beta.43";
+var version = "6.0.0-beta.44";
 //#endregion
 //#region src/lint-cli/lib/cli/types.ts
 /**

package/dist/oxlint.d.mts

@@ -3860,6 +3860,7 @@ interface OverrideSiteChains {
   e18e: MainChain;
   eslintPlugin: FeatureChain;
   javascript: MainChain;
+  projectStructure: FeatureChain;
   react: ReactChain;
   roblox: MainChain;
   typescript: MainChain;
@@ -33259,7 +33260,7 @@ type OxlintCommentsRequireDescription = [] | [{
   ignore?: ("oxlint-disable" | "oxlint-disable-line" | "oxlint-disable-next-line" | "oxlint-enable")[];
 }];
 /** JsPlugin prefixes whose rules keep their ESLint-side names in oxlint configs. */
-type OxlintKeptJsPluginPrefix = '@cspell' | 'antfu' | 'better-max-params' | 'comment-length' | 'de-morgan' | 'e18e' | 'erasable-syntax-only' | 'eslint-plugin' | 'flawless' | 'jest-extended' | 'oxfmt' | 'perfectionist' | 'react-jsx' | 'react-naming-convention' | 'roblox' | 'sentinel' | 'small-rules' | 'sonar' | 'style' | 'testing-library' | 'ts' | 'unused-imports';
+type OxlintKeptJsPluginPrefix = '@cspell' | 'antfu' | 'better-max-params' | 'comment-length' | 'de-morgan' | 'e18e' | 'erasable-syntax-only' | 'eslint-plugin' | 'flawless' | 'jest-extended' | 'oxfmt' | 'perfectionist' | 'project-structure' | 'react-jsx' | 'react-naming-convention' | 'roblox' | 'sentinel' | 'small-rules' | 'sonar' | 'style' | 'testing-library' | 'ts' | 'unused-imports';
 /** JsPlugin rules whose oxlint names match the ESLint-side names. */
 type OxlintKeptJsPluginRuleOptions = { [K in keyof RuleOptions as K extends `${OxlintKeptJsPluginPrefix}/${string}` ? K : never]: RuleOptions[K]; };
 /** All rules known to the oxlint factory, keyed by canonical oxlint rule name. */
@@ -33305,7 +33306,7 @@ type TypedOxlintConfigItem = Omit<OxlintOverride$1, "rules"> & {
  * Oxlint can only lint JS/TS files, so the JSON, YAML, TOML, Markdown and
  * pnpm-related options are omitted, along with ESLint-only options.
  */
-type OxlintOptionsConfig = Omit<OptionsConfig, "autoRenamePlugins" | "flawless" | "jsonc" | "markdown" | "namedConfigs" | "naming" | "oxlint" | "pnpm" | "projectStructure" | "toml" | "yaml">;
+type OxlintOptionsConfig = Omit<OptionsConfig, "autoRenamePlugins" | "flawless" | "jsonc" | "markdown" | "namedConfigs" | "naming" | "oxlint" | "pnpm" | "toml" | "yaml">;
 /**
  * Options accepted by the oxlint factory function.
  *

package/dist/oxlint.mjs

@@ -616,6 +616,9 @@ const jsPluginRuleNames = /* @__PURE__ */ new Set([
 	"prefer-spread",
 	"prefer-template",
 	"preserve-caught-error",
+	"project-structure/file-composition",
+	"project-structure/folder-structure",
+	"project-structure/independent-modules",
 	"promise/always-return",
 	"promise/avoid-new",
 	"promise/catch-or-return",
@@ -4747,6 +4750,7 @@ const oxlintJsPlugins = {
 	"oxfmt": "eslint-plugin-oxfmt",
 	"oxlint-comments": "oxlint-plugin-oxlint-comments",
 	"perfectionist": "eslint-plugin-perfectionist",
+	"project-structure": "eslint-plugin-project-structure",
 	"promise-js": "eslint-plugin-promise",
 	"react-jsx": "eslint-plugin-react-jsx",
 	"react-naming-convention": "eslint-plugin-react-naming-convention",
@@ -5165,6 +5169,23 @@ const GLOB_ROOT = [
 ];
 const GLOB_SRC_EXT = "{,c,m}[jt]s{,x}";
 const GLOB_SRC = "**/*.{,c,m}[jt]s{,x}";
+/**
+* The real TS/JS-family file extensions {@link GLOB_SRC_EXT} encodes (the glob
+* additionally matches non-existent combinations such as `cjsx`). Kept next to
+* the glob so the two are maintained together; consumed by the lint CLI to size
+* its type-aware pass.
+*/
+const GLOB_SRC_EXTENSIONS = [
+	"ts",
+	"tsx",
+	"mts",
+	"cts",
+	"js",
+	"jsx",
+	"mjs",
+	"cjs"
+];
+[...GLOB_SRC_EXTENSIONS];
 const GLOB_JSX = "**/*.{,c,m}jsx";
 const GLOB_TSX = "**/*.{,c,m}tsx";
 const GLOB_DTS = "**/*.d.{,c,m}ts";
@@ -8013,6 +8034,94 @@ function oxlintPerfectionist(config) {
 	})];
 }
 //#endregion
+//#region src/rules/project-structure.ts
+/** Stands for the extension of the file a rule matched. */
+const EXTENSION_TOKEN = "{ext}";
+const DEFAULT_ENFORCE_EXISTENCE = [`{node-name}.spec.${EXTENSION_TOKEN}`];
+/** Reusable-rule id for "a folder of any name". */
+const ANY_FOLDER = "isentinelAnyFolder";
+/** The files the co-location check runs on, before `ignores`. */
+const PROJECT_STRUCTURE_FILES = [GLOB_SRC];
+/** The files the co-location check skips. */
+const PROJECT_STRUCTURE_IGNORES = [
+	...GLOB_TESTS,
+	GLOB_DTS,
+	...GLOB_BUILD_CONFIGS
+];
+/**
+* Co-location rules shared between the ESLint and oxlint factories.
+*
+* `folder-structure` is not type-aware and runs unchanged as an oxlint
+* jsPlugin, so both engines have to hand it the same options or they disagree
+* about which files are co-located.
+*
+* @param options - The templates to enforce, and the roots they resolve
+*   against.
+* @returns The rule map.
+*/
+function folderStructureRules({ enforceExistence = DEFAULT_ENFORCE_EXISTENCE, projectRoot = process.cwd(), structureRoot } = {}) {
+	const children = buildChildren(typeof enforceExistence === "string" ? [enforceExistence] : enforceExistence);
+	return { "project-structure/folder-structure": ["error", {
+		longPathsInfo: false,
+		projectRoot,
+		rules: { [ANY_FOLDER]: {
+			name: "*",
+			children
+		} },
+		structure: children,
+		...structureRoot === void 0 ? {} : { structureRoot }
+	}] };
+}
+/**
+* The rules matching the files inside one folder, in the order
+* `folder-structure` tries them - first match wins.
+*
+* Every entry is permissive: `structure` is required by the rule and an
+* unmatched node is an error, so anything less would turn the co-location
+* check into whole-tree naming enforcement.
+*
+* @param templates - The `enforceExistence` templates, before substitution.
+* @returns The child rules, ending in the recursive folder rule.
+*/
+function buildChildren(templates) {
+	const children = templates.map((template) => {
+		return { name: (template.split("/").pop() ?? template).replaceAll(/\{[^{}]*\}/g, "*") };
+	});
+	for (const extension of GLOB_SRC_EXTENSIONS) children.push({
+		name: `*.${extension}`,
+		enforceExistence: templates.map((template) => {
+			return template.replaceAll(EXTENSION_TOKEN, () => extension);
+		})
+	});
+	children.push({ ruleId: ANY_FOLDER });
+	return children;
+}
+//#endregion
+//#region src/oxlint/configs/project-structure.ts
+/**
+* Co-location rules for standalone oxlint.
+*
+* `folder-structure` runs as a jsPlugin: it visits `Program` once per file and
+* answers from the filesystem, so oxlint needs no type information to run it.
+*
+* @param options - The templates to enforce, and the roots they resolve
+*   against.
+* @returns The generated config fragments.
+*/
+function oxlintProjectStructure({ enforceExistence, files = PROJECT_STRUCTURE_FILES, ignores = PROJECT_STRUCTURE_IGNORES, overrides = {}, projectRoot, structureRoot } = {}) {
+	return createOxlintConfigs({
+		name: "isentinel/project-structure",
+		excludeFiles: ignores,
+		files: files.flat(),
+		overrides,
+		rules: folderStructureRules({
+			enforceExistence,
+			projectRoot,
+			structureRoot
+		})
+	});
+}
+//#endregion
 //#region src/rules/promise.ts
 /**
 * Promise rules shared between the ESLint and oxlint factories.
@@ -9230,7 +9339,7 @@ const NATIVE_ONLY_JS_PLUGINS = /* @__PURE__ */ new Set(["oxlint-comments"]);
 */
 function isentinel(factoryOptions, ...userConfigs) {
 	const options = factoryOptions ?? { name: "isentinel" };
-	const { categories, componentExts: componentExtensions = [], e18e: enableE18e = true, env, eslintPlugin: enableEslintPlugin = false, formatters, gitignore: enableGitignore = true, globals, ignores, jsdoc: enableJsdoc = true, jsPlugins: userJsPlugins, jsx: enableJsx = true, options: linterOptions, oxc: enableOxc = true, react: enableReact = false, root: customRootGlobs, rules = {}, spellCheck: enableSpellCheck, test: enableTest = false, warnDroppedOverrides: enableDroppedOverrideWarning = true } = options;
+	const { categories, componentExts: componentExtensions = [], e18e: enableE18e = true, env, eslintPlugin: enableEslintPlugin = false, formatters, gitignore: enableGitignore = true, globals, ignores, jsdoc: enableJsdoc = true, jsPlugins: userJsPlugins, jsx: enableJsx = true, options: linterOptions, oxc: enableOxc = true, projectStructure: enableProjectStructure = false, react: enableReact = false, root: customRootGlobs, rules = {}, spellCheck: enableSpellCheck, test: enableTest = false, warnDroppedOverrides: enableDroppedOverrideWarning = true } = options;
 	const rootGlobs = mergeGlobs(GLOB_ROOT, customRootGlobs);
 	const enableRoblox = options.roblox !== false;
 	const reactOptions = resolveSubOptions(options, "react");
@@ -9359,6 +9468,7 @@ function isentinel(factoryOptions, ...userConfigs) {
 		isInEditor
 	}));
 	if (enableEslintPlugin !== false) configs.push(oxlintEslintPlugin({ ...getOverrides(options, "eslintPlugin") }));
+	if (enableProjectStructure !== false) configs.push(oxlintProjectStructure(resolveSubOptions(options, "projectStructure")));
 	if (enableOxc) {
 		configs.push(oxlintOxc({ roblox: enableRoblox }));
 		if (needsComplementOverlay) configs.push(oxlintOxc({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isentinel/eslint-config",
-  "version": "6.0.0-beta.43",
+  "version": "6.0.0-beta.44",
   "description": "iSentinel's ESLint config",
   "keywords": [
     "eslint-config",
@@ -145,7 +145,7 @@
     "typescript": "6.0.3",
     "unplugin-unused": "0.5.7",
     "vitest": "4.1.10",
-    "@isentinel/eslint-config": "6.0.0-beta.43"
+    "@isentinel/eslint-config": "6.0.0-beta.44"
   },
   "peerDependencies": {
     "@vitest/eslint-plugin": "^1.6.4",