@npmcli/template-oss 2.4.2 → 2.6.0

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-no-windows.yml

@@ -0,0 +1,48 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - latest
+  schedule:
+    # "At 02:00 on Monday" https://crontab.guru/#0_1_*_*_1
+    - cron: "0 2 * * 1"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - run: npm i --prefer-online -g npm@latest
+      - run: npm i
+      - run: npm run lint
+
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        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
+    runs-on: ${{ matrix.platform.os }}
+    defaults:
+      run:
+        shell: ${{ matrix.platform.shell }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm i --prefer-online -g npm@latest
+      - run: npm i
+      - run: npm test --ignore-scripts

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

@@ -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/postinstall/copy-content.js

@@ -38,6 +38,7 @@ const defaultConfig = {
   applyRootRepoFiles: true,
   applyWorkspaceRepoFiles: true,
   applyRootModuleFiles: true,
+  windowsCI: true,
 }
 
 const copyFiles = async (targetDir, files) => {
@@ -78,9 +79,18 @@ const copyContent = async (path, rootPath, config) => {
   if (!isWorkspace) {
     if (config.applyRootRepoFiles) {
       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, '.github', 'workflows', 'ci.yml')
+        )
+      }
     }
     return
-  } // only workspace now
+  }
+
+  // only workspace now
 
   // TODO: await copyFiles(path, workspaceFiles)
   // if we ever have workspace specific files
@@ -89,6 +99,8 @@ const copyContent = async (path, rootPath, config) => {
     // copy and edit workspace repo file (ci github action)
     const workspacePkg = (await PackageJson.load(path)).content
     const workspaceName = workspacePkg.name
+    let workspaceFile = `ci-${workspaceName.replace(/\//g, '-')}.yml`
+    workspaceFile = workspaceFile.replace(/@/g, '')
     const workflowPath = join(rootPath, '.github', 'workflows')
     await fs.mkdir(workflowPath, {
       owner: 'inherit',
@@ -105,7 +117,7 @@ const copyContent = async (path, rootPath, config) => {
     workflowData = workflowData.replace(/%%pkgpath%%/g, relPath)
     workflowData = workflowData.replace(/%%pkgname%%/g, workspaceName)
 
-    await fs.writeFile(join(workflowPath, `ci-${workspaceName}.yml`), workflowData)
+    await fs.writeFile(join(workflowPath, workspaceFile), workflowData)
   }
 }
 copyContent.moduleFiles = moduleFiles

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.4.2",
+  "version": "2.6.0",
   "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",