create-expo - npm Package Compare versions

Comparing version 2.1.4 to 2.2.0

package.json

 {
   "name": "create-expo",
-  "version": "2.1.4",
+  "version": "2.2.0",
   "bin": "./build/index.js",
@@ -37,5 +37,5 @@ "main": "build",
   "devDependencies": {
-    "@expo/json-file": "8.3.0",
-    "@expo/package-manager": "^1.1.1",
-    "@expo/spawn-async": "^1.7.0",
+    "@expo/json-file": "8.3.2",
+    "@expo/package-manager": "^1.4.0",
+    "@expo/spawn-async": "^1.7.2",
     "@types/debug": "^4.1.7",
@@ -45,2 +45,3 @@ "@types/getenv": "^1.0.0",
     "@types/node-fetch": "^2.5.8",
+    "@types/picomatch": "^2.3.3",
     "@types/prompts": "2.0.14",
@@ -53,6 +54,7 @@ "@types/tar": "^6.1.2",
     "expo-module-scripts": "^3.0.0",
+    "fast-glob": "^3.3.2",
     "getenv": "^1.0.0",
-    "minipass": "^3.3.6",
     "node-fetch": "^2.6.7",
     "ora": "3.4.0",
+    "picomatch": "^2.3.1",
     "prompts": "^2.4.2",
@@ -62,3 +64,3 @@ "tar": "6.1.13",
   },
-  "gitHead": "4f3dcf3e23eae997f884117fdd34ad734efad9fd"
+  "gitHead": "4165b8d72e1b9a1889c2767534cc619e21468110"
 }

README.md

@@ -35,15 +35,90 @@ <!-- Title -->
 ```sh
-# With NPM
+# Usage for bun, npm, pnpm, and yarn
 npx create-expo
-
-# With Yarn
+bun create expo
+pnpm create expo
 yarn create expo
 
-# With pnpm
-pnpm create expo
+# Output help information with all available options
+npx create-expo --help
+```
 
-# With Bun
-bunx create-expo
+Once you're up and running with Create Expo App, visit [this tutorial](https://docs.expo.dev/tutorial/planning/) for more information on building mobile apps with React.
+
+## Templates
+
+Create Expo App prepares an empty Expo project by default. You can choose to use a project with more prepared functionality. For that, you can start Create Expo App with the `--template` flag.
+
+```sh
+# Pick from Expo's templates
+npx create-expo --template
+
+# Pick the expo-template-tabs template
+npx create-expo --template tabs
 ```
 
-Once you're up and running with Create Expo App, visit [this tutorial](https://docs.expo.dev/tutorial/planning/) for more information on building mobile apps with React.
+### npm templates
+
+Expo publishes all [templates](../../templates/) through npm packages, versioned by Expo SDK. You can create your own npm templates with `npm pack`, or by publishing to npm.
+
+```sh
+# Create from npm
+npx create-expo --template tabs # Short for expo-template-tabs
+npx create-expo --template expo-template-tabs
+
+# Create from npm using a semver of the template
+npx create-expo --template expo-template-blank@50
+
+# Create from local tarball created with `npm pack`
+npx create-expo --template ./path/to/template.tgz
+```
+
+#### Private npm registry
+
+Create Expo App does not support private registries. In order to use a private template, use the local tarball option.
+
+### GitHub templates
+
+Besides the templates provided by Expo, you can also create your own or use a 3rd party template directly from GitHub. The `--template` flag supports GitHub URLs, including branch, tag, or even specific commit.
+
+```sh
+# Create from repository
+npx create-expo --template https://github.com/:owner/:repo
+
+# Create from repository using the `:ref` branch or tag
+npx create-expo --template https://github.com/:owner/:repo/tree/:ref
+
+# Create from repository using the `sdk-50` branch, and "templates/expo-template-bare-minimum" subdirectory
+npx create-expo --template https://github.com/expo/expo/tree/sdk-50/templates/expo-template-bare-minimum
+```
+
+## App name customization
+
+Create Expo App customizes the name of the created app by replacing certain placeholder values in the template with the name specified by the user. Most users won't have to think about this process, but it may be relevant for users offering their own templates.
+
+Renaming the app is a two-step process:
+
+1. while unpacking the template, the file and folder names are rewritten
+2. after unpacking the template, the file contents are rewritten
+
+By convention, Expo templates use several placeholder values to be searched for and replaced:
+
+- `Hello App Display Name` → The name of the project, without modifications (example [Android](../../templates/expo-template-bare-minimum/android/app/src/main/res/values/strings.xml#L2))
+- `HelloWorld` → The name of the project with sanitization as described below (example [Android](../../templates/expo-template-bare-minimum//android/settings.gradle#L1), [iOS](../../templates/expo-template-bare-minimum/ios/Podfile#L16))
+- `helloworld` → The _lower-cased_ name of the project with sanitization as described below (example [Android](../../templates/expo-template-bare-minimum/android/app/build.gradle#L86))
+
+Although all file and folder names are rewritten, only files specified by the "rename config" have their contents rewritten. This is determined by the `defaultRenameConfig` constant in [./src/Template.ts](./src/Template.ts).
+
+### Sanitization
+
+Some characters aren't allowed in certain places, that's why Create Expo App applies sanitization to the project name.
+
+- Remove all non-word `\W` and underscore `_` characters.
+- Normalize the string using Unicode's normalization form "canonical composition" or `NFD`.
+- Remove all accent characters `u0300-u036f`.
+
+## Special files
+
+Due to some limitations with `npm pack`, some files are handled differently.
+
+- `gitignore` → Renamed to `.gitignore` due to `npm pack` skipping `.gitignore` files, see [npm/npm#1862](https://github.com/npm/npm/issues/1862)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1260385

increased by4.57%

Lines of code

2893

increased by7.47%

Number of lines in readme file

124

increased by153.06%

Worsened metrics

Dev dependency count

23

increased by9.52%

No dependency changes