create-expo - npm Package Compare versions

Comparing version 0.0.1-canary-20240406-a4950c7 to 0.0.1-canary-20240411-33a7dc1

package.json

 {
   "name": "create-expo",
-  "version": "0.0.1-canary-20240406-a4950c7",
+  "version": "0.0.1-canary-20240411-33a7dc1",
   "bin": "./build/index.js",
@@ -37,4 +37,4 @@ "main": "build",
   "devDependencies": {
-    "@expo/json-file": "0.0.1-canary-20240406-a4950c7",
-    "@expo/package-manager": "0.0.1-canary-20240406-a4950c7",
+    "@expo/json-file": "0.0.1-canary-20240411-33a7dc1",
+    "@expo/package-manager": "0.0.1-canary-20240411-33a7dc1",
     "@expo/spawn-async": "^1.7.2",
@@ -52,5 +52,5 @@ "@types/debug": "^4.1.7",
     "debug": "^4.3.4",
-    "expo-module-scripts": "0.0.1-canary-20240406-a4950c7",
+    "expo-module-scripts": "0.0.1-canary-20240411-33a7dc1",
+    "fast-glob": "^3.3.2",
     "getenv": "^1.0.0",
-    "minipass": "^3.3.6",
     "node-fetch": "^2.6.7",
@@ -63,3 +63,3 @@ "ora": "3.4.0",
   },
-  "gitHead": "a4950c79a9191c7e8162b9529dd0858da19a8b79"
+  "gitHead": "33a7dc1ce3283426fd553cd6675d0540214ab902"
 }

README.md

@@ -94,10 +94,19 @@ <!-- Title -->
 
-## Placeholders
+## App name customization
 
-Create Expo App uses various placeholder values to customize the name of the projects. These placeholders are replaced with their actual value when unpacking the template, and applies to folder names and file contents.
+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.
 
-- `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))
+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
@@ -111,3 +120,3 @@
 
-### Special files
+## Special files
 
@@ -117,5 +126,1 @@ 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)
-
-### Binary files
-
-Placeholder replacements only apply to non-binary files and folder names during unpacking. [These extensions](./src/createFileTransform.ts#L57) are left as-is without any modifications due to possible corrupting binary files.

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

1260886

increased by4.01%

Lines of code

2895

increased by7.34%

Number of lines in readme file

124

increased by4.2%

No dependency changes