oxlint-plugin-arch 0.6.3 → 0.8.0

package/dist/constants/preset.constants.d.ts

@@ -1,4 +1,4 @@
-import type { PresetRules, PresetPolicyName } from '../types/preset.types.ts';
+import type { PresetRules, PresetPolicyName, PresetTestMockingException, PresetTestMockingPreset } from '../types/preset.types.ts';
 export declare const presetExtensions = "*.{ts,tsx,mts,cts}";
 export declare const presetPolicyOrder: PresetPolicyName[];
 export declare const presetCommonRules: PresetRules;
@@ -18,6 +18,16 @@ export declare const presetTailwindRules: {
 export declare const presetImportRules: PresetRules;
 export declare const presetNamingRules: PresetRules;
 export declare const presetTestRules: PresetRules;
+/** Test-double APIs each `tests.mocking` preset bans, for `vi` and `jest`. */
+export declare const presetTestMockingApis: Record<PresetTestMockingPreset, string[]>;
+export declare const presetTestMockingAllow: Record<PresetTestMockingPreset, PresetTestMockingException[]>;
+export declare const presetStrictMockingMessage = "Inject a fake driver through the dependencies of the code under test instead of mocking or stubbing.";
+/** HTTP methods a Next `route.ts` handler may export. */
+export declare const presetNextHandlerMethods: string[];
+/** Next route segment config exports, shared by pages, layouts and route handlers. */
+export declare const presetNextSegmentConfig: string[];
+/** Exports a Next page or layout may add next to its default component. */
+export declare const presetNextSegmentExports: string[];
 export declare const presetExportPrefix: {
     stem: string;
     trailingRoles: string[];

package/dist/index.js

@@ -749,6 +749,11 @@ function layoutNewline(text) {
 ` : `
 `;
 }
+// src/utils/helpers/mocking.ts
+function mockingApiPatternsAssert(patterns) {
+  if (patterns.some((pattern) => !/^(?:\*|(?:vi|jest|\*)\.(?:[A-Za-z_$][\w$]*|\*))$/.test(pattern)))
+    throw new Error("Test mocking APIs must be `*` or `<vi|jest|*>.<method|*>`.");
+}
 // src/utils/helpers/options.ts
 function optionsFirst(context, fallback) {
   return context.options[0] ?? fallback;
@@ -894,6 +899,49 @@ function routesInspectFunction(context, item, bannedHooks, banIntrinsicJsx) {
     }
   });
 }
+// src/utils/helpers/runtime.ts
+import { builtinModules } from "node:module";
+var runtimeServerGlobals = ["process", "Bun", "Deno", "Buffer", "__dirname", "__filename", "require"];
+var runtimeBrowserGlobals = [
+  "window",
+  "document",
+  "navigator",
+  "localStorage",
+  "sessionStorage",
+  "location",
+  "history",
+  "screen",
+  "HTMLElement",
+  "Element",
+  "HTMLInputElement",
+  "ResizeObserver",
+  "MutationObserver",
+  "IntersectionObserver",
+  "FileReader",
+  "matchMedia",
+  "getComputedStyle",
+  "requestAnimationFrame",
+  "cancelAnimationFrame",
+  "alert",
+  "confirm",
+  "prompt"
+];
+function runtimeMatchesImport(values, source) {
+  return Boolean(values?.some((value) => source === value || source.startsWith(value + "/")));
+}
+function runtimeIsBackendImport(options, target, source) {
+  return options.backend.some((path) => target.startsWith(path + "/")) || options.backendPackages.some((name) => source === name || source.startsWith(name + "/") && /\/(?:server|rpc)(?:\/|$)/.test(source.slice(name.length)));
+}
+function runtimeIsServerPlatformImport(source) {
+  return builtinModules.includes(source) || source === "@orpc/server" || /^(?:node:|bun(?::|$)|cloudflare:)/.test(source) || /^react-dom\/server(?:\.|\/|$)/.test(source);
+}
+function runtimeMemberName(node) {
+  if (node?.type !== "MemberExpression")
+    return null;
+  if (!node.computed && node.property.type === "Identifier")
+    return node.property.name;
+  return node.computed && node.property.type === "Literal" && typeof node.property.value === "string" ? node.property.value : null;
+}
 // src/utils/helpers/sanitizers.ts
 function sanitizersCallsConfigured(node, names) {
   let found = false;
@@ -2378,8 +2426,10 @@ var noFileLevelHelpers = defineRule16({
         } = optionsFirst(context, {});
         const allowed = optionsOptionalPatterns(allowPattern);
         const hooks = optionsPatterns(hookPattern);
+        const exported = exportsCollect(program);
+        const allowedExport = (name) => exported.some((binding) => binding.localName === name && optionsPatternsTest(allowed, binding.exportedName));
         for (const candidate of declarationsFileLevelFunctionCandidates(program)) {
-          if (detectComponents && reactComponentsIsLike(program, candidate) || optionsPatternsTest(hooks, candidate.name) || optionsPatternsTest(allowed, candidate.name)) {
+          if (detectComponents && reactComponentsIsLike(program, candidate) || optionsPatternsTest(hooks, candidate.name) || optionsPatternsTest(allowed, candidate.name) || allowedExport(candidate.name)) {
             continue;
           }
           context.report({
@@ -4271,6 +4321,7 @@ var onlyExportComponents = defineRule36({
         additionalProperties: false,
         properties: {
           matchFileName: { type: "boolean" },
+          trailingRoles: { type: "array", items: { type: "string" } },
           allowTypeExports: { type: "boolean" },
           denyTypePattern: optionsPatternSchema
         }
@@ -4288,10 +4339,15 @@ var onlyExportComponents = defineRule36({
       Program(program) {
         const {
           matchFileName = true,
+          trailingRoles = [],
           allowTypeExports = true,
           denyTypePattern
         } = optionsFirst(context, {});
-        const expected = reactComponentsPascalFromBasename(namingFileBasename(context.filename));
+        const basename = namingFileBasename(context.filename);
+        const extension = basename.slice(basename.lastIndexOf("."));
+        const role = trailingRoles.find((candidate) => basename.endsWith(`.${candidate}${extension}`));
+        const expected = reactComponentsPascalFromBasename(role ? basename.replace(`.${role}${extension}`, extension) : basename);
+        const expectedKeys = [expected, ...role ? [reactComponentsPascalFromBasename(basename)] : []].map((name) => name.toLowerCase());
         const denied = optionsOptionalPatterns(denyTypePattern);
         const components = [];
         for (const candidate of reactComponentsExportCandidates(program)) {
@@ -4324,10 +4380,9 @@ var onlyExportComponents = defineRule36({
         if (components.length === 0 || !matchFileName) {
           return;
         }
-        const expectedKey = expected.toLowerCase();
-        const exact = components.some((candidate) => candidate.name.toLowerCase() === expectedKey);
-        const allPrefixed = components.every((candidate) => candidate.name.toLowerCase().startsWith(expectedKey));
-        if (!exact && !allPrefixed) {
+        const names = components.map((candidate) => candidate.name.toLowerCase());
+        const matches = expectedKeys.some((expectedKey) => names.includes(expectedKey) || names.every((name) => name.startsWith(expectedKey)));
+        if (!matches) {
           for (const candidate of components) {
             context.report({
               node: candidate.node,
@@ -4994,13 +5049,21 @@ var routeSurface = defineRule44({
         additionalProperties: false,
         properties: {
           exportName: { type: "string" },
+          allowedExports: { type: "array", items: { type: "string" } },
+          inspectExports: { type: "boolean" },
           bannedHooks: { type: "array", items: { type: "string" } },
           banIntrinsicJsx: { type: "boolean" }
         }
       }
     ],
     defaultOptions: [
-      { exportName: "Route", bannedHooks: ["useState", "useEffect", "useMutation"], banIntrinsicJsx: true }
+      {
+        exportName: "Route",
+        allowedExports: [],
+        inspectExports: false,
+        bannedHooks: ["useState", "useEffect", "useMutation"],
+        banIntrinsicJsx: true
+      }
     ],
     messages: {
       extraExport: "Route files may only export '{{expected}}'; found '{{actual}}'.",
@@ -5011,20 +5074,34 @@ var routeSurface = defineRule44({
   createOnce(context) {
     return {
       Program(program) {
-        const { exportName, bannedHooks, banIntrinsicJsx } = optionsFirst(context);
-        for (const binding of exportsCollect(program)) {
-          if (binding.exportedName !== exportName) {
+        const { exportName, allowedExports = [], inspectExports = false, bannedHooks, banIntrinsicJsx } = optionsFirst(context);
+        const allowed = new Set([exportName, ...allowedExports]);
+        const bindings = exportsCollect(program);
+        for (const binding of bindings) {
+          if (!allowed.has(binding.exportedName)) {
             context.report({
               node: binding.node,
               messageId: "extraExport",
-              data: { expected: exportName, actual: binding.exportedName }
+              data: { expected: [...allowed].join("', '"), actual: binding.exportedName }
             });
           }
         }
         const banned = new Set(bannedHooks);
+        const inspected = new Set;
         for (const item of declarationsTopLevelUnexportedFunctions(program)) {
+          inspected.add(item.node.start);
           routesInspectFunction(context, item, banned, banIntrinsicJsx);
         }
+        if (!inspectExports)
+          return;
+        const names = new Set(bindings.filter((binding) => binding.exportedName === exportName).map((binding) => binding.localName ?? binding.exportedName));
+        const defaultExport = program.body.find((statement) => statement.type === "ExportDefaultDeclaration");
+        const declaration = defaultExport?.declaration;
+        const defaultFunctions = declaration?.type === "ArrowFunctionExpression" || declaration?.type === "FunctionExpression" ? [{ name: "default", node: declaration }] : [];
+        for (const item of [...exportsCollectFunctions(program), ...defaultFunctions]) {
+          if (names.has(item.name) && !inspected.has(item.node.start))
+            routesInspectFunction(context, item, banned, banIntrinsicJsx);
+        }
       }
     };
   }

package/dist/presets/index.d.ts

@@ -1,2 +1,4 @@
+export { default as reactModulesPreset } from './react-modules-preset.ts';
+export { default as nextReactModulesPreset } from './next-react-modules-preset.ts';
 export { default as tanstackStartReactModulesPreset } from './tanstack-start-react-modules-preset.ts';
-export type { PresetOptions, PresetArchitecture, PresetArchitectureEntry, PresetFolderLayout, PresetTanstackStartOptions, PresetLimitsOptions, PresetModulesOptions, PresetImportsOptions, PresetOrpcOptions, PresetSqlOptions, PresetFormsOptions, PresetReactOptions, PresetTestsOptions, PresetPolicyOptions, PresetPolicy, PresetPolicyName, PresetTailwindOptions, PresetShadcnOptions, } from '../types/preset.types.ts';
+export type { PresetOptions, PresetArchitecture, PresetArchitectureEntry, PresetFolderLayout, PresetFormattingOptions, PresetFramework, PresetNextOptions, PresetTanstackStartOptions, PresetLimitsOptions, PresetModulesOptions, PresetImportsOptions, PresetOrpcOptions, PresetSqlOptions, PresetFormsOptions, PresetReactOptions, PresetTestsOptions, PresetTestMockingApi, PresetTestMockingException, PresetTestMockingOptions, PresetTestMockingPreset, PresetPolicyOptions, PresetPolicy, PresetPolicyName, PresetTailwindOptions, PresetShadcnOptions, } from '../types/preset.types.ts';