create-expo 5.0.0 → 5.1.0

package/build/Examples.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The partial GitHub content type, used to filter out examples.
+ * @see https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28
+ */
+export type GithubContent = {
+    name: string;
+    path: string;
+    type: 'file' | 'dir';
+};
+export type ExamplesMetadata = {
+    aliases: {
+        [key: string]: string | {
+            destination: string;
+            message?: string;
+        };
+    };
+    deprecated: {
+        [key: string]: {
+            outdatedExampleHref: string;
+            message?: string;
+        };
+    };
+};
+/** Fetch the metadata for the examples from https://github.com/expo/examples. This includes aliases and deprecated examples. */
+export declare function fetchMetadataAsync(): Promise<ExamplesMetadata>;
+export declare function ensureExampleExists(name: string): Promise<void>;
+/** Ask the user which example to create */
+export declare function promptExamplesAsync(): Promise<any>;
+/**
+ * Download and move the selected example from https://github.com/expo/examples.
+ *
+ * If the example ships a `.create-expo.json`, its `renamePatterns`
+ * field overrides the default rename config used by the HelloWorld
+ * find-and-replace pass. The config file is read once and deleted from disk
+ * immediately so it can never leak into the user's project.
+ */
+export declare function downloadAndExtractExampleAsync(root: string, name: string): Promise<void>;
+export declare function sanitizeScriptsAsync(root: string): Promise<void>;

package/build/Template.d.ts

@@ -0,0 +1,98 @@
+import ora from 'ora';
+import type { PackageManagerName } from './resolvePackageManager';
+export declare function isFolderNameForbidden(folderName: string): boolean;
+export declare function resolvePackageModuleId(moduleId: string): {
+    readonly type: "repository";
+    readonly uri: import("url").URL;
+} | {
+    readonly type: "file";
+    readonly uri: string;
+} | {
+    readonly type: "npm";
+    readonly uri: string;
+};
+/**
+ * Extract a template app to a given file path and clean up any properties left over from npm to
+ * prepare it for usage.
+ *
+ * If the template ships a `.create-expo.json`, its `renamePatterns`
+ * field overrides the default rename config used by the HelloWorld
+ * find-and-replace pass. The config file is read once and deleted from disk
+ * immediately so it can never leak into the user's project.
+ */
+export declare function extractAndPrepareTemplateAppAsync(projectRoot: string, { npmPackage }: {
+    npmPackage?: string | null;
+}): Promise<string>;
+/**
+ * # Background
+ *
+ * `@expo/cli` and `create-expo` extract a template from a tarball (whether from
+ * a local npm project or a GitHub repository), but these templates have a
+ * static name that needs to be updated to match whatever app name the user
+ * specified.
+ *
+ * By convention, the app name of all templates is "HelloWorld". During
+ * extraction, filepaths are transformed via `createEntryRenamer()` in
+ * `createFileTransform.ts`, but the contents of files are left untouched.
+ * Technically, the contents used to be transformed during extraction as well,
+ * but due to poor configurability, we've moved to a post-extraction approach.
+ *
+ * # The new approach: Renaming the app post-extraction
+ *
+ * In this new approach, we take a list of file patterns, otherwise known as the
+ * "rename config" to determine explicitly which files – relative to the root of
+ * the template – to perform find-and-replace on, to update the app name.
+ *
+ * ## The rename config
+ *
+ * The rename config can be passed directly as a string array to
+ * `getTemplateFilesToRenameAsync()`.
+ *
+ * The file patterns are formatted as glob expressions to be interpreted by
+ * [glob](https://github.com/isaacs/node-glob). Comments are supported with
+ * the `#` symbol, both in the plain-text file and string array formats.
+ * Whitespace is trimmed and whitespace-only lines are ignored.
+ *
+ * If no rename config has been passed directly to
+ * `getTemplateFilesToRenameAsync()`, then this default
+ * rename config will be used instead.
+ */
+export declare const defaultRenameConfig: readonly ["!**/node_modules", "app.json", "android/**/*.gradle", "android/app/BUCK", "android/app/src/**/*.java", "android/app/src/**/*.kt", "android/app/src/**/*.xml", "ios/Podfile", "ios/**/*.xcodeproj/project.pbxproj", "ios/**/*.xcodeproj/xcshareddata/xcschemes/*.xcscheme", "ios/**/*.xcworkspace/contents.xcworkspacedata", "macos/Podfile", "macos/**/*.xcodeproj/project.pbxproj", "macos/**/*.xcodeproj/xcshareddata/xcschemes/*.xcscheme", "macos/**/*.xcworkspace/contents.xcworkspacedata"];
+/**
+ * Returns a list of files within a template matched by the resolved rename
+ * config.
+ *
+ * The rename config is resolved in the order of preference:
+ * Config provided as function param > defaultRenameConfig
+ */
+export declare function getTemplateFilesToRenameAsync({ cwd, 
+/**
+ * An array of patterns following the rename config format. If omitted, then
+ * we fall back to defaultRenameConfig.
+ * @see defaultRenameConfig
+ */
+renameConfig: userConfig, }: {
+    cwd: string;
+    renameConfig?: string[];
+}): Promise<string[]>;
+export declare function renameTemplateAppNameAsync({ cwd, name, files, }: {
+    cwd: string;
+    name: string;
+    /**
+     * An array of files to transform. Usually provided by calling
+     * getTemplateFilesToRenameAsync().
+     * @see getTemplateFilesToRenameAsync
+     */
+    files: string[];
+}): Promise<void>;
+/**
+ * Sanitize a template (or example) with expected `package.json` properties and files.
+ */
+export declare function sanitizeTemplateAsync(projectRoot: string): Promise<void>;
+export declare function validateName(name?: string): string | true;
+export declare function logProjectReady({ cdPath, packageManager, }: {
+    cdPath: string;
+    packageManager: PackageManagerName;
+}): void;
+export declare function installPodsAsync(projectRoot: string): Promise<boolean>;
+export declare function logNewSection(title: string): ora.Ora;

