@npmcli/template-oss 2.5.0 → 2.7.1

package/README.md

@@ -41,6 +41,7 @@ These fields will be set in the project's `package.json`:
     lint: `eslint '**/*.js'`,
     postlint: 'npm-template-check',
     lintfix: 'npm run lint -- --fix',
+    'template-copy': 'npm-template-copy --force',
     preversion: 'npm test',
     postversion: 'npm publish',
     prepublishOnly: 'git push origin --follow-tags',
@@ -99,6 +100,11 @@ your new file. The object keys are destination paths, and values are source.
 `npm-template-check` is run by `postlint` and will error if the `package.json`
 is not configured properly, with steps to run to correct any problems.
 
+### Manual copy
+
+Template files will be copied automatically when `template-oss` is updated.
+You can force an update with `npm run template-copy`.
+
 #### Extending
 
 Add any unwanted packages to `unwantedPackages` in `lib/check.js`. Currently

package/lib/config.js

@@ -7,6 +7,7 @@ const defaultConfig = {
   applyRootModuleFiles: true,
   workspaces: [],
   paths: [],
+  force: false,
 }
 
 module.exports = async (root) => {
@@ -44,5 +45,7 @@ module.exports = async (root) => {
 
   config.paths.push(root)
 
+  config.force = process.argv.indexOf('--force') !== -1
+
   return config
 }

package/lib/content/ci-workspace.yml

@@ -4,8 +4,6 @@ on:
   pull_request:
     paths:
       - %%pkgpath%%/**
-    branches:
-      - '*'
   push:
     paths:
       - %%pkgpath%%/**
@@ -20,57 +18,46 @@ jobs:
     steps:
       # Checkout the npm/cli repo
       - uses: actions/checkout@v2
-      - name: Use Node.js 16.x
-        uses: actions/setup-node@v2
+      - uses: actions/setup-node@v2
         with:
-          node-version: 16.x
-          cache: npm
-      - name: Install dependencies
-        run: |
-          node ./bin/npm-cli.js install --ignore-scripts --no-audit
-          node ./bin/npm-cli.js rebuild
-      - name: Run linting
-        run: node ./bin/npm-cli.js run posttest -w %%pkgpath%%
-        env:
-          DEPLOY_VERSION: testing
+          node-version: '16'
+      - run: npm i --prefer-online -g npm@latest
+      - run: npm i
+      - run: npm run lint -w %%pkgpath%%
 
   test:
     strategy:
       fail-fast: false
       matrix:
-        node-version: ['12.13.0', 12.x, '14.15.0', 14.x, '16.0.0', 16.x]
+        node-version: [12.13.0, 12.x, 14.15.0, 14.x, 16.13.0, 16.x]
         platform:
           - os: ubuntu-latest
             shell: bash
           - os: macos-latest
             shell: bash
           - os: windows-latest
-            shell: bash
-          - os: windows-latest
-            shell: powershell
-
+            shell: cmd
     runs-on: ${{ matrix.platform.os }}
     defaults:
       run:
         shell: ${{ matrix.platform.shell }}
-
     steps:
-      # Checkout the npm/cli repo
-    - uses: actions/checkout@v2
-
-      # Installs the specific version of Node.js
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: npm
-
-      # Run the installer script
-    - name: Install dependencies
-      run: |
-        node ./bin/npm-cli.js install --ignore-scripts --no-audit
-        node ./bin/npm-cli.js rebuild
-
-      # Run the tests, but not if we're just gonna do coveralls later anyway
-    - name: Run Tap tests
-      run: node ./bin/npm-cli.js run -w %%pkgpath%% --ignore-scripts test -- -t600 -Rbase -c
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+        # node 12 and 14 ship with npm@6, which is known to fail when updating itself in windows
+      - name: Update to workable npm (windows)
+        if: matrix.platform.os == 'windows-latest' && (startsWith(matrix.node-version, '12') || startsWith(matrix.node-version, '14'))
+        run: |
+          curl -sO https://registry.npmjs.org/npm/-/npm-7.5.4.tgz
+          tar xf npm-7.5.4.tgz
+          cd package
+          node lib/npm.js install --no-fund --no-audit -g ..\npm-7.5.4.tgz
+          cd ..
+          rmdir /s /q package
+      - name: Update npm
+        run: npm i --prefer-online --no-fund --no-audit -g npm@latest
+      - run: npm -v
+      - run: npm i
+      - run: npm test --ignore-scripts -w %%pkgpath%%

package/lib/content/ci.yml

@@ -9,7 +9,7 @@ on:
       - main
       - latest
   schedule:
-    # "At 02:00 on Monday" https://crontab.guru/#0_1_*_*_1
+    # "At 02:00 on Monday" https://crontab.guru/#0_2_*_*_1
     - cron: "0 2 * * 1"
 
 jobs:
@@ -34,12 +34,8 @@ jobs:
           shell: bash
         - os: macos-latest
           shell: bash
-        - os: windows-latest
-          shell: bash
         - os: windows-latest
           shell: cmd
-        - os: windows-latest
-          shell: powershell
     runs-on: ${{ matrix.platform.os }}
     defaults:
       run:
@@ -49,6 +45,18 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm i --prefer-online -g npm@latest
+        # node 12 and 14 ship with npm@6, which is known to fail when updating itself in windows
+      - name: Update to workable npm (windows)
+        if: matrix.platform.os == 'windows-latest' && (startsWith(matrix.node-version, '12') || startsWith(matrix.node-version, '14'))
+        run: |
+          curl -sO https://registry.npmjs.org/npm/-/npm-7.5.4.tgz
+          tar xf npm-7.5.4.tgz
+          cd package
+          node lib/npm.js install --no-fund --no-audit -g ..\npm-7.5.4.tgz
+          cd ..
+          rmdir /s /q package
+      - name: Update npm
+        run: npm i --prefer-online --no-fund --no-audit -g npm@latest
+      - run: npm -v
       - run: npm i
       - run: npm test --ignore-scripts

package/lib/content/codeql-analysis.yml

@@ -0,0 +1,38 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    # "At 03:00 on Monday" https://crontab.guru/#0_3_*_*_1
+    - cron: "0 3 * * 1"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

package/lib/content/commitlintrc.js

@@ -6,6 +6,6 @@ module.exports = {
   rules: {
     'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'chore', 'deps']],
     'header-max-length': [2, 'always', 80],
-    'subject-case': [2, 'always', ['lower-case', 'sentence-case', 'start-case']],
+    'subject-case': [0, 'always', ['lower-case', 'sentence-case', 'start-case']],
   },
 }

package/lib/content/dependabot.yml

@@ -8,9 +8,9 @@ updates:
     interval: daily
   allow:
     - dependency-type: direct
-  versioning-strategy: increase-if-necessary
+  versioning-strategy: increase
   commit-message:
     prefix: deps
     prefix-development: chore
   labels:
-    - "dependencies"
+    - "Dependencies"

package/lib/content/post-dependabot.yml

@@ -0,0 +1,31 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: "Post Dependabot Actions"
+on: pull_request
+
+jobs:
+  Install:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.1.1
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: npm install and commit
+        if: ${{contains(steps.metadata.outputs.dependency-names, '@npmcli/template-oss')}}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git config --local user.email "ops+npm-cli@npmjs.com"
+          git config --local user.name "npm cli ops bot"
+          gh pr checkout ${{ github.event.pull_request.number }}
+          npm install
+          git add .
+          git commit -am "chore: postinstall for dependabot template-oss PR"
+          git push origin ${{github.ref_name}}

package/lib/content/release-please.yml

@@ -21,5 +21,5 @@ jobs:
             [{"type":"feat","section":"Features","hidden":false},
             {"type":"fix","section":"Bug Fixes","hidden":false},
             {"type":"docs","section":"Documentation","hidden":false},
-            {"type":"deps","section":"dependencies","hidden":false},
+            {"type":"deps","section":"Dependencies","hidden":false},
             {"type":"chore","hidden":true}]

package/lib/postinstall/copy-content.js

@@ -21,6 +21,8 @@ const repoFiles = {
   '.github/CODEOWNERS': './CODEOWNERS',
   '.github/dependabot.yml': './dependabot.yml',
   '.github/workflows/audit.yml': './audit.yml',
+  '.github/workflows/codeql-analysis.yml': './codeql-analysis.yml',
+  '.github/workflows/post-dependabot.yml': './post-dependabot.yml',
   '.github/workflows/pull-request.yml': './pull-request.yml',
   '.github/workflows/release-please.yml': './release-please.yml',
 }
@@ -81,7 +83,10 @@ const copyContent = async (path, rootPath, config) => {
       await copyFiles(rootPath, repoFiles)
       if (!config.windowsCI) {
         // copyFiles already did the mkdir so we can just fs.copyFile now
-        await fs.copyFile(join(contentDir, 'ci-no-windows.yml'), join(rootPath, 'ci.yml'))
+        await fs.copyFile(
+          join(contentDir, 'ci-no-windows.yml'),
+          join(rootPath, '.github', 'workflows', 'ci.yml')
+        )
       }
     }
     return

package/lib/postinstall/update-package.js

@@ -11,6 +11,7 @@ const changes = {
   scripts: {
     lint: `eslint '**/*.js'`,
     postlint: 'npm-template-check',
+    'template-copy': 'npm-template-copy --force',
     lintfix: 'npm run lint -- --fix',
     preversion: 'npm test',
     postversion: 'npm publish',
@@ -26,6 +27,7 @@ const changes = {
 
 const patchPackage = async (path, root, config) => {
   const pkg = await PackageJson.load(path)
+  config = config || {}
 
   // If we are running this on itself, we always run the script.
   // We also don't set templateVersion in package.json because
@@ -38,7 +40,9 @@ const patchPackage = async (path, root, config) => {
   // if the target package.json has a templateVersion field matching our own
   // current version, we return false here so the postinstall script knows to
   // exit early instead of running everything again
-  if (currentVersion === TEMPLATE_VERSION && !isDogfood) {
+  if (!config.force
+    && currentVersion === TEMPLATE_VERSION
+    && !isDogfood) {
     return false
   }
 

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "2.5.0",
+  "version": "2.7.1",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/index.js",
   "bin": {
-    "npm-template-check": "bin/npm-template-check.js"
+    "npm-template-check": "bin/npm-template-check.js",
+    "npm-template-copy": "bin/postinstall.js"
   },
   "scripts": {
     "lint": "eslint '**/*.js'",
@@ -16,7 +17,8 @@
     "prepublishOnly": "git push origin --follow-tags",
     "preversion": "npm test",
     "snap": "tap",
-    "test": "tap"
+    "test": "tap",
+    "template-copy": "npm-template-copy --force"
   },
   "repository": {
     "type": "git",
@@ -29,7 +31,7 @@
   "author": "GitHub Inc.",
   "license": "ISC",
   "dependencies": {
-    "@npmcli/fs": "^1.0.0",
+    "@npmcli/fs": "^1.1.0",
     "@npmcli/map-workspaces": "^2.0.0",
     "@npmcli/package-json": "^1.0.1",
     "json-parse-even-better-errors": "^2.3.1",
@@ -43,7 +45,7 @@
     "@npmcli/eslint-config": "*",
     "@npmcli/promise-spawn": "^2.0.0",
     "@npmcli/template-oss": "file:./",
-    "eslint": "^8.1.0",
+    "eslint": "^8.8.0",
     "eslint-plugin-node": "^11.1.0",
     "tap": "*"
   },