@npmcli/template-oss 2.9.2 → 3.0.0

package/lib/content/package.json

@@ -0,0 +1,27 @@
+{
+  "author": "GitHub Inc.",
+  "files": {{{json distPaths}}},
+  "scripts": {
+    "lint": "eslint \"**/*.js\"",
+    "postlint": "template-oss-check",
+    "template-oss-apply": "template-oss-apply --force",
+    "lintfix": "npm run lint -- --fix",
+    "preversion": "npm test",
+    "postversion": "npm publish",
+    "prepublishOnly": "git push origin --follow-tags",
+    "snap": "tap",
+    "test": "tap",
+    "posttest": "npm run lint",
+    "template-copy": {{{del}}},
+    "lint:fix": {{{del}}}
+  },
+  "repository": {{#if repository}}{{{json repository}}}{{else}}{{{del}}}{{/if}},
+  "engines": {
+    "node": {{{json engines}}}
+  },
+  {{{json __CONFIG_KEY__}}}: {
+    "version": {{#if __DOGFOOD__}}{{{del}}}{{else}}{{{json __VERSION__}}}{{/if}}
+  },
+  "templateVersion": {{{del}}},
+  "standard": {{{del}}}
+}

package/lib/content/post-dependabot.yml

@@ -1,7 +1,7 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
+name: Post Dependabot Actions
 
-name: "Post Dependabot Actions"
-on: pull_request
+on:
+  pull_request
 
 # https://docs.github.com/en/rest/overview/permissions-required-for-github-apps
 permissions:
@@ -10,26 +10,23 @@ permissions:
 jobs:
   Install:
     runs-on: ubuntu-latest
-    if: ${{ github.actor == 'dependabot[bot]' }}
+    if: github.actor == 'dependabot[bot]'
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '16'
+      {{> setupGit}}
+      {{> setupNode}}
       - name: Dependabot metadata
         id: metadata
         uses: dependabot/fetch-metadata@v1.1.1
         with:
-          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          github-token: "$\{{ secrets.GITHUB_TOKEN }}"
       - name: npm install and commit
-        if: ${{contains(steps.metadata.outputs.dependency-names, '@npmcli/template-oss')}}
+        if: contains(steps.metadata.outputs.dependency-names, '@npmcli/template-oss')
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          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
+          gh pr checkout $\{{ github.event.pull_request.number }}
+          npm install --no-scripts
+          npm run template-oss-apply
           git add .
           git commit -am "chore: postinstall for dependabot template-oss PR"
           git push

package/lib/content/pull-request.yml

@@ -1,27 +1,28 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
-
 name: Pull Request Linting
 
 on:
   pull_request:
-    types: [opened, reopened, edited, synchronize]
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
 
 jobs:
   check:
     name: Check PR Title or Commits
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '16'
+      {{> setupGit with=(obj fetch-depth=0)}}
+      {{> setupNode}}
       - name: Install deps
         run: |
           npm i -D @commitlint/cli @commitlint/config-conventional
       - name: Check commits OR PR title
         env:
-          PR_TITLE: ${{ github.event.pull_request.title }}
+          PR_TITLE: $\{{ github.event.pull_request.title }}
         run: |
-          npx commitlint -x @commitlint/config-conventional -V --from origin/main --to ${{ github.event.pull_request.head.sha }} || echo $PR_TITLE | npx commitlint -x @commitlint/config-conventional -V
+          npx commitlint -x @commitlint/config-conventional -V \
+            --from origin/main --to $\{{ github.event.pull_request.head.sha }} \
+            || echo $PR_TITLE | \
+            npx commitlint -x @commitlint/config-conventional -V

package/lib/content/release-please.yml

@@ -1,24 +1,31 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
-
-name: Release Please
+name: Release Please {{~#if isWorkspace}} - {{pkgName}}{{/if}}
 
 on:
   push:
+    {{#if pkgRelPath}}
+    paths:
+      - {{pkgRelPath}}/**
+    {{/if}}
     branches:
-      - main
+      {{#each branches}}
+      - {{.}}
+      {{/each}}
 
 jobs:
   release-please:
     runs-on: ubuntu-latest
     steps:
-      - uses: google-github-actions/release-please-action@v2
+      - uses: google-github-actions/release-please-action@v3
         id: release
         with:
           release-type: node
-          # If you change changelog-types be sure to also update commitlintrc.js
+          {{#if pkgRelPath}}
+          monorepo-tags: true
+          paths: {{pkgRelPath}}
+          {{/if}}
           changelog-types: >
-            [{"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}]
+            [
+              {{#each changelogTypes}}
+              {{{json .}}}{{#unless @last}},{{/unless}}
+              {{/each}}
+            ]

package/lib/content/setup-git.yml

@@ -0,0 +1,11 @@
+- uses: actions/checkout@v3
+{{#if with}}
+  with:
+  {{#each with}}
+    {{@key}}: {{this}}
+  {{/each}}
+{{/if}}
+- name: Setup git user
+  run: |
+    git config --global user.email "ops+npm-cli@npmjs.com"
+    git config --global user.name "npm cli ops bot"

package/lib/content/setup-node.yml

@@ -0,0 +1,21 @@
+- uses: actions/setup-node@v3
+  with:
+    node-version: {{#each ciVersions}}{{#if @last}}{{.}}{{/if}}{{/each}}
+- name: Update to workable npm (windows)
+  # node 12 and 14 ship with npm@6, which is known to fail when updating itself in 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 to 7
+  # If we do test on npm 10 it needs npm7
+  if: matrix.node-version <= 10
+  run: npm i --prefer-online --no-fund --no-audit -g npm@7
+- name: Update npm to latest
+  if: matrix.node-version > 10
+  run: npm i --prefer-online --no-fund --no-audit -g npm@latest
+- run: npm -v

package/lib/index.js

@@ -0,0 +1,100 @@
+const log = require('proc-log')
+const { defaults } = require('lodash')
+const getConfig = require('./config.js')
+const PackageJson = require('@npmcli/package-json')
+const mapWorkspaces = require('@npmcli/map-workspaces')
+
+const getPkg = async (path, baseConfig) => {
+  log.verbose('get-pkg', path)
+
+  const pkg = (await PackageJson.load(path)).content
+  const pkgConfig = getConfig.getPkgConfig(pkg)
+  log.verbose('get-pkg', pkgConfig)
+
+  return { pkg, path, config: { ...baseConfig, ...pkgConfig } }
+}
+
+const getWsPkgs = async (root, rootPkg) => {
+  const wsPkgs = []
+
+  // workspaces are only used to filter paths and control changes to workspaces
+  // so dont pass it along with the rest of the config
+  const { workspaces, ...baseConfig } = rootPkg.config
+
+  // Include all by default
+  const include = (name) => Array.isArray(workspaces) ? workspaces.includes(name) : true
+
+  // Look through all workspaces on the root pkg
+  const rootWorkspaces = await mapWorkspaces({ pkg: rootPkg.pkg, cwd: root })
+
+  for (const [wsName, wsPath] of rootWorkspaces.entries()) {
+    if (include(wsName)) {
+      // A workspace can control its own workspaceRepo and workspaceModule settings
+      // which are true by default on the root config
+      wsPkgs.push(await getPkg(wsPath, baseConfig))
+    }
+  }
+
+  return {
+    pkgs: wsPkgs,
+    paths: [...rootWorkspaces.values()],
+  }
+}
+
+const getPkgs = async (root) => {
+  log.verbose('get-pkgs', 'root', root)
+
+  const rootPkg = await getPkg(root)
+  const pkgs = [rootPkg]
+
+  defaults(rootPkg.config, {
+    rootRepo: true,
+    rootModule: true,
+    workspaceRepo: true,
+    workspaceModule: true,
+    workspaces: null,
+  })
+
+  const ws = await getWsPkgs(root, rootPkg)
+
+  return {
+    pkgs: pkgs.concat(ws.pkgs),
+    workspaces: ws.paths,
+  }
+}
+
+const runAll = async (root, content, checks) => {
+  const results = []
+  const { pkgs, workspaces } = await getPkgs(root)
+
+  for (const { pkg, path, config } of pkgs) {
+    // full config includes original config values
+    const fullConfig = await getConfig({
+      pkgs,
+      workspaces,
+      root,
+      pkg,
+      path,
+      config,
+      content,
+    })
+
+    const options = { root, pkg, path, config: fullConfig }
+    log.verbose('run-all', options)
+
+    // files can export multiple checks so flatten first
+    for (const { when, run, name } of checks.flat()) {
+      log.info('attempting to run', name)
+      if (await when(options)) {
+        log.info('running', name)
+        results.push(await run(options))
+      }
+    }
+  }
+
+  // checks can return multiple results or nothing
+  // so flatten first and remove nulls before returning
+  return results.flat().filter(Boolean)
+}
+
+module.exports = runAll

package/lib/util/files.js

@@ -0,0 +1,43 @@
+const { join } = require('path')
+const { promisify } = require('util')
+const glob = promisify(require('glob'))
+const Parser = require('./parser.js')
+const template = require('./template.js')
+
+// target paths need to be joinsed with dir and templated
+const fullTarget = (dir, file, options) => join(dir, template(file, options))
+
+// given an obj of files, return the full target/source paths and associated parser
+const getParsers = (dir, files, options) => Object.entries(files).map(([t, s]) => {
+  let { file, parser: fileParser } = typeof s === 'string' ? { file: s } : s
+  const target = fullTarget(dir, t, options)
+  file = join(options.config.sourceDir, file)
+  if (fileParser) {
+    // allow files to extend base parsers or create new ones
+    return new (fileParser(Parser.Parsers))(target, file, options)
+  }
+  return new (Parser(file))(target, file, options)
+})
+
+const rmEach = async (dir, files, options, fn) => {
+  const res = []
+  for (const target of files.map((t) => fullTarget(dir, t, options))) {
+    for (const file of await glob(target, { cwd: dir })) {
+      res.push(await fn(file))
+    }
+  }
+  return res.filter(Boolean)
+}
+
+const parseEach = async (dir, files, options, fn) => {
+  const res = []
+  for (const parser of getParsers(dir, files, options)) {
+    res.push(await fn(parser))
+  }
+  return res.filter(Boolean)
+}
+
+module.exports = {
+  rmEach,
+  parseEach,
+}

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

@@ -0,0 +1,24 @@
+const hgi = require('hosted-git-info')
+const git = require('@npmcli/git')
+
+// parse a repo from a git origin into a format
+// for a package.json#repository object
+const getRepo = async (path) => {
+  if (!await git.is({ cwd: path })) {
+    return
+  }
+
+  try {
+    const res = await git.spawn([
+      'remote',
+      'get-url',
+      'origin',
+    ], { cwd: path })
+    const { domain, user, project } = hgi.fromUrl(res.stdout.trim())
+    const url = new URL(`https://${domain}`)
+    url.pathname = `/${user}/${project}.git`
+    return url.toString()
+  } catch {}
+}
+
+module.exports = getRepo

package/lib/util/has-package.js

@@ -0,0 +1,30 @@
+const intersects = require('semver/ranges/intersects')
+const { has } = require('lodash')
+
+const installLocations = [
+  'dependencies',
+  'devDependencies',
+  'peerDependencies',
+  'bundledDependencies',
+  'optionalDependencies',
+]
+
+const hasPackage = (
+  pkg,
+  name,
+  version = '*',
+  locations = installLocations
+) => locations
+  .map((l) => pkg[l])
+  .some((deps) =>
+    has(deps, name) &&
+    (version === '*' || intersects(deps[name], version))
+  )
+
+module.exports = hasPackage
+
+module.exports.flags = installLocations.reduce((acc, location) => {
+  const type = location.replace(/dependencies/i, '')
+  acc[location] = '--save' + (type ? `-${type}` : '')
+  return acc
+}, {})

package/lib/util/json-diff.js

@@ -0,0 +1,38 @@
+const { format } = require('util')
+const { get } = require('lodash')
+const { diff } = require('just-diff')
+
+const j = (obj, replacer = null) => JSON.stringify(obj, replacer, 2)
+
+const jsonDiff = (s1, s2, DELETE) => {
+  // DELETE is a special string that will be the value of updated if it exists
+  // but should be deleted
+
+  const ops = diff(s1, s2).map(({ op, path, value }) => {
+    // there could be cases where a whole object is reported
+    // as missing and the expected value does not need to show
+    // special DELETED values so filter those out here
+    const msgVal = j(value, (_, v) => v === DELETE ? undefined : v)
+    const prev = j(get(s1, path))
+    const key = j(path.reduce((acc, p) => acc + (typeof p === 'number' ? `[${p}]` : `.${p}`)))
+
+    const msg = (...args) => format('%s is %s, expected %s', ...args)
+    const AD = msg(key, 'missing', msgVal)
+    const RM = msg(key, prev, 'to be removed')
+    const UP = msg(key, prev, msgVal)
+
+    if (op === 'replace') {
+      return value === DELETE ? RM : UP
+    } else if (op === 'add' && value !== DELETE) {
+      return AD
+    }
+  }).filter(Boolean).sort((a, b) => a.localeCompare(b))
+
+  if (!ops.length) {
+    return true
+  }
+
+  return ops.join('\n')
+}
+
+module.exports = jsonDiff

package/lib/util/output.js

@@ -0,0 +1,35 @@
+const indent = (v, i = 2) => {
+  if (Array.isArray(v)) {
+    return v.map((a) => indent(a, i)).join('\n')
+  }
+  return v.toString().split('\n').map((l) => ' '.repeat(i) + l).join('\n')
+}
+
+const output = () => {
+  const res = []
+  const push = (...parts) => res.push(parts.join('\n'))
+  return {
+    toString: () => res.join('\n'),
+    sep: () => push('', '-'.repeat(67), ''),
+    push,
+  }
+}
+
+const outputProblems = (problems) => {
+  const o = output()
+  o.push('', 'Some problems were detected:')
+  o.sep()
+  for (const { title, body, solution } of problems) {
+    const [solutionTitle, ...solutionRest] = Array.isArray(solution)
+      ? solution : [solution]
+    o.push(title, '', indent(body), '', `To correct it: ${solutionTitle}`)
+    if (solutionRest.length) {
+      o.push('', indent(solutionRest))
+    }
+    o.sep()
+  }
+
+  return o.toString()
+}
+
+module.exports = outputProblems

package/lib/util/parse-ci-versions.js

@@ -0,0 +1,78 @@
+const semver = require('semver')
+const { partition, uniq, groupBy } = require('lodash')
+
+// try to parse a version. if its invalid then
+// try to parse it as a range instead
+const versionOrRange = (v) => semver.parse(v) || new semver.Range(v)
+
+// get the version or the upper bound of the range
+// used for sorting to give the latest ci target
+const getMaxVersion = (v) => v.version || v.set[0][1].semver.version
+
+// given an array of versions, returns an object where
+// each key is a major and each value is a sorted list of versions
+const versionsByMajor = (versions) => {
+  const majors = groupBy(versions, (v) => semver.major(v))
+  for (const [k, vs] of Object.entries(majors)) {
+    majors[k] = semver.sort(vs)[0]
+  }
+  return majors
+}
+
+// given a list of semver ci targets like:
+// ['12.13.0', '12.x', '14.15.0', '14.x', '16.0.0', '16.x']
+// this will parse into a uniq list of lowest "supported"
+// versions. In our cases so that will return
+// '^12.13.0 || ^14.15.0 || >=16'. This is not super generic but fits
+// our use case for now where we want to test on a bunch of
+// specific versions/ranges and map them to somewhat loose
+// semver range for package.json#engines.node. This only supports
+// returning ^ ranges and makes the last version >= currently.
+//
+// Assumptions:
+// - ranges span a single major version
+// - specific versions are lower then the upper bound of
+//   ranges within the same major version
+const parseCITargets = (targets = []) => {
+  const [versions, ranges] = partition(
+    targets.map((t) => versionOrRange(t)),
+    (t) => t.version
+  )
+
+  const sorted = [...versions, ...ranges]
+    .sort((a, b) => semver.compareBuild(getMaxVersion(a), getMaxVersion(b)))
+    .map((v) => v.version || v.raw)
+
+  // object of {major: lowestVersion } for all passed in versions
+  const minVersions = versionsByMajor(versions)
+
+  // object of {major: lowestVersionInRange } for all passed in ranges
+  const minRanges = versionsByMajor(ranges.map((r) => semver.minVersion(r)))
+
+  // Given all the uniq major versions in targets...
+  const parsedRanges = uniq([...Object.keys(minVersions), ...Object.keys(minRanges)])
+    // first sort by major to make it display nicer
+    .sort((a, b) => Number(a) - Number(b))
+    .map((major) => {
+      const minVersion = minVersions[major]
+      const minRange = minRanges[major]
+      // if we only have one then return that
+      if (!minVersion || !minRange) {
+        return minVersion || minRange
+      }
+      // otherwise return min version
+      // XXX: this assumes the versions are lower than the upper
+      // bound for any range for the same major. This is ok for
+      // now but will break with more complex/specific semver ranges
+      return minVersion
+    })
+    // make the last version allow all greater than
+    .map((v, index, list) => (index === list.length - 1 ? '>=' : '^') + v)
+
+  return {
+    targets: sorted,
+    engines: parsedRanges.join(' || '),
+  }
+}
+
+module.exports = parseCITargets