@rm30/metro-config 0.1.0

package/README.md

@@ -0,0 +1,67 @@
+# @rm30/metro-config
+
+The shared Metro configuration for RM30's Expo apps.
+
+```sh
+pnpm add -D @rm30/metro-config
+```
+
+```js
+// apps/mobile/metro.config.cjs
+const { getDefaultConfig } = require('expo/metro-config')
+const { withRm30Metro } = require('@rm30/metro-config')
+
+module.exports = withRm30Metro(getDefaultConfig(__dirname), {
+  workspaceAliases: { '@myproject/types': '../../packages/types/src' },
+  uniwind: { cssEntryFile: './global.css', dtsFile: './src/uniwind-types.d.ts' },
+})
+```
+
+## Why the base config is passed in
+
+The projects do not agree on how the base config is made, and both ways are right:
+most call `getDefaultConfig` from `expo/metro-config`, while superwallet calls
+`getSentryExpoConfig` so Sentry can attach to the bundle. Creating the config inside this
+package would take that choice away, so it takes one instead.
+
+```js
+const { getSentryExpoConfig } = require('@sentry/react-native/metro')
+module.exports = withRm30Metro(getSentryExpoConfig(__dirname), { /* … */ })
+```
+
+## Options
+
+| Option | Default | |
+|---|---|---|
+| `projectRoot` | `config.projectRoot` | Throws if neither is set, rather than silently building paths from `undefined`. |
+| `workspaceAliases` | `{}` | Package name to path, absolute or relative to `projectRoot`. |
+| `blockList` | `[]` | Extra patterns, **added** to the built-in test-file ones. |
+| `platforms` | `ios, android, native, web` | |
+| `uniwind` | omitted | `{ cssEntryFile, dtsFile }`, or omitted/`false` to skip the wrapper. |
+
+## What it does for you
+
+- **Blocks test files from the bundle.** All three apps had their own copy of the same two
+  regexes.
+- **Adds every alias target to `watchFolders`.** Metro watches only the project root by
+  default, so a symlinked workspace package outside it is read once and never again —
+  edits to a shared package appear to do nothing until the bundler is restarted. This is
+  the single easiest thing to forget, which is why it is automatic here.
+- **Applies Uniwind outermost.** It has to be the last wrapper, and doing it by hand is
+  how it ends up in the wrong place.
+
+`watchFolders` are merged and de-duplicated, so passing an alias that is already watched
+is harmless.
+
+## Project-specific blocks stay in the project
+
+superpool blocks Hardhat's build output:
+
+```js
+blockList: [/[/\\]packages[/\\]contracts[/\\](cache|artifacts|coverage|typechain-types)[/\\].*/]
+```
+
+That is not shared policy — it exists because Metro watches the whole monorepo while
+Hardhat creates and deletes lock files under `packages/contracts/cache` during compilation,
+and a file vanishing mid-watch kills the watcher with `ENOENT`, taking the dev server down
+whenever contracts are compiled. Real variance, and it belongs where the reason lives.

package/index.cjs