package/build/__mocks__/fs.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__mocks__/ora.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/Examples.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/Template.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/configureWorkspaces.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/createAsync.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/createExpoConfig.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/createFileTransformer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/generateAgentFiles.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/promptSdkVersion.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/resolvePackageManager.test.d.ts

@@ -0,0 +1 @@
+export declare const asMock: <T extends (...args: any[]) => any>(fn: T) => jest.MockedFunction<T>;

package/build/__tests__/sanitizeTemplate.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/__tests__/telemetry.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/agent-files/AGENTS.md

@@ -0,0 +1,41 @@
+This is an Expo/React Native mobile application. Prioritize mobile-first patterns, performance, and cross-platform compatibility.
+
+## Expo has changed — do not trust your training data
+
+Expo ships breaking changes every SDK release. APIs you remember are likely renamed, moved, or removed. Before writing any code that touches an Expo, EAS, or React Native API:
+
+1. Read the major version of the `expo` package in `package.json`.
+2. Fetch the matching versioned docs: `https://docs.expo.dev/versions/v<major>.0.0/`
+3. For anything else, fetch https://docs.expo.dev/llms.txt — an index of all Expo docs with corrections to common LLM misconceptions. Follow its links to the specific page you need; never answer from memory.
+
+## Commands
+
+Use `bunx` instead of `npx` if the project uses bun (`bun.lock` present).
+
+```bash
+npx expo install <package>  # ALWAYS use instead of npm/yarn/pnpm/bun add — resolves SDK-compatible versions
+npx expo start              # start the dev server
+npx expo lint               # lint
+npx tsc --noEmit            # typecheck
+npx expo-doctor             # diagnose dependency and config issues
+npx expo install --fix      # fix incompatible package versions
+```
+
+Run lint and typecheck before declaring any task done.
+
+## Navigation & Routing
+
+- Use **Expo Router** for all navigation. Routes live in `src/app/` — every file there is a screen, `_layout.tsx` files define navigators. Keep non-route code (components, hooks, utils) outside `src/app/`.
+- Import `Link`, `router`, and `useLocalSearchParams` from `expo-router`.
+- Docs: https://docs.expo.dev/router/introduction.md
+
+## Building with EAS
+
+Use EAS to build, sign, and submit the app in the cloud (`eas build`, `eas submit`) and to ship over-the-air updates (`eas update`) — no local Xcode or Android Studio required. Run EAS CLI as `bunx eas-cli <command>` in Bun projects, or `npx eas-cli@latest <command>` otherwise; substitute that for bare `eas` in docs examples.
+Docs: https://docs.expo.dev/eas/index.md
+
+## Rules
+
+- If `ios/` and `android/` directories do not exist, they are generated (Continuous Native Generation). Never create or edit them by hand — configure native behavior in `app.json` and config plugins.
+- Expo Go only includes its bundled native modules. After adding a library with native code, the app needs a development build: `npx expo run:ios|android` locally, or `eas build --profile development`.
+- Prefer recommended Expo modules over third-party libraries, and check your available skills before adding dependencies. Docs: https://docs.expo.dev/versions/latest/index.md

