@sanity/pkg-utils 6.9.4-canary.0 → 6.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "6.9.4-canary.0",
+  "version": "6.10.0",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -125,8 +125,8 @@
     "@types/semver": "^7.5.8",
     "@types/treeify": "^1.0.3",
     "@types/uuid": "^9.0.8",
-    "@typescript-eslint/eslint-plugin": "^7.13.0",
-    "@typescript-eslint/parser": "^7.13.0",
+    "@typescript-eslint/eslint-plugin": "^7.13.1",
+    "@typescript-eslint/parser": "^7.13.1",
     "browserslist-to-esbuild": "2.1.1",
     "commitizen": "^4.3.0",
     "cpx": "^1.5.0",
@@ -146,7 +146,7 @@
     "typescript": "5.4.5",
     "vitest": "^1.6.0",
     "vitest-github-actions-reporter": "^0.11.1",
-    "@sanity/pkg-utils": "6.9.4-canary.0"
+    "@sanity/pkg-utils": "6.10.0"
   },
   "peerDependencies": {
     "typescript": "5.4.x"

package/src/node/core/config/types.ts

@@ -71,20 +71,105 @@ export interface TSDocCustomTag {
   allowMultiple?: boolean
 }
 
+/**
+ * Until these types are on npm: https://github.com/facebook/react/blob/2ba462b665bb4691067e67db3cfbffc56959b788/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts#L34-L120
+ * @alpha
+ */
+export interface ReactCompilerOptions {
+  logger?: ReactCompilerLogger | null
+
+  panicThreshold?: 'ALL_ERRORS' | 'CRITICAL_ERRORS' | 'NONE'
+
+  compilationMode?: 'infer' | 'syntax' | 'annotation' | 'all'
+
+  /*
+   * If enabled, Forget will import `useMemoCache` from the given module
+   * instead of `react/compiler-runtime`.
+   *
+   * ```
+   * // If set to "react-compiler-runtime"
+   * import {c as useMemoCache} from 'react-compiler-runtime';
+   * ```
+   */
+  runtimeModule?: string | null | undefined
+
+  /**
+   * By default React Compiler will skip compilation of code that suppresses the default
+   * React ESLint rules, since this is a strong indication that the code may be breaking React rules
+   * in some way.
+   *
+   * Use eslintSuppressionRules to pass a custom set of rule names: any code which suppresses the
+   * provided rules will skip compilation. To disable this feature (never bailout of compilation
+   * even if the default ESLint is suppressed), pass an empty array.
+   */
+  eslintSuppressionRules?: Array<string> | null | undefined
+
+  sources?: Array<string> | ((filename: string) => boolean) | null
+}
+
+/**
+ * @alpha
+ * Represents 'events' that may occur during compilation. Events are only
+ * recorded when a logger is set (through the config).
+ * These are the different types of events:
+ * CompileError:
+ *   Forget skipped compilation of a function / file due to a known todo,
+ *   invalid input, or compiler invariant being broken.
+ * CompileSuccess:
+ *   Forget successfully compiled a function.
+ * PipelineError:
+ *   Unexpected errors that occurred during compilation (e.g. failures in
+ *   babel or other unhandled exceptions).
+ */
+export type ReactCompilerLoggerEvent =
+  | {
+      kind: 'CompileError'
+      fnLoc: unknown
+      detail: unknown
+    }
+  | {
+      kind: 'CompileDiagnostic'
+      fnLoc: unknown
+      detail: unknown
+    }
+  | {
+      kind: 'CompileSuccess'
+      fnLoc: unknown
+      fnName: string | null
+      memoSlots: number
+      memoBlocks: number
+      memoValues: number
+      prunedMemoBlocks: number
+      prunedMemoValues: number
+    }
+  | {
+      kind: 'PipelineError'
+      fnLoc: unknown
+      data: string
+    }
+
+/**
+ * @alpha
+ */
+export type ReactCompilerLogger = {
+  logEvent: (filename: string | null, event: ReactCompilerLoggerEvent) => void
+}
+
 /** @public */
 export interface PkgConfigOptions {
   /** @alpha */
   babel?: {
     plugins?: BabelPluginItem[] | null | undefined
     /** @alpha */
-    reactCompiler?:
-      | boolean
-      | {
-          compilationMode: 'infer' | 'annotation' | 'all'
-          panicThreshold: 'all_errors' | 'critical_errors' | 'none'
-          sources?: Array<string> | ((filename: string) => boolean) | null
-        }
+    reactCompiler?: boolean
   }
+  /**
+   * Configure the React Compiler.
+   * To enable it, either:
+   * - set `babel.reactCompiler` to `true`
+   * - add a `react-compiler` export condition,  before any `browser`, `require` or `import` conditions. After any `react-server` and `node` conditions
+   * @alpha */
+  reactCompilerOptions?: ReactCompilerOptions
   bundles?: PkgBundle[]
   /** @alpha */
   define?: Record<string, string | number | boolean | undefined | null>

package/src/node/tasks/rollup/resolveRollupConfig.ts

@@ -102,16 +102,7 @@ export function resolveRollupConfig(
         presets: ['@babel/preset-typescript'],
         babelHelpers: 'bundled',
         extensions: ['.ts', '.tsx', '.js', '.jsx'],
-        plugins: [
-          [
-            'babel-plugin-react-compiler',
-            {
-              ...(typeof config?.babel?.reactCompiler === 'object'
-                ? config?.babel?.reactCompiler
-                : {}),
-            },
-          ],
-        ],
+        plugins: [['babel-plugin-react-compiler', config?.reactCompilerOptions || {}]],
       }),
     esbuild({
       jsx: config?.jsx ?? 'automatic',