create-eas-build-function 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +2 -3
  2. package/build/index.js +10 -10
  3. package/package.json +4 -1
  4. package/templates/javascript/README.md +8 -9
  5. package/templates/typescript/README.md +8 -10
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-eas-build-function",
3
- "version": "0.0.4",
3
+ "version": "0.0.5",
4
4
  "bin": {
5
5
  "create-eas-build-function": "./build/index.js"
6
6
  },
@@ -32,6 +32,9 @@
32
32
  "build": "ncc build ./src/index.ts -o build/ --minify --no-cache --no-source-map-register",
33
33
  "clean": "rimraf ./build/"
34
34
  },
35
+ "dependencies": {
36
+ "@expo/steps": "1.0.30"
37
+ },
35
38
  "devDependencies": {
36
39
  "@expo/package-manager": "^1.0.2",
37
40
  "@jest/globals": "^29.6.2",
package/templates/javascript/README.md CHANGED
@@ -1,13 +1,14 @@
1
- # EAS Build custom function
1
+ # My EAS Build function
2
2
 
3
- This is an EAS Build custom written in JavaScript.
3
+ This is an EAS Build function written in JavaScript. It can be used as a step in a [custom build](https://docs.expo.dev/preview/custom-build-config/).
4
4
 
5
5
  ## How to use it
6
6
 
7
- 1. Install dependencies using the package manager of your choice (npm, yarn, etc.) by running the `install` command.
7
+ 1. Install dependencies: `npm install`.
8
8
  2. Implement your function in `src/index.js`.
9
- 3. Build your function using the `yarn build` command. **The [`ncc` tool](https://github.com/vercel/ncc) is required to perform this operation**. If you don't have it installed, you can install it by running `npm install -g @vercel/ncc`.
10
- 4. Use it in the custom build YAML config. For example:
9
+ 3. Install [`ncc`](https://github.com/vercel/ncc) if not yet installed: `npm install -g @vercel/ncc`.
10
+ 4. Compile the function with `ncc` by running `npm run build`. Ensure that the `build` directory is not ignored by `.gitignore` / `.easignore`, it must be included in the [archive uploaded when running `eas build`](https://expo.fyi/eas-build-archive).
11
+ 5. Use the function in a custom build YAML config. For example:
11
12
 
12
13
  ```yml
13
14
  build:
@@ -25,11 +26,9 @@ This is an EAS Build custom written in JavaScript.
25
26
  functions:
26
27
  my_function:
27
28
  name: my-function
28
- path: path/to/my/function/module
29
+ path: ./my-function # The path is resolved relative to this config file.
29
30
  ```
30
31
 
31
- 5. Make sure that the `build` directory is not ignored in your `.gitignore` or `.easignore` file, so it can be used by the custom build process.
32
-
33
32
  ## Learn more
34
33
 
35
- Visit the [EAS Build custom builds documentation](https://docs.expo.dev/preview/custom-build-config/) to learn more about EAS Build custom functions.
34
+ Refer to the [custom builds documentation](https://docs.expo.dev/preview/custom-build-config/).
package/templates/typescript/README.md CHANGED
@@ -1,13 +1,14 @@
1
- # EAS Build custom function
1
+ # My EAS Build function
2
2
 
3
- This is an EAS Build custom written in TypeScript.
3
+ This is an EAS Build function written in TypeScript. It can be used as a step in a [custom build](https://docs.expo.dev/preview/custom-build-config/).
4
4
 
5
5
  ## How to use it
6
6
 
7
- 1. Install dependencies using the package manager of your choice (npm, yarn, etc.) by running the `install` command.
7
+ 1. Install dependencies: `npm install`.
8
8
  2. Implement your function in `src/index.ts`.
9
- 3. Build your function using the `yarn build` command. **The [`ncc` tool](https://github.com/vercel/ncc) is required to perform this operation**. If you don't have it installed, you can install it by running `npm install -g @vercel/ncc`.
10
- 4. Use it in the custom build YAML config. For example:
9
+ 3. Install [`ncc`](https://github.com/vercel/ncc) if not yet installed: `npm install -g @vercel/ncc`.
10
+ 4. Compile the function with `ncc` by running `npm run build`. Ensure that the `build` directory is not ignored by `.gitignore` / `.easignore`, it must be included in the [archive uploaded when running `eas build`](https://expo.fyi/eas-build-archive).
11
+ 5. Use the function in a custom build YAML config. For example:
11
12
 
12
13
  ```yml
13
14
  build:
@@ -25,11 +26,8 @@ This is an EAS Build custom written in TypeScript.
25
26
  functions:
26
27
  my_function:
27
28
  name: my-function
28
- path: path/to/my/function/module
29
+ path: ./my-function # The path is resolved relative to this config file.
29
30
  ```
30
-
31
- 5. Make sure that the `build` directory is not ignored in your `.gitignore` or `.easignore` file, so it can be used by the custom build process.
32
-
33
31
  ## Learn more
34
32
 
35
- Visit the [EAS Build custom builds documentation](https://docs.expo.dev/preview/custom-build-config/) to learn more about EAS Build custom functions.
33
+ Refer to the [custom builds documentation](https://docs.expo.dev/preview/custom-build-config/).