package/build/agent-files/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

package/build/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/build/configureWorkspaces.d.ts

@@ -0,0 +1,9 @@
+import type { PackageManagerName } from './resolvePackageManager';
+export declare const PNPM_WORKSPACE_FILENAME = "pnpm-workspace.yaml";
+/**
+ * Normalize a monorepo template's workspace-package dependency specs to the
+ * chosen package manager's convention, and — for pnpm — write a
+ * `pnpm-workspace.yaml` listing the workspace packages so they're picked up
+ * regardless of the root `package.json` `workspaces` field.
+ */
+export declare function configureWorkspacesAsync(projectRoot: string, packageManager: PackageManagerName): Promise<void>;

package/build/createAsync.d.ts

@@ -0,0 +1,11 @@
+import type { PackageManagerName } from './resolvePackageManager';
+export type Options = {
+    install: boolean;
+    template?: string | true;
+    example?: string | true;
+    yes: boolean;
+    agentsMd: boolean;
+};
+export declare function setupDependenciesAsync(projectRoot: string, props: Pick<Options, 'install'>): Promise<void>;
+export declare function createAsync(inputPath: string, options: Options): Promise<void>;
+export declare function logNodeInstallWarning(cdPath: string, packageManager: PackageManagerName, needsPods: boolean): void;

package/build/createExpoConfig.d.ts

@@ -0,0 +1,38 @@
+export declare const CREATE_EXPO_CONFIG_NAME = ".create-expo.json";
+/**
+ * Per-template configuration for customized behavior in `create-expo`.
+ * Templates that need any of these knobs can ship a
+ * `.create-expo.json` file at the template root; it is read once at
+ * project creation time and then deleted from the user's project so it
+ * doesn't leak into their repo.
+ */
+export interface CreateExpoConfig {
+    /**
+     * Glob patterns (relative to the project root) listing extra files that
+     * should be passed through the `HelloWorld` find-and-replace pass during
+     * project creation. When present, this REPLACES the default rename config
+     * (see Template.ts `defaultRenameConfig`) — useful for monorepo templates
+     * that need to reach inside per-app paths like `apps/*\/android/**\/build.gradle`.
+     */
+    renamePatterns?: string[];
+}
+/**
+ * Read `.create-expo.json` from the project root and immediately
+ * delete the file from disk so it doesn't leak into the user's project.
+ * Returns the parsed config (or `undefined` if there's no file / it's
+ * malformed). This is the "use it once" entry point that template-extraction
+ * code paths should call — every downstream consumer takes the parsed
+ * object in memory.
+ */
+export declare function consumeMonorepoConfigAsync(projectRoot: string): Promise<CreateExpoConfig | undefined>;
+/**
+ * Reads `.create-expo.json` from the project root without touching
+ * the file. Returns `undefined` if the file is missing, unreadable, or
+ * malformed — a missing file is the common case (single-app templates) and
+ * shouldn't warn.
+ *
+ * Prefer `consumeMonorepoConfigAsync` for the create-expo flow so the
+ * template-only config doesn't leak into the user's project. This function
+ * stays exported for tests and any other read-only callers.
+ */
+export declare function loadMonorepoConfigAsync(projectRoot: string): Promise<CreateExpoConfig | undefined>;

package/build/createFileTransform.d.ts

@@ -0,0 +1,5 @@
+import { TarTypeFlag } from 'multitars';
+import picomatch from 'picomatch';
+export declare function sanitizedName(name: string): string;
+export declare function createEntryRenamer(name: string): (input: string, typeflag: TarTypeFlag) => string;
+export declare function createGlobFilter(globPattern: picomatch.Glob, options?: picomatch.PicomatchOptions): (path: string) => boolean;

package/build/error.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A custom error class that is used to surface a `process.exit` event to a higher
+ * level where it can be tracked through telemetry asynchronously, before exiting.
+ */
+export declare class ExitError extends Error {
+    cause: string | Error;
+    code: number;
+    constructor(cause: string | Error, code: number);
+}

package/build/generateAgentFiles.d.ts

@@ -0,0 +1 @@
+export declare function generateAgentFiles(root: string): Promise<void>;

package/build/index.d.ts

@@ -0,0 +1 @@
+export {};