@npmcli/template-oss 4.7.0 → 4.8.0

package/lib/check/check-engines.js

@@ -0,0 +1,48 @@
+const semver = require('semver')
+const { relative, join } = require('path')
+const Arborist = require('@npmcli/arborist')
+
+const run = async ({ root, path, pkg, config: { omitEngines = [] } }) => {
+  const pkgPath = join(relative(root, path), 'package.json')
+  const arb = new Arborist({ path })
+  const tree = await arb.loadActual({ forceActual: true })
+
+  const engines = pkg.engines.node
+  const deps = await tree.querySelectorAll(`#${pkg.name} > .prod:attr(engines, [node])`)
+
+  const invalid = []
+  for (const dep of deps) {
+    if (omitEngines.includes(dep.name)) {
+      continue
+    }
+
+    const depEngines = dep.target.package.engines.node
+    if (!semver.subset(engines, depEngines)) {
+      invalid.push({
+        name: `${dep.name}@${dep.version}`,
+        location: dep.location,
+        engines: depEngines,
+      })
+    }
+  }
+
+  if (invalid.length) {
+    const title = `The following production dependencies are not compatible with ` +
+      `\`engines.node: ${engines}\` found in \`${pkgPath}\`:`
+    return {
+      title,
+      body: invalid.map((dep) => [
+        `${dep.name}:`,
+        `  engines.node: ${dep.engines}`,
+        `  location: ${dep.location}`,
+      ].join('\n')).join('\n'),
+      solution: 'Remove them or move them to devDependencies.',
+    }
+  }
+}
+
+module.exports = {
+  run,
+  when: ({ pkg, config: c }) => c.applyModule && pkg.engines?.node,
+  name: 'check-engines',
+}

package/lib/check/index.js

@@ -6,4 +6,5 @@ module.exports = (root) => run(root, [
   require('./check-unwanted.js'),
   require('./check-gitignore.js'),
   require('./check-changelog.js'),
+  require('./check-engines.js'),
 ])

package/lib/config.js

