Support installing private packages

Author: razor-x

.devcontainer/Dockerfile

@@ -9,3 +9,5 @@ RUN mkdir -p .config/git \
  && echo ".vscode/*" >> .config/git/ignore \
  && echo "*.code-workspace" >> .config/git/ignore \
  && echo ".history/" >> .config/git/ignore
+
+RUN echo '//npm.pkg.github.com/:_authToken=${GH_TOKEN}' > .npmrc

.github/actions/setup/action.yml

@@ -3,14 +3,17 @@ name: Setup
 description: Setup Node.js and install dependencies.
 
 inputs:
+  node_auth_token:
+    description: The Node.js auth token.
+    required: true
   node_version:
     description: The Node.js version.
     required: false
     default: '18'
   registry_url:
     description: The Node.js package registry URL.
     required: false
-    default: https://registry.npmjs.org
+    default: https://npm.pkg.github.com
   install_dependencies:
     description: Install dependencies.
     required: false
@@ -35,4 +38,15 @@ runs:
     - name: Install dependencies
       if: inputs.install_dependencies == 'true'
       shell: bash
-      run: npm ci
+      run: npm ci --ignore-scripts
+      env:
+        NODE_AUTH_TOKEN: ${{ inputs.node_auth_token }}
+    - name: Rebuild Node.js modules
+      shell: bash
+      run: npm rebuild
+    - name: Run postinstall script
+      shell: bash
+      run: npm run postinstall --if-present
+    - name: Run prepare script
+      shell: bash
+      run: npm run prepare --if-present

.github/workflows/_build.yml

@@ -26,6 +26,7 @@ jobs:
         uses: ./.github/actions/setup
         with:
           node_version: ${{ inputs.node_version }}
+          node_auth_token: ${{ secrets.GH_TOKEN }}
       - name: Build
         run: npm run build
       - name: Package

.github/workflows/_publish.yml

@@ -29,6 +29,7 @@ jobs:
         uses: ./.github/actions/setup
         with:
           install_dependencies: 'false'
+          node_auth_token: ${{ secrets.GH_TOKEN }}
       - name: Download artifact
         uses: actions/download-artifact@v3
         with:

.github/workflows/check.yml

@@ -35,6 +35,7 @@ jobs:
         uses: ./.github/actions/setup
         with:
           node_version: ${{ matrix.node }}
+          node_auth_token: ${{ secrets.GH_TOKEN }}
       - name: Test
         run: npm test
   lint:
@@ -54,6 +55,7 @@ jobs:
         uses: ./.github/actions/setup
         with:
           node_version: ${{ matrix.node }}
+          node_auth_token: ${{ secrets.GH_TOKEN }}
       - name: Lint
         run: npm run lint
   build:
@@ -111,7 +113,18 @@ jobs:
           contents: |
             import '@seamapi/makenew-tsmodule'
       - name: Install
-        run: npm install --save ${{ steps.packages.outputs.paths }}
+        run: npm install --ignore-scripts --save ${{ steps.packages.outputs.paths }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GH_TOKEN }}
+      - name: Rebuild Node.js modules
+        shell: bash
+        run: npm rebuild
+      - name: Run postinstall script
+        shell: bash
+        run: npm run postinstall --if-present
+      - name: Run prepare script
+        shell: bash
+        run: npm run prepare --if-present
       - name: Run
         run: node index.js
   typecheck:
@@ -131,5 +144,6 @@ jobs:
         uses: ./.github/actions/setup
         with:
           node_version: ${{ matrix.node }}
+          node_auth_token: ${{ secrets.GH_TOKEN }}
       - name: Typecheck
         run: npm run typecheck

.github/workflows/format.yml

@@ -29,6 +29,8 @@ jobs:
           passphrase: ${{ secrets.GPG_PASSPHRASE }}
       - name: Setup
         uses: ./.github/actions/setup
+        with:
+          node_auth_token: ${{ secrets.GH_TOKEN }}
       - name: Format
         run: npm run format
       - name: Commit

.github/workflows/generate.yml

@@ -32,7 +32,9 @@ jobs:
         with:
           install_dependencies: 'false'
       - name: Normalize package-lock.json
-        run: npm install
+        run: npm install --ignore-scripts
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GH_TOKEN }}
       - name: Commit
         uses: stefanzweifel/git-auto-commit-action@v4
         with:

.github/workflows/version.yml

@@ -31,5 +31,7 @@ jobs:
           passphrase: ${{ secrets.GPG_PASSPHRASE }}
       - name: Setup
         uses: ./.github/actions/setup
+        with:
+          node_auth_token: ${{ secrets.GH_TOKEN }}
       - name: Cut ${{ github.event.inputs.version }} version
         run: npm version --sign-git-tag=true ${{ github.event.inputs.version }}

.gitignore

@@ -22,7 +22,7 @@ package
 .tern-port
 
 # npm config
-.npmrc
+# .npmrc
 
 # Temporary development files
 tmp

.npmrc

@@ -0,0 +1 @@
+@seamapi:registry=https://npm.pkg.github.com

README.md

@@ -13,6 +13,8 @@ Bootstrap a new TypeScript module in five minutes or less.
 - Strongly typed JavaScript with [TypeScript].
 - Native [ECMAScript module] compatible with [Node.js].
 - Package management with [npm].
+- Use private packages from [GitHub Packages].
+- Publish as a private package to [GitHub Packages].
 - Examples with configurable options and arguments powered by [yargs] with [landlubber].
 - Linting with the [JavaScript Standard Style] using [ESLint].
 - [Prettier] code.
@@ -28,6 +30,7 @@ Bootstrap a new TypeScript module in five minutes or less.
 [ESLint]: https://eslint.org/
 [EditorConfig]: https://editorconfig.org/
 [GitHub Actions]: https://github.com/features/actions
+[GitHub Packages]: https://github.com/features/packages
 [Istanbul]: https://istanbul.js.org/
 [JavaScript Standard Style]: https://standardjs.com/
 [Node.js]: https://nodejs.org/
@@ -159,7 +162,8 @@ Set the active version for each shell session with
 $ nvm use
 ```
 
-Install the development dependencies with
+Ensure you are authenticated with the [GitHub Packages npm registry],
+then install the development dependencies with
 
 ```
 $ npm install
@@ -169,6 +173,7 @@ $ npm install
 [Node.js debugging]: https://nodejs.org/en/docs/guides/debugging-getting-started/
 [npm]: https://www.npmjs.com/
 [nvm]: https://github.com/creationix/nvm
+[GitHub Packages npm registry]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages
 
 ### Publishing
 

makenew.sh

@@ -55,7 +55,7 @@ makenew () {
   read -p '> Short package description (Foos and bars.): ' mk_description
   read -p '> GitHub repository name (my-repo): ' mk_repo
 
-  sed_delete README.md '9,90d'
+  sed_delete README.md '9,93d'
   sed_insert README.md '9i' 'TODO'
 
   find_replace "s/^  \"version\": \".*\"/  \"version\": \"0.0.0\"/g"