expo-module-scripts 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+## Unpublished
+
+### 🛠 Breaking changes
+
+### 🎉 New features
+
+### 🐛 Bug fixes
+
+### 💡 Others
+
+## 2.1.0 — 2022-08-04
+
+### 🎉 New features
+
+- Add `templates/scripts/source-login-scripts.sh` vendoring tool for node binary resolution in Xcode build phases scripts. ([#15336](https://github.com/expo/expo/pull/15336) by [@kudo](https://github.com/kudo))
+
+### 🐛 Bug fixes
+
+- Fixed `source-login-scripts.sh` error when `extendedglob` is enabled in zsh config. ([#17024](https://github.com/expo/expo/pull/17024) by [@kudo](https://github.com/kudo))
+- Fixed `expo-module prepare` error if target packages contain temporary kotlin build files. ([#17023](https://github.com/expo/expo/pull/17023) by [@kudo](https://github.com/kudo))
+- Improved support of nvm sourcing in iOS shell scripts. ([#17109](https://github.com/expo/expo/pull/17109) by [@liamronancb](https://github.com/liamronancb))
+- Fixed `source-login-scripts.sh` ~/zlogin typo. ([#17622](https://github.com/expo/expo/pull/17622) by [@vrgimael](https://github.com/vrgimael))
+- Deprecated the unreliable `source-login-scripts.sh` and sourcing the Node.js binary path from `.xcode.env` and `.xcode.env.local`. ([#18330](https://github.com/expo/expo/pull/18330) by [@kudo](https://github.com/kudo))
+
+### 💡 Others
+
+- Updated `@testing-library/react-hooks` to version `7.0.1`. ([#14552](https://github.com/expo/expo/pull/14552)) by [@Simek](https://github.com/Simek))

package/README.md

@@ -54,8 +54,8 @@ Add the following scripts to your `package.json` and run `yarn`
 
 Running `yarn` will now run the `prepare` script, which generates any missing files:
 
-- [`.eslintrc.js`](./templates/.eslintrc.js) ([docs](https://eslint.org/docs/user-guide/configuring)) this extends [`eslint-config-universe`](https://github.com/expo/expo/tree/master/packages/eslint-config-universe).
-  - Optionally you can customize Prettier too: [.prettierrc guide](https://github.com/expo/expo/tree/master/packages/eslint-config-universe#customizing-prettier).
+- [`.eslintrc.js`](./templates/.eslintrc.js) ([docs](https://eslint.org/docs/user-guide/configuring)) this extends [`eslint-config-universe`](https://github.com/expo/expo/tree/main/packages/eslint-config-universe).
+  - Optionally you can customize Prettier too: [.prettierrc guide](https://github.com/expo/expo/tree/main/packages/eslint-config-universe#customizing-prettier).
 - [`.npmignore`](./templates/.npmignore) ([docs](https://docs.npmjs.com/misc/developers)) currently only ignores the `babel.config.js` in your module. You might also want to also add tests and docs.
   - Expo modules use `.npmignore` **instead of** the `files` field in the `package.json`.
   - (Pro Tip) Test which files get packaged by running `npm pack`. If you see files that aren't crucial to running the module, you should add them to `.npmignore`.
@@ -65,11 +65,13 @@ Running `yarn` will now run the `prepare` script, which generates any missing fi
   - Try and incorporate a table of contents (TOC).
 - [`tsconfig.json`](./templates/tsconfig.json) ([docs](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)) extends [`tsconfig.base.json`](./tsconfig.base.json) this is important for ensuring all Unimodules use the same version of TypeScript.
 
-You should also add the following fields to your `package.json`:
+Besides, running `yarn prepare` script will also synchronize optional files from `expo-module-scripts` when the file is present and contains the `@generated` pattern:
+
+- [`with-node.sh`](./templates/scripts/with-node.sh): An Xcode build phase script helper for Node.js binary resolution. It sources the project's **.xcode.env** and **.xcode.env.local** files, which may define an environment variable named `NODE_BINARY` to specify the file path of the Node.js binary to run.
 
 ### 🔌 Config Plugin
 
-To create a [config plugin](https://github.com/expo/expo-cli/blob/master/packages/config-plugins/README.md) that automatically configures your native code, you have two options:
+To create a [config plugin](https://github.com/expo/expo-cli/blob/main/packages/config-plugins/README.md) that automatically configures your native code, you have two options:
 
 1. Create a `plugin` folder and write your plugin in TypeScript (recommended).
 2. Create an `app.plugin.js` file in the project root and write the plugin in pure Node.js-compliant JavaScript.
@@ -91,7 +93,7 @@ The following files are required for a TypeScript plugin:
     ╰── src/index.ts ➡️ The TypeScript entry point for your plugin
 ```
 
-Create a `app.config.js` (the entry point for a config plugin):
+Create an `app.plugin.js` (the entry point for a config plugin):
 
 ```js
 module.exports = require('./plugin/build');
@@ -142,14 +144,14 @@ Use the following scripts to interact with the plugin:
 
 ### 🤡 Jest
 
-The Jest preset extends [`jest-expo`](https://github.com/expo/expo/tree/master/packages/jest-expo) or [`jest-expo-enzyme`](https://github.com/expo/expo/tree/master/packages/jest-expo-enzyme) and adds proper TypeScript support and type declarations to the presets.
+The Jest preset extends [`jest-expo`](https://github.com/expo/expo/tree/main/packages/jest-expo) or [`jest-expo-enzyme`](https://github.com/expo/expo/tree/main/packages/jest-expo-enzyme) and adds proper TypeScript support and type declarations to the presets.
 
 **For unit testing API-based modules:**
 
 ```json
 {
   "jest": {
-    "preset": "expo-module-scripts/universal"
+    "preset": "expo-module-scripts"
   }
 }
 ```
@@ -286,7 +288,7 @@ One of the rules enforced is restricting any imports from the `fbjs` library. As
 Replacements for common `fbjs` uses-cases are listed below:
 
 - `invariant`- replace with [`invariant`](https://www.npmjs.com/package/invariant)
-- `ExecutionEnvironment`- replace with [`Platform` from `@unimodules/core`](https://github.com/expo/expo/blob/master/packages/%40unimodules/react-native-adapter/src/Platform.ts)
+- `ExecutionEnvironment`- replace with [`Platform` from `@unimodules/core`](https://github.com/expo/expo/blob/main/packages/%40unimodules/react-native-adapter/src/Platform.ts)
 
 #### lint plugin
 

package/bin/expo-module-configure

@@ -6,11 +6,71 @@ script_dir="$(dirname "$0")"
 
 shopt -s dotglob
 
+# an optional template file will be synced only if the target file is present in the file system,
+# and its content contains the string `@generated`.
+OPTIONAL_TEMPLATE_FILES=(
+  # add a relative file path from `templates/` for each new optional file
+  "scripts/with-node.sh"
+)
+
+# returns relative file paths inside a given directory without the leading "./".
+# usage: get_relative_files "/path/to/dir"
+get_relative_files() {
+  pushd $1 > /dev/null
+  local files=$(find . -type f | cut -c 3-)
+  popd > /dev/null
+  echo $files
+}
+
+
+# syncs the source file if the target file is missing or the existing file contains `@generated`.
+# usage: sync_file_if_missing "/path/source_path" "/path/target_path"
+sync_file_if_missing() {
+  local source=$1
+  local target=$2
+  # echo "sync_file_if_missing $source -> $target"
+  if [ ! -f "$target" ] || grep --quiet "@generated" "$target"; then
+    rsync --checksum "$source" "$target"
+  fi
+}
+
+# syncs the source file if the target file is present in the file system and its content contains `@generated`.
+# usage: sync_file_if_present "/path/source_path" "/path/target_path"
+sync_file_if_present() {
+  local source=$1
+  local target=$2
+  # echo "sync_file_if_present $source -> $target"
+  if [ -f "$target" ] && grep --quiet "@generated" "$target"; then
+    rsync --checksum "$source" "$target"
+  fi
+}
+
+# check if a file is listed in `OPTIONAL_TEMPLATE_FILES`.
+# usage: if is_optional_file "path/to/file"; then ... fi
+is_optional_file() {
+  local file=$1
+  for optional_file in "${OPTIONAL_TEMPLATE_FILES[@]}"; do
+    if [ "$file" = "$optional_file" ]; then
+      true
+      return
+    fi
+  done
+
+  false
+  return
+}
+
+#
+# script main starts from here
+#
+
 "$script_dir/expo-module-readme"
 
-for template_file in "$script_dir"/../templates/*; do
-  output_file="$(basename "$template_file")"
-  if [ ! -f "$output_file" ] || grep --quiet "@generated" "$output_file"; then
-    rsync --checksum "$template_file" "$output_file"
+template_files=$(get_relative_files "$script_dir/../templates")
+for template_relative_file in $template_files; do
+  if is_optional_file "$template_relative_file"; then
+    sync_file_if_present "$script_dir/../templates/$template_relative_file" "$template_relative_file"
+  else
+    sync_file_if_missing "$script_dir/../templates/$template_relative_file" "$template_relative_file"
   fi
 done

package/bin/expo-module-readme

@@ -37,7 +37,7 @@ function removeOptionals(content) {
   return content.replace(regexp, '');
 }
 
-const DEFAULT_HOMEPAGE = 'https://docs.expo.io/versions/latest/';
+const DEFAULT_HOMEPAGE = 'https://docs.expo.dev/versions/latest/';
 
 function generateREADME() {
   const template = path.join(__dirname, '..', 'templates', 'README.md');
@@ -92,7 +92,7 @@ function generateREADME() {
     }
     readme = replaceAll('docName', docName, readme);
     if (isAndroid) {
-      const androidPackages = glob.sync('android/**/*Package.java');
+      const androidPackages = glob.sync('android/src/**/*Package.{java,kt}');
       let androidPackage;
       let androidPackagePath = 'expo.modules.yourModule.YourPackage';
       let androidPackageName = 'YourPackage';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-module-scripts",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A private package for various tasks for Expo module packages like compiling and testing",
   "main": "index.js",
   "bin": {
@@ -24,22 +24,23 @@
   "bugs": {
     "url": "https://github.com/expo/expo/issues"
   },
-  "homepage": "https://github.com/expo/expo/tree/master/packages/expo-module-scripts#readme",
+  "homepage": "https://github.com/expo/expo/tree/main/packages/expo-module-scripts#readme",
   "dependencies": {
     "@babel/cli": "^7.1.2",
     "@expo/npm-proofread": "^1.0.1",
-    "@tsconfig/node10": "^1.0.7",
-    "@testing-library/react-hooks": "^3.2.1",
-    "@types/jest": "^24.0.11",
-    "babel-preset-expo": "~8.3.0",
+    "@testing-library/react-hooks": "^7.0.1",
+    "@tsconfig/node12": "^1.0.9",
+    "@types/jest": "^26.0.24",
+    "babel-preset-expo": "~9.2.0",
     "commander": "^2.19.0",
-    "eslint-config-universe": "^7.0.1",
-    "find-yarn-workspace-root": "~2.0.0",
-    "glob": "^7.1.3",
-    "jest-expo": "~41.0.0",
-    "jest-expo-enzyme": "^1.1.2",
+    "eslint-config-universe": "^11.0.0",
+    "find-yarn-workspace-root": "^2.0.0",
+    "glob": "^7.1.7",
+    "jest-expo": "~46.0.0",
+    "jest-expo-enzyme": "^1.2.3",
+    "jest-watch-typeahead": "0.6.4",
     "ts-jest": "~26.3.0",
-    "typescript": "^4.0.2"
+    "typescript": "^4.3.5"
   },
-  "gitHead": "4e13b3cb88d9205f14bee7764038ab2dd9ef1fbd"
+  "gitHead": "8074a07eb9b07884f66c88cd7001376a9c28ca96"
 }

package/templates/README.md

@@ -5,17 +5,17 @@ ${description}
 
 # API documentation
 
-- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/${docName}.md)
-- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/${docName}/)
+- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/${docName}.md)
+- [Documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/${docName}/)
 
 <!--- end remove for interfaces --->
 # Installation in managed Expo projects
 
-For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation). If you follow the link and there is no documentation available then this library is not yet usable within managed projects &mdash; it is likely to be included in an upcoming Expo SDK release.
+For [managed](https://docs.expo.dev/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation). If you follow the link and there is no documentation available then this library is not yet usable within managed projects &mdash; it is likely to be included in an upcoming Expo SDK release.
 
 # Installation in bare React Native projects
 
-For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/expo/expo/tree/master/packages/react-native-unimodules) before continuing.
+For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
 
 ### Add the package to your npm dependencies
 

package/templates/scripts/with-node.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# Copyright 2018-present 650 Industries. All rights reserved.
+#
+# @generated by expo-module-scripts
+#
+# USAGE:
+# ./with-node.sh command
+
+CURR_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
+
+# Start with a default
+NODE_BINARY=$(command -v node)
+export NODE_BINARY
+
+# Override the default with the global environment
+ENV_PATH="$PODS_ROOT/../.xcode.env"
+if [[ -f "$ENV_PATH" ]]; then
+  source "$ENV_PATH"
+fi
+
+# Override the global with the local environment
+LOCAL_ENV_PATH="${ENV_PATH}.local"
+if [[ -f "$LOCAL_ENV_PATH" ]]; then
+  source "$LOCAL_ENV_PATH"
+fi
+
+if [[ -n "$NODE_BINARY" && -x "$NODE_BINARY" ]]; then
+  echo "Node found at: ${NODE_BINARY}"
+else
+  cat >&2 << EOF
+[ERROR] Could not find "node" while running an Xcode build script. You need to specify the path to your Node.js executable by defining an environment variable named NODE_BINARY in your project's .xcode.env or .xcode.env.local file. You can set this up quickly by running:
+
+  echo "export NODE_BINARY=\$(command -v node)" >> .xcode.env
+
+in the ios folder of your project.
+EOF
+  exit 1
+fi
+
+# Execute argument, if present
+if [[ "$#" -gt 0 ]]; then
+  "$NODE_BINARY" $@
+fi

package/templates/tsconfig.json

@@ -5,5 +5,5 @@
     "outDir": "./build"
   },
   "include": ["./src"],
-  "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+  "exclude": ["**/__mocks__/*", "**/__tests__/*", "**/__stories__/*"]
 }

package/tsconfig.base.json

@@ -5,7 +5,6 @@
     "jsx": "react",
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
     "types": ["jest", "jest-require"],
     "typeRoots": [
       "./ts-declarations",
@@ -13,6 +12,7 @@
     ],
     "sourceMap": true,
     "declaration": true,
+    "declarationMap": true,
     "inlineSources": true,
     "strictNullChecks": true,
     "strictPropertyInitialization": true,

package/tsconfig.plugin.json

@@ -1,7 +1,6 @@
 {
-    "extends": "@tsconfig/node10/tsconfig.json",
-    "compilerOptions": {
-        "declaration": true
-    }
+  "extends": "@tsconfig/node12/tsconfig.json",
+  "compilerOptions": {
+    "declaration": true
   }
-  
+}