chore: don't publish internal scripts (#954)

Author: tido64

.github/actions/cocoapods/action.yml

@@ -14,7 +14,7 @@ runs:
       id: cache-key-generator
       run: |
         if [[ -f ${{ inputs.working-directory }}/${{ inputs.project-directory }}/Podfile.lock ]]; then
-          echo "::set-output name=cache-key::$(node scripts/shasum.js ${{ inputs.working-directory }}/${{ inputs.project-directory }}/Podfile.lock)"
+          echo "::set-output name=cache-key::$(node scripts/shasum.mjs ${{ inputs.working-directory }}/${{ inputs.project-directory }}/Podfile.lock)"
         else
           echo '::set-output name=cache-key::false'
         fi

.github/actions/init-test-app/action.yml

@@ -9,7 +9,7 @@ runs:
   steps:
     - name: Generate cache key
       id: cache-key-generator
-      run: echo "::set-output name=cache-key::$(node scripts/shasum.js yarn.lock)"
+      run: echo "::set-output name=cache-key::$(node scripts/shasum.mjs yarn.lock)"
       shell: bash
     - name: Cache /.yarn/cache
       uses: actions/cache@v3

.github/actions/setup-toolchain/action.yml

@@ -34,7 +34,7 @@ runs:
       id: cache-key-generator
       run: |
         if [[ -f example/${{ inputs.platform }}/Podfile.lock ]]; then
-          echo "::set-output name=cache-key::$(node scripts/shasum.js example/${{ inputs.platform }}/Podfile.lock)"
+          echo "::set-output name=cache-key::$(node scripts/shasum.mjs example/${{ inputs.platform }}/Podfile.lock)"
         else
           echo '::set-output name=cache-key::false'
         fi

.github/actions/yarn/action.yml

@@ -9,7 +9,7 @@ runs:
   steps:
     - name: Generate cache key
       id: cache-key-generator
-      run: echo "::set-output name=cache-key::$(node scripts/shasum.js yarn.lock)"
+      run: echo "::set-output name=cache-key::$(node scripts/shasum.mjs yarn.lock)"
       shell: bash
     - name: Cache /.yarn/cache
       uses: actions/cache@v3

.github/workflows/build.yml

@@ -90,7 +90,7 @@ jobs:
           #       Ignore errors until we can create a GitHub PAT from a system
           #       account.
           if [[ ${{ matrix.platform }} == macos ]]; then
-            scripts/prettier-diff.js $(git ls-files '*.js' '*.yml' 'test/**/*.json') || true
+            scripts/prettier-diff.mjs $(git ls-files '*.js' '*.yml' 'test/**/*.json') || true
             echo "::add-matcher::.github/eslint-stylish.json"
             npm run lint:js
             echo "::remove-matcher owner=eslint-stylish::"

CONTRIBUTING.md

@@ -17,17 +17,20 @@ For more information see the
 contact [[email protected]](mailto:[email protected]) with any
 additional questions or comments.
 
-## Commit messages
+## Commit Messages
 
 This repository adheres to the
 [conventional commit format](https://conventionalcommits.org) via
 [commitlint](https://github.com/conventional-changelog/commitlint/#what-is-commitlint).
 Commit messages must match the pattern:
 
 ```sh
-type(scope?): subject  #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")
+type(scope?): subject
 ```
 
+Scope is optional. You can also specify multiple scopes using `/` or `,` as
+delimiters.
+
 Following this is necessary to pass CI.
 
 ## Additional Dependencies
@@ -158,7 +161,18 @@ If you choose to use Visual Studio, remember to first set the target platform to
 > re-run `install-windows-test-app` to make sure that the changes are included
 > in the Visual Studio project.
 
-### Testing Other React Native Versions
+## Adding New Files
+
+When adding new files, please make sure they are published (or not if it's for
+internal use only). To get a list of files that get published, you can run:
+
+```sh
+npm pack --dry-run --verbose
+```
+
+If your files are missing, you can modify the `files` section in `package.json`.
+
+## Testing Specific React Native Versions
 
 `react-native-test-app` supports multiple versions of React Native. Use
 `set-react-version` to set the version, e.g. to use 0.68:

package.json

@@ -35,7 +35,7 @@
     "/ios",
     "/macos",
     "/schema.json",
-    "/scripts",
+    "/scripts/*.js",
     "/windows/*.{js,props,sln}",
     "/windows/ReactTestApp"
   ],

scripts/prettier-diff.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+// @ts-check
+
+import { spawnSync } from "node:child_process";
+import { readFileSync } from "node:fs";
+import { format } from "prettier";
+import suggest from "suggestion-bot";
+
+const diff = process.argv.slice(2).reduce((diff, filepath) => {
+  const source = readFileSync(filepath, { encoding: "utf-8" });
+  const { stdout } = spawnSync("diff", ["--unified", filepath, "-"], {
+    input: format(source, { filepath }),
+    encoding: "utf-8",
+  });
+  return diff + stdout;
+}, "");
+
+suggest(diff);

scripts/prettier-diff.mjs

@@ -1,16 +1,17 @@
 #!/usr/bin/env node
 // @ts-check
 
+import { createHash } from "node:crypto";
+import { readFileSync } from "node:fs";
+
 /**
  * @param {string} filename
  * @param {string=} algorithm
  * @returns {string}
  */
 function hashFile(filename, algorithm = "sha256") {
-  const data = require("fs")
-    .readFileSync(filename, { encoding: "utf-8" })
-    .replace(/\r/g, "");
-  return require("crypto").createHash(algorithm).update(data).digest("hex");
+  const data = readFileSync(filename, { encoding: "utf-8" }).replace(/\r/g, "");
+  return createHash(algorithm).update(data).digest("hex");
 }
 
 const { [2]: filename } = process.argv;