@@ -0,0 +1,72 @@
+const path = require('node:path')
+
+/**
+ * Test files are never bundled. Every RM30 mobile app blocked these already,
+ * each with its own copy of the same two regexes.
+ */
+const TEST_FILE_PATTERNS = [/.*\.test\.(js|jsx|ts|tsx)$/, /.*\.spec\.(js|jsx|ts|tsx)$/]
+
+const DEFAULT_PLATFORMS = ['ios', 'android', 'native', 'web']
+
+/**
+ * Apply the shared RM30 Metro configuration.
+ *
+ * The base config is passed in rather than created here, because the projects do not
+ * agree on how it is made: most call `getDefaultConfig` from `expo/metro-config`, and
+ * superwallet calls `getSentryExpoConfig` so Sentry can attach. Both are valid, and
+ * wrapping either would take that choice away.
+ *
+ * @param {object} config  A Metro config from expo/metro-config or @sentry/react-native.
+ * @param {object} [options]
+ * @param {string} [options.projectRoot]  Defaults to `config.projectRoot`.
+ * @param {Record<string,string>} [options.workspaceAliases]
+ *   Package name to path, absolute or relative to `projectRoot`. Each alias target is
+ *   also added to `watchFolders`, so Metro reloads when the shared package changes —
+ *   forgetting that is the usual reason edits to a workspace package appear to do
+ *   nothing.
+ * @param {RegExp[]} [options.blockList]  Extra patterns, added to the test-file ones.
+ * @param {string[]} [options.platforms]
+ * @param {{cssEntryFile: string, dtsFile: string}|false} [options.uniwind]
+ *   Uniwind options, or false to skip the wrapper. Uniwind must be outermost, so this
+ *   function applies it last.
+ * @returns {object} The configured Metro config.
+ */
+function withRm30Metro(config, options = {}) {
+  const { projectRoot = config.projectRoot, workspaceAliases = {}, blockList = [], platforms = DEFAULT_PLATFORMS, uniwind } = options
+
+  if (!projectRoot) {
+    throw new Error('@rm30/metro-config: projectRoot is required when config.projectRoot is unset')
+  }
+
+  const resolved = Object.fromEntries(
+    Object.entries(workspaceAliases).map(([name, target]) => [name, path.isAbsolute(target) ? target : path.resolve(projectRoot, target)])
+  )
+
+  config.resolver = config.resolver ?? {}
+  config.resolver.alias = { ...config.resolver.alias, ...resolved }
+  config.resolver.blockList = [...TEST_FILE_PATTERNS, ...blockList]
+  config.resolver.platforms = platforms
+
+  // Metro only watches the project root by default; a symlinked workspace package
+  // outside it is read once and never again.
+  const watched = new Set([...(config.watchFolders ?? []), ...Object.values(resolved)])
+  config.watchFolders = [...watched]
+
+  if (uniwind === false || uniwind === undefined) return config
+
+  // Resolved from the consuming project, not from here. A bare require would look in
+  // this package's own directory, and under pnpm's symlinked store an optional peer is
+  // not present there — so it resolves only if something happened to hoist it.
+  let withUniwindConfig
+  try {
+    withUniwindConfig = require(require.resolve('uniwind/metro', { paths: [projectRoot] })).withUniwindConfig
+  } catch (cause) {
+    throw new Error(
+      `@rm30/metro-config: uniwind options were given but 'uniwind/metro' could not be resolved from ${projectRoot}. Install uniwind in that project, or pass uniwind: false.`,
+      { cause }
+    )
+  }
+  return withUniwindConfig(config, uniwind)
+}
+
+module.exports = { withRm30Metro, TEST_FILE_PATTERNS, DEFAULT_PLATFORMS }

package/index.d.ts

@@ -0,0 +1,26 @@
+export interface UniwindOptions {
+  cssEntryFile: string
+  dtsFile: string
+}
+
+export interface Rm30MetroOptions {
+  /** Defaults to `config.projectRoot`. */
+  projectRoot?: string
+  /** Package name to path, absolute or relative to `projectRoot`. Also watched. */
+  workspaceAliases?: Record<string, string>
+  /** Extra block patterns, added to the built-in test-file ones. */
+  blockList?: RegExp[]
+  /** Defaults to ios, android, native, web. */
+  platforms?: string[]
+  /** Uniwind options, or false/omitted to skip the wrapper. */
+  uniwind?: UniwindOptions | false
+}
+
+/** Metro's config object is untyped upstream; this mirrors that rather than inventing a shape. */
+// biome-ignore lint/suspicious/noExplicitAny: Metro does not ship a config type
+export type MetroConfig = any
+
+export declare function withRm30Metro(config: MetroConfig, options?: Rm30MetroOptions): MetroConfig
+
+export declare const TEST_FILE_PATTERNS: RegExp[]
+export declare const DEFAULT_PLATFORMS: string[]

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@rm30/metro-config",
+  "version": "0.1.0",
+  "description": "Shared RM30 Metro configuration for Expo monorepos.",
+  "license": "MIT",
+  "author": "Rafael Miziara",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rafamiziara/cli.git",
+    "directory": "packages/metro-config"
+  },
+  "keywords": ["metro", "expo", "react-native", "uniwind"],
+  "main": "./index.cjs",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.cjs"
+    }
+  },
+  "files": ["index.cjs", "index.d.ts", "README.md"],
+  "peerDependencies": {
+    "uniwind": ">=1.9.0"
+  },
+  "peerDependenciesMeta": {
+    "uniwind": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}