refactor(eslint-rules): split consistent-base-hook into base-hook-signature + base-hook-no-forbidden-runtime

packages/eslint-plugin/src/internal.js

@@ -35,6 +35,8 @@ const __internal = {
           /** @type {import('eslint').Linter.RulesRecord} */
           rules: {
             '@nx/workspace-consistent-callback-type': 'error',
+            '@nx/workspace-base-hook-signature': 'error',
+            '@nx/workspace-base-hook-no-forbidden-runtime': 'error',
             '@nx/workspace-no-restricted-globals': restrictedGlobals.react,
             '@nx/workspace-no-missing-jsx-pragma': ['error', { runtime: 'automatic' }],
           },

packages/react-components/react-tags/library/src/components/TagGroup/useTagGroup.ts

@@ -27,6 +27,7 @@ type UseTagGroupBaseOptions = {
  * @param props - props from this instance of TagGroup (without appearance, size)
  * @param ref - reference to root HTMLDivElement of TagGroup
  */
+// eslint-disable-next-line @nx/workspace-base-hook-signature -- accepts an extra `options` arg used internally by `useTagGroup_unstable` to coordinate focus after a tag is dismissed
 export const useTagGroupBase_unstable = (
   props: TagGroupBaseProps,
   ref: React.Ref<HTMLDivElement>,

tools/eslint-rules/index.ts

@@ -4,6 +4,11 @@ import {
   RULE_NAME as consistentCallbackTypeName,
   rule as consistentCallbackType,
 } from './rules/consistent-callback-type';
+import { RULE_NAME as baseHookSignatureName, rule as baseHookSignature } from './rules/base-hook-signature';
+import {
+  RULE_NAME as baseHookNoForbiddenRuntimeName,
+  rule as baseHookNoForbiddenRuntime,
+} from './rules/base-hook-no-forbidden-runtime';
 
 /**
  * Import your custom workspace rules at the top of this file.
@@ -32,6 +37,8 @@ module.exports = {
    */
   rules: {
     [consistentCallbackTypeName]: consistentCallbackType,
+    [baseHookSignatureName]: baseHookSignature,
+    [baseHookNoForbiddenRuntimeName]: baseHookNoForbiddenRuntime,
     [noRestrictedGlobalsName]: noRestrictedGlobals,
     [noMissingJsxPragmaName]: noMissingJsxPragma,
   },

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/src/dummy.ts

@@ -0,0 +1,4 @@
+// Placeholder so the tsconfig has an actual file to anchor the project.
+// RuleTester test cases reference filenames inside this directory but their
+// content comes from the inline `code` field.
+export const dummy = 1;

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/src/test.ts

@@ -0,0 +1,4 @@
+// Placeholder anchor for typed RuleTester cases. The actual code being linted
+// comes from each test's inline `code` field; this file just needs to exist so
+// that the fixture tsconfig's Program contains the filename used by tests.
+export {};

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/stubs/cyclic-pkg/a.ts

@@ -0,0 +1,5 @@
+import { useB } from './b';
+
+export function useA(): number {
+  return useB() + 1;
+}

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/stubs/cyclic-pkg/b.ts

@@ -0,0 +1,6 @@
+import { useA } from './a';
+
+export function useB(): number {
+  // Pretend lazy ref to break true cycle at runtime; the static graph is cyclic.
+  return (useA as unknown as () => number).length;
+}

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/stubs/cyclic-pkg/index.ts

@@ -0,0 +1,3 @@
+// Cyclic re-export — exercises the cycle-safety of the transitive walk.
+export { useA } from './a';
+export { useB } from './b';

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/stubs/heavy-runtime/index.ts

@@ -0,0 +1,5 @@
+export function runHeavy(): { tag: 'heavy' } {
+  return { tag: 'heavy' };
+}
+
+export type HeavyOptions = { kind: 'heavy' };

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/stubs/light-helper/index.ts

@@ -0,0 +1,3 @@
+export function runLight(_opts?: { mode: 'light' }): void {
+  /* noop */
+}

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/stubs/watched-pkg/heavy.ts

@@ -0,0 +1,7 @@
+import { runHeavy } from 'heavy-runtime';
+
+export type HeavyType = { tag: 'heavy' };
+
+export function useHeavy(): HeavyType {
+  return runHeavy();
+}

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/stubs/watched-pkg/index.ts

@@ -0,0 +1,9 @@
+import type { HeavyType } from './heavy';
+
+export { useHeavy } from './heavy';
+export { useLight } from './light';
+export type { LightOptions } from './light';
+// Re-export of a type-only thing from the heavy module — must not count as a runtime reach.
+export type { HeavyType } from './heavy';
+
+export type HeavyWrapper = { tag: 'heavy-wrapper'; inner: HeavyType };

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/stubs/watched-pkg/light.ts

@@ -0,0 +1,7 @@
+import { runLight } from 'light-helper';
+
+export type LightOptions = { mode: 'light' };
+
+export function useLight(opts?: LightOptions): void {
+  runLight(opts);
+}

tools/eslint-rules/rules/__fixtures__/base-hook-no-forbidden-runtime/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "lib": ["ES2022", "DOM"],
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "noEmit": true,
+    "baseUrl": ".",
+    "paths": {
+      "watched-pkg": ["./stubs/watched-pkg/index.ts"],
+      "watched-pkg/*": ["./stubs/watched-pkg/*"],
+      "heavy-runtime": ["./stubs/heavy-runtime/index.ts"],
+      "light-helper": ["./stubs/light-helper/index.ts"],
+      "cyclic-pkg": ["./stubs/cyclic-pkg/index.ts"]
+    }
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx", "stubs/**/*.ts"]
+}

tools/eslint-rules/rules/__fixtures__/base-hook-signature/src/components/Sibling/useSiblingBase.ts

@@ -0,0 +1,3 @@
+export const useSiblingBase_unstable = (props: { a: number }, ref: React.Ref<HTMLElement>) => {
+  return { props, ref };
+};