@@ -21,9 +21,9 @@ const deglob = (v) => makePosix(v).replace(/[/*]+$/, '')
 const posixDir = (v) => `${v === '.' ? '' : deglob(v).replace(/\/$/, '')}${posix.sep}`
 const posixGlob = (str) => `${posixDir(str)}**`
 
-const getCmdPath = (key, { rootConfig, defaultConfig, isRoot, path, root }) => {
+const getCmdPath = (key, { rootConfig, defaultConfig, isRoot, pkg, rootPkg }) => {
   // Make a path relative from a workspace to the root if we are in a workspace
-  const wsToRoot = (p) => isRoot ? p : makePosix(join(relative(path, root), p))
+  const wsToRoot = (p) => isRoot ? p : makePosix(join(relative(pkg.path, rootPkg.path), p))
 
   const rootPath = rootConfig[key]
   const defaultPath = defaultConfig[key]
@@ -82,46 +82,39 @@ const getFiles = (path, rawConfig) => {
 }
 
 const getFullConfig = async ({
-  // the path to the root of the repo
-  root,
-  // the path to the package being operated on
-  // this is the same as root when operating on the root
-  path,
-  // the full contents of the package.json for this package
-  pkgJson,
-  // an array of all package info {pkgJson,path,config}[]
-  pkgs,
-  // an array of all workspaces in this repo
-  workspaces,
-  // the config from the package.json in the root
-  rootConfig: _rootConfig,
-  // the config from the package.json being operated on
-  pkgConfig: _pkgConfig,
+  // everything is an object or an array of objects with the following
+  // path: the path to the package root
+  // pkgJson: the package json path
+  // config: the template oss config from the package root
+  pkg, // the package currently being operated on
+  rootPkg, // the root pkg (same as pkg when operating on the root)
+  pkgs, // an array of all packages to be operated on
+  wsPkgs, // an array of all workspaces being operated
 }) => {
-  const isRoot = root === path
+  const isRoot = rootPkg.path === pkg.path
   const isWorkspace = !isRoot
-  const isMono = !!workspaces.length
+  const isMono = !!wsPkgs.length
   const isRootMono = isRoot && isMono
 
-  const isLatest = _pkgConfig.version === LATEST_VERSION
-  const isDogFood = pkgJson.name === NAME
+  const isLatest = pkg.config.version === LATEST_VERSION
+  const isDogFood = rootPkg.pkgJson.name === NAME
   const isForce = process.argv.includes('--force')
 
   // These config items are merged betweent the root and child workspaces and only come from
   // the package.json because they can be used to read configs from other the content directories
-  const mergedConfig = mergeConfigs(_rootConfig, _pkgConfig)
+  const mergedConfig = mergeConfigs(rootPkg.config, pkg.config)
 
   const defaultConfig = getConfig(DEFAULT_CONTENT)
   const [defaultFiles, defaultDir] = getFiles(DEFAULT_CONTENT, mergedConfig)
   const useDefault = mergedConfig.defaultContent && defaultConfig
 
-  const rootConfig = getConfig(_rootConfig.content, _rootConfig)
-  const [rootFiles, rootDir] = getFiles(_rootConfig.content, mergedConfig)
+  const rootConfig = getConfig(rootPkg.config.content, rootPkg.config)
+  const [rootFiles, rootDir] = getFiles(rootPkg.config.content, mergedConfig)
 
   // The content config only gets set from the package we are in, it doesn't inherit
   // anything from the root
   const rootPkgConfig = merge(useDefault, rootConfig)
-  const pkgConfig = merge(useDefault, getConfig(_pkgConfig.content, _pkgConfig))
+  const pkgConfig = merge(useDefault, getConfig(pkg.config.content, pkg.config))
   const [pkgFiles, pkgDir] = getFiles(mergedConfig.content, mergedConfig)
 
   // Files get merged in from the default content (that template-oss provides) as well
@@ -139,49 +132,60 @@ const getFullConfig = async ({
       ...getAddedFiles(repoFiles),
       // and allow all workspace repo level files in the root
       ...pkgs
-        .filter(p => p.path !== root && p.config.workspaceRepo !== false)
+        .filter(p => p.path !== rootPkg.path && p.config.workspaceRepo !== false)
         .flatMap(() => getAddedFiles(files.workspaceRepo)),
     ] : [],
   ]
 
   // root only configs
-  const npmPath = getCmdPath('npm', { rootConfig, defaultConfig, isRoot, path, root })
-  const npxPath = getCmdPath('npx', { rootConfig, defaultConfig, isRoot, path, root })
+  const npmPath = getCmdPath('npm', { rootConfig, defaultConfig, isRoot, pkg, rootPkg })
+  const npxPath = getCmdPath('npx', { rootConfig, defaultConfig, isRoot, pkg, rootPkg })
 
   // these are written to ci yml files so it needs to always use posix
-  const pkgPath = makePosix(relative(root, path)) || '.'
+  const pkgPath = makePosix(relative(rootPkg.path, pkg.path)) || '.'
 
   // we use the raw paths from the package.json workspaces as ignore patterns in
   // some cases. the workspaces passed in have already been run through map workspaces
-  const workspacePaths = (pkgJson.workspaces || []).map(deglob)
+  const workspacePaths = (pkg.pkgJson.workspaces || []).map(deglob)
+
+  const isPrivate = !!pkg.pkgJson.private
+  const isPublic = !isPrivate
+  const publicPkgs = pkgs.filter(p => !p.pkgJson.private)
+  const allPrivate = pkgs.every(p => p.pkgJson.private)
 
   // all derived keys
   const derived = {
     isRoot,
     isWorkspace,
+    isMono,
     // Some files are written to the base of a repo but will
     // include configuration for all packages within a monorepo
     // For these cases it is helpful to know if we are in a
     // monorepo since template-oss might be used only for
     // workspaces and not the root or vice versa.
     isRootMono,
-    isMono,
+    // public/private
+    isPublic,
+    isPrivate,
+    allPrivate,
+    // controls whether we are in a monorepo with any public workspaces
+    isMonoPublic: isMono && !!publicPkgs.filter(p => p.path !== rootPkg.path).length,
     // repo
-    repoDir: root,
+    repoDir: rootPkg.path,
     repoFiles,
     applyRepo: !!repoFiles,
     // module
-    moduleDir: path,
+    moduleDir: pkg.path,
     moduleFiles,
     applyModule: !!moduleFiles,
     // package
-    pkgName: pkgJson.name,
-    pkgNameFs: pkgJson.name.replace(/\//g, '-').replace(/@/g, ''),
+    pkgName: pkg.pkgJson.name,
+    pkgNameFs: pkg.pkgJson.name.replace(/\//g, '-').replace(/@/g, ''),
     // paths
     pkgPath,
     pkgDir: posixDir(pkgPath),
     pkgGlob: posixGlob(pkgPath),
-    pkgFlags: isWorkspace ? `-w ${pkgJson.name}` : '',
+    pkgFlags: isWorkspace ? `-w ${pkg.pkgJson.name}` : '',
     allFlags: isMono ? '-ws -iwr --if-present' : '',
     workspacePaths,
     workspaceGlobs: workspacePaths.map(posixGlob),
@@ -208,7 +212,9 @@ const getFullConfig = async ({
       ]),
       // these cant be sorted since they rely on order
       // to allow a previously ignored directoy
-      ...isRoot ? gitignore.allowDir(workspaces.map((p) => makePosix(relative(root, p)))) : [],
+      ...isRoot
+        ? gitignore.allowDir(wsPkgs.map((p) => makePosix(relative(rootPkg.path, p.path))))
+        : [],
     ],
     // needs update if we are dogfooding this repo, with force argv, or its
     // behind the current version
@@ -245,7 +251,7 @@ const getFullConfig = async ({
     derived.engines = pkgConfig.engines || engines
   }
 
-  const gitUrl = await getGitUrl(root)
+  const gitUrl = await getGitUrl(rootPkg.path)
   if (gitUrl) {
     derived.repository = {
       type: 'git',

package/lib/content/_step-audit.yml

@@ -1,2 +1,4 @@
-- name: Run Audit
-  run: {{ rootNpmPath }} audit
+- name: Run Production Audit
+  run: {{ rootNpmPath }} audit --omit=dev
+- name: Run Full Audit
+  run: {{ rootNpmPath }} audit --audit-level=none

package/lib/content/_step-checks.yml

@@ -1,7 +1,7 @@
 {{#if jobCheck.sha}}
 - name: Get Workflow Job
   uses: actions/github-script@v6
-  {{#if jobCheck.if}}if: {{ jobCheck.if }}{{/if}}
+  if: {{ jobCheck.sha }}
   id: check-output
   env:
     JOB_NAME: "{{#if jobName}}{{ jobName }}{{else}}{{ jobCheck.name }}{{/if}}"
@@ -21,7 +21,7 @@
       const job = data.jobs.find(j => j.name.endsWith(jobName))
       const jobUrl = job?.html_url
 
-      const shaUrl = `${context.serverUrl}/${owner}/${repo}/commit/{{ jobCheck.sha }}`
+      const shaUrl = `${context.serverUrl}/${owner}/${repo}/commit/$\{{ {{ jobCheck.sha }} }}`
 
       let summary = `This check is assosciated with ${shaUrl}\n\n`
 
@@ -37,18 +37,18 @@
   uses: LouisBrunner/checks-action@v1.3.1
   {{#if jobCheck.sha}}
   id: check
-  {{#if jobCheck.if}}if: {{ jobCheck.if }}{{/if}}
+  if: {{ jobCheck.sha }}
   {{else}}
-  if: always()
+  if: {{#if jobCheck.id}}{{ jobCheck.id }}{{else}}steps.check.outputs.check_id{{/if}} && always()
   {{/if}}
   with:
     token: $\{{ secrets.GITHUB_TOKEN }}
     {{#if jobCheck.sha}}
     status: {{#if jobCheck.status}}{{ jobCheck.status }}{{else}}in_progress{{/if}} 
     name: {{#if jobCheck.name}}{{ jobCheck.name }}{{else}}{{ jobName }}{{/if}}{{#if jobIsMatrix}} - $\{{ matrix.platform.name }} - $\{{ matrix.node-version }}{{/if}}
-    sha: {{ jobCheck.sha }}
+    sha: $\{{ {{ jobCheck.sha }} }}
     output: $\{{ steps.check-output.outputs.result }}
     {{else}}
-    conclusion: {{#if jobCheck.status}}{{ jobCheck.status }}{{else}}$\{{ job.status }}{{/if}}
-    check_id: {{#if jobCheck.id}}{{ jobCheck.id }}{{else}}$\{{ steps.check.outputs.check_id }}{{/if}}
+    conclusion: $\{{ {{#if jobCheck.status}}{{ jobCheck.status }}{{else}}job.status{{/if}} }}
+    check_id: $\{{ {{#if jobCheck.id}}{{ jobCheck.id }}{{else}}steps.check.outputs.check_id{{/if}} }}
     {{/if}}

package/lib/content/ci-release.yml

@@ -21,7 +21,7 @@ jobs:
   lint-all:
     {{> job
       jobName="Lint All"
-      jobCheck=(obj sha="${{ inputs.check-sha }}" if="inputs.check-sha")
+      jobCheck=(obj sha="inputs.check-sha")
       jobCheckout=(obj ref="${{ inputs.ref }}")
     }}
       {{> stepLint jobRunFlags=allFlags }}
@@ -30,7 +30,7 @@ jobs:
   test-all:
     {{> jobMatrix
       jobName="Test All"
-      jobCheck=(obj sha="${{ inputs.check-sha }}" if="inputs.check-sha")
+      jobCheck=(obj sha="inputs.check-sha")
       jobCheckout=(obj ref="${{ inputs.ref }}")
     }}
       {{> stepTest jobRunFlags=allFlags }}

package/lib/content/ci.yml

@@ -4,15 +4,6 @@ on:
   {{> onCi }}
 
 jobs:
-  engines:
-    {{> jobMatrix
-      jobName="Engines"
-      jobDepFlags="--engines-strict"
-      macCI=false
-      windowsCI=false
-      ciVersions=baseCiVersions
-    }}
-
   lint:
     {{> job jobName="Lint" }}
       {{> stepLint jobRunFlags=pkgFlags }}

package/lib/content/index.js

@@ -1,8 +1,8 @@
 const { name: NAME, version: LATEST_VERSION } = require('../../package.json')
 
-const isPublic = (p) => !p.pkg.private
+const isPublic = (p) => p.config.isPublic
 
-const sharedRoot = (name) => ({
+const sharedRootAdd = (name) => ({
   // release
   '.github/workflows/release.yml': {
     file: 'release.yml',
@@ -26,6 +26,11 @@ const sharedRoot = (name) => ({
       comment = null
     },
   },
+  // this lint commits which is only necessary for releases
+  '.github/workflows/pull-request.yml': {
+    file: 'pull-request.yml',
+    filter: isPublic,
+  },
   // ci
   '.github/matchers/tap.json': 'tap.json',
   [`.github/workflows/ci${name ? `-${name}` : ''}.yml`]: 'ci.yml',
@@ -46,6 +51,12 @@ const sharedRoot = (name) => ({
   },
 })
 
+const sharedRootRm = () => ({
+  '.github/workflows/pull-request.yml': {
+    filter: (p) => p.config.allPrivate,
+  },
+})
+
 // Changes applied to the root of the repo
 const rootRepo = {
   add: {
@@ -55,13 +66,13 @@ const rootRepo = {
     '.github/CODEOWNERS': 'CODEOWNERS',
     '.github/workflows/audit.yml': 'audit.yml',
     '.github/workflows/codeql-analysis.yml': 'codeql-analysis.yml',
-    '.github/workflows/pull-request.yml': 'pull-request.yml',
-    ...sharedRoot(),
+    ...sharedRootAdd(),
+  },
+  rm: {
+    '.github/workflows/release-test.yml': true,
+    '.github/workflows/release-please.yml': true,
+    ...sharedRootRm(),
   },
-  rm: [
-    '.github/workflows/release-test.yml',
-    '.github/workflows/release-please.yml',
-  ],
 }
 
 // These are also applied to the root of the repo
@@ -86,12 +97,13 @@ const rootModule = {
 // Changes for each workspace but applied to the root of the repo
 const workspaceRepo = {
   add: {
-    ...sharedRoot('{{ pkgNameFs }}'),
+    ...sharedRootAdd('{{ pkgNameFs }}'),
   },
-  rm: [
+  rm: {
     // These are the old release please files that should be removed now
-    '.github/workflows/release-please-{{ pkgNameFs }}.yml',
-  ],
+    '.github/workflows/release-please-{{ pkgNameFs }}.yml': true,
+    ...sharedRootRm(),
+  },
 }
 
 // Changes for each workspace but applied to the relative workspace dir

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

@@ -1,6 +1,6 @@
 {
   "separate-pull-requests": {{{ del }}},
-  "plugins": {{#if isMono }}["node-workspace"]{{ else }}{{{ del }}}{{/if}},
+  "plugins": {{#if isMonoPublic }}["node-workspace"]{{ else }}{{{ del }}}{{/if}},
   "exclude-packages-from-root": true,
   "group-pull-request-title-pattern": "chore: release ${version}",
   "pull-request-title-pattern": "chore: release${component} ${version}",

package/lib/content/release.yml

@@ -64,7 +64,7 @@ jobs:
             }
 
             return commentId
-      {{> stepChecks jobCheck=(obj name="Release" sha="${{ steps.release.outputs.pr-sha }}" if="steps.release.outputs.pr-number") }}
+      {{> stepChecks jobCheck=(obj name="Release" sha="steps.release.outputs.pr-sha") }}
 
   update:
     needs: release
@@ -92,8 +92,8 @@ jobs:
           git commit --all --amend --no-edit || true
           git push --force-with-lease
           echo "::set-output  name=sha::$(git rev-parse HEAD)"
-      {{> stepChecks jobName="Update - Release" jobCheck=(obj sha="${{ steps.commit.outputs.sha }}" name="Release" )}}
-      {{> stepChecks jobCheck=(obj id="${{ needs.release.outputs.check-id }}" )}}
+      {{> stepChecks jobName="Update - Release" jobCheck=(obj sha="steps.commit.outputs.sha" name="Release" )}}
+      {{> stepChecks jobCheck=(obj id="needs.release.outputs.check-id" )}}
 
   ci:
     name: CI - Release
@@ -119,7 +119,7 @@ jobs:
             result="success"
           fi
           echo "::set-output name=result::$result"
-      {{> stepChecks jobCheck=(obj id="${{ needs.update.outputs.check-id }}" status="${{ steps.needs-result.outputs.result }}") }}
+      {{> stepChecks jobCheck=(obj id="needs.update.outputs.check-id" status="steps.needs-result.outputs.result") }}
 
   post-release:
     needs: release

package/lib/index.js

@@ -40,10 +40,7 @@ const getWsPkgs = async (root, rootPkg) => {
     }
   }
 
-  return {
-    pkgs: wsPkgs,
-    paths: [...rootWorkspaces.values()],
-  }
+  return wsPkgs
 }
 
 const getPkgs = async (root) => {
@@ -51,32 +48,29 @@ const getPkgs = async (root) => {
 
   const rootPkg = await getPkg(root)
 
-  const ws = await getWsPkgs(root, rootPkg)
+  const wsPkgs = await getWsPkgs(root, rootPkg)
 
   return {
     rootPkg,
-    pkgs: [rootPkg].concat(ws.pkgs),
-    workspaces: ws.paths,
+    wsPkgs,
+    pkgs: [rootPkg].concat(wsPkgs),
   }
 }
 
 const runAll = async (root, checks) => {
   const results = []
-  const { pkgs, workspaces, rootPkg: { config: rootConfig } } = await getPkgs(root)
+  const { pkgs, rootPkg, wsPkgs } = await getPkgs(root)
 
-  for (const { pkgJson, path, config: pkgConfig } of pkgs) {
+  for (const pkg of pkgs) {
     // full config includes original config values
     const fullConfig = await getConfig({
-      root,
-      path,
-      pkgJson,
+      pkg,
       pkgs,
-      workspaces,
-      rootConfig,
-      pkgConfig,
+      rootPkg,
+      wsPkgs,
     })
 
-    const options = { root, path, pkg: pkgJson, config: fullConfig }
+    const options = { root, path: pkg.path, pkg: pkg.pkgJson, config: fullConfig }
     log.verbose('run-all', options)
 
     // files can export multiple checks so flatten first

package/lib/util/files.js

@@ -43,7 +43,14 @@ const getParsers = (dir, files, options) => {
 }
 
 const getRemovals = async (dir, files, options) => {
-  const targets = fileEntries(dir, files, options).map(([t]) => globify(t))
+  const targets = fileEntries(dir, files, options)
+    .filter(([, source]) => {
+      if (typeof source === 'object' && typeof source.filter === 'function') {
+        return source.filter(options)
+      }
+      return true
+    })
+    .map(([t]) => globify(t))
   const globs = await Promise.all(targets.map(t => glob(t, { cwd: dir })))
   return globs.flat()
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.7.0",
+  "version": "4.8.0",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {
@@ -17,7 +17,9 @@
     "test": "tap",
     "template-oss-apply": "template-oss-apply --force",
     "postlint": "template-oss-check",
-    "postinstall": "template-oss-apply"
+    "postinstall": "template-oss-apply",
+    "test-all": "npm run test -ws -iwr --if-present",
+    "lint-all": "npm run lint -ws -iwr --if-present"
   },
   "repository": {
     "type": "git",
@@ -34,6 +36,7 @@
     "@commitlint/cli": "^17.1.1",
     "@commitlint/config-conventional": "^17.1.0",
     "@isaacs/string-locale-compare": "^1.1.0",
+    "@npmcli/arborist": "^6.0.0",
     "@npmcli/git": "^4.0.0",
     "@npmcli/map-workspaces": "^3.0.0",
     "@npmcli/package-json": "^3.0.0",
@@ -64,14 +67,20 @@
   "tap": {
     "timeout": 600,
     "nyc-arg": [
+      "--exclude",
+      "workspace/test-workspace/**",
       "--exclude",
       "tap-snapshots/**"
-    ]
+    ],
+    "test-ignore": "^(workspace/test-workspace)/"
   },
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten."
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
-  }
+  },
+  "workspaces": [
+    "workspace/test-workspace"
+  ]
 }