@npmcli/template-oss 3.5.0 → 3.7.1

package/lib/check/check-changelog.js

@@ -1,5 +1,4 @@
 const fs = require('@npmcli/fs')
-const { EOL } = require('os')
 const { join, relative } = require('path')
 
 const run = async ({ root, path }) => {
@@ -10,13 +9,13 @@ const run = async ({ root, path }) => {
 
   if (await fs.exists(changelog)) {
     const content = await fs.readFile(changelog, { encoding: 'utf8' })
-    const mustStart = `# Changelog${EOL}${EOL}#`
-    if (!content.startsWith(mustStart)) {
+    const mustStart = /^#\s+Changelog\r?\n\r?\n#/
+    if (!mustStart.test(content)) {
       return {
         title: `The ${relative(root, changelog)} is incorrect:`,
         body: [
           'The changelog should start with',
-          `"${mustStart}"`,
+          `"# Changelog\n\n#"`,
         ],
         solution: 'reformat the changelog to have the correct heading',
       }

package/lib/check/check-gitignore.js

@@ -1,5 +1,4 @@
 const log = require('proc-log')
-const { EOL } = require('os')
 const { resolve, relative, basename } = require('path')
 const fs = require('@npmcli/fs')
 const git = require('@npmcli/git')
@@ -48,7 +47,7 @@ const run = async ({ root, path, config }) => {
 
   const ignores = (await fs.readFile(ignoreFile))
     .toString()
-    .split(EOL)
+    .split(/\r?\n/)
     .filter((l) => l && !l.trim().startsWith('#'))
 
   const relIgnore = relativeToRoot(ignoreFile)

package/lib/content/audit.yml

@@ -3,8 +3,8 @@ name: Audit
 on:
   workflow_dispatch:
   schedule:
-    # "At 01:00 on Monday" https://crontab.guru/#0_1_*_*_1
-    - cron: "0 1 * * 1"
+    # "At 08:00 UTC (01:00 PT) on Monday" https://crontab.guru/#0_8_*_*_1
+    - cron: "0 8 * * 1"
 
 jobs:
   audit:

package/lib/content/ci.yml

@@ -19,8 +19,8 @@ on:
       - {{pkgRelPath}}/**
     {{/if}}
   schedule:
-    # "At 02:00 on Monday" https://crontab.guru/#0_2_*_*_1
-    - cron: "0 2 * * 1"
+    # "At 09:00 UTC (02:00 PT) on Monday" https://crontab.guru/#0_9_*_*_1
+    - cron: "0 9 * * 1"
 
 jobs:
   lint:
@@ -55,5 +55,7 @@ jobs:
     steps:
       {{> setupGit}}
       {{> setupNode useMatrix=true}}
+      - name: add tap problem matcher
+        run: echo "::add-matcher::.github/matchers/tap.json"
       - run: npm i --ignore-scripts --no-audit --no-fund
       - run: npm test --ignore-scripts {{~#if isWorkspace}} -w {{pkgName}}{{/if}}

package/lib/content/codeql-analysis.yml

@@ -13,8 +13,8 @@ on:
       - {{.}}
       {{/each}}
   schedule:
-    # "At 03:00 on Monday" https://crontab.guru/#0_3_*_*_1
-    - cron: "0 3 * * 1"
+    # "At 10:00 UTC (03:00 PT) on Monday" https://crontab.guru/#0_10_*_*_1
+    - cron: "0 10 * * 1"
 
 jobs:
   analyze:

package/lib/content/index.js

@@ -1,5 +1,26 @@
 const { name: NAME, version: LATEST_VERSION } = require('../../package.json')
 
+const releasePlease = () => ({
+  '.github/workflows/release-please.yml': {
+    file: 'release-please.yml',
+    filter: (o) => !o.pkg.private,
+  },
+  '.release-please-manifest.json': {
+    file: 'release-please-manifest.json',
+    filter: (o) => !o.pkg.private,
+    parser: (p) => class NoCommentJson extends p.JsonMerge {
+      comment = null
+    },
+  },
+  'release-please-config.json': {
+    file: 'release-please-config.json',
+    filter: (o) => !o.pkg.private,
+    parser: (p) => class NoCommentJson extends p.JsonMerge {
+      comment = null
+    },
+  },
+})
+
 // Changes applied to the root of the repo
 const rootRepo = {
   add: {
@@ -9,14 +30,12 @@ const rootRepo = {
     '.github/ISSUE_TEMPLATE/config.yml': 'config.yml',
     '.github/CODEOWNERS': 'CODEOWNERS',
     '.github/dependabot.yml': 'dependabot.yml',
+    '.github/matchers/tap.json': 'tap.json',
     '.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': {
-      file: 'release-please.yml',
-      filter: (o) => !o.pkg.private,
-    },
+    ...releasePlease(),
   },
 }
 
@@ -42,12 +61,14 @@ const rootModule = {
 // Changes for each workspace but applied to the root of the repo
 const workspaceRepo = {
   add: {
-    '.github/workflows/release-please-{{pkgNameFs}}.yml': {
-      file: 'release-please.yml',
-      filter: (o) => !o.pkg.private,
-    },
+    ...releasePlease(true),
+    '.github/matchers/tap.json': 'tap.json',
     '.github/workflows/ci-{{pkgNameFs}}.yml': 'ci.yml',
   },
+  rm: [
+    // These are the old release please files that should be removed now
+    '.github/workflows/release-please-{{pkgNameFs}}.yml',
+  ],
 }
 
 // Changes for each workspace but applied to the relative workspace dir

package/lib/content/release-please-config.json

@@ -0,0 +1,15 @@
+{
+  "separate-pull-requests": true,
+  "changelog-sections":             [
+    {"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":"chore","hidden":true}
+  ],
+  "packages": {
+    "{{#unless pkgRelPath}}.{{/unless}}{{pkgRelPath}}": {
+      {{#unless pkgRelPath}}"package-name": ""{{/unless}}
+    }
+  }
+}

package/lib/content/release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  "{{#unless pkgRelPath}}.{{/unless}}{{pkgRelPath}}": "{{pkg.version}}"
+}

package/lib/content/release-please.yml

@@ -1,56 +1,46 @@
-name: Release Please {{~#if isWorkspace}} - {{pkgName}}{{/if}}
+name: Release Please
 
 on:
   push:
-    {{#if pkgRelPath}}
-    paths:
-      - {{pkgRelPath}}/**
-    {{/if}}
     branches:
       {{#each branches}}
       - {{.}}
       {{/each}}
 
-{{#if isWorkspace}}
 permissions:
   contents: write
   pull-requests: write
-{{/if}}
 
 jobs:
   release-please:
     runs-on: ubuntu-latest
+    outputs:
+      prs: $\{{ steps.release.outputs.prs }}
     steps:
       - uses: google-github-actions/release-please-action@v3
         id: release
         with:
-          release-type: node
-          {{#if pkgRelPath}}
-          monorepo-tags: true
-          path: {{pkgRelPath}}
-          # name can be removed after this is merged
-          # https://github.com/google-github-actions/release-please-action/pull/459
-          package-name: "{{pkgName}}"
-          {{/if}}
-          changelog-types: >
-            [
-              {{#each changelogTypes}}
-              {{{json .}}}{{#unless @last}},{{/unless}}
-              {{/each}}
-            ]
-      {{#if isWorkspace}}
+          command: manifest
+
+  update-prs:
+    needs: release-please
+    if: needs.release-please.outputs.prs
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        pr: $\{{ fromJSON(needs.release-please.outputs.prs) }}
+    steps:
       {{> setupGit}}
       {{> setupNode}}
-      - name: Update package-lock.json and commit
-        if: steps.release.outputs.pr
+      - name: Update PR $\{{ matrix.pr.number }} dependencies and commit
         env:
           GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
         run: |
-          gh pr checkout $\{{ fromJSON(steps.release.outputs.pr).number }}
+          gh pr checkout $\{{ matrix.pr.number }}
           npm run resetdeps
-          title="$\{{ fromJSON(steps.release.outputs.pr).title }}"
-          # get the version from the pr title
-          # get everything after the last space
-          git commit -am "deps: {{pkgName}}@${title##* }"
+          title="$\{{ matrix.pr.title }}"
+          # get the dependency spec from the pr title
+          # get everything after ': release ' + replace space with @
+          dep_spec=$(echo "${title##*: release }" | tr ' ' @)
+          git commit -am "deps: $dep_spec"
           git push
-      {{/if}}

package/lib/content/tap.json

@@ -0,0 +1,28 @@
+{
+  "problemMatcher": [{
+    "owner": "tap",
+    "pattern" : [
+      {
+        "regexp": "^\\s*not ok \\d+ - (.*)",
+        "message": 1
+      },
+      {
+        "regexp": "^\\s*---"
+      },
+      {
+        "regexp": "^\\s*at:"
+      },
+      {
+        "regexp": "^\\s*line:\\s*(\\d+)",
+        "line": 1
+      },
+      {
+        "regexp": "^\\s*column:\\s*(\\d+)",
+        "column": 1
+      }, {
+        "regexp": "^\\s*file:\\s*(.*)",
+        "file": 1
+      }
+    ]
+  }]
+}

package/lib/util/get-git-url.js

@@ -18,7 +18,9 @@ const getRepo = async (path) => {
     const url = new URL(`https://${domain}`)
     url.pathname = `/${user}/${project}.git`
     return url.toString()
-  } catch {}
+  } catch {
+    // errors are ignored
+  }
 }
 
 module.exports = getRepo

package/lib/util/parser.js

@@ -1,5 +1,4 @@
 const fs = require('@npmcli/fs')
-const { EOL } = require('os')
 const { basename, extname, dirname } = require('path')
 const yaml = require('yaml')
 const NpmPackageJson = require('@npmcli/package-json')
@@ -56,7 +55,7 @@ class Base {
 
   prepare (s) {
     const header = this.header()
-    return header ? header + EOL + EOL + s : s
+    return header ? `${header}\n\n${s}` : s
   }
 
   prepareTarget (s) {
@@ -199,7 +198,7 @@ class Json extends Base {
   comment = (c) => ({ [`//${this.options.config.__NAME__}`]: c })
 
   toString (s) {
-    return JSON.stringify(s, (_, v) => v === this.DELETE ? undefined : v, 2)
+    return JSON.stringify(s, (_, v) => v === this.DELETE ? undefined : v, 2).trim() + '\n'
   }
 
   parse (s) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "3.5.0",
+  "version": "3.7.1",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {
@@ -45,7 +45,7 @@
     "npm-package-arg": "^9.0.1",
     "proc-log": "^2.0.0",
     "semver": "^7.3.5",
-    "yaml": "^2.0.0-11"
+    "yaml": "2.0.0-11"
   },
   "files": [
     "bin/",