@npmcli/template-oss 2.3.1 → 2.4.3

package/README.md

@@ -5,6 +5,28 @@ single devDependency.
 
 **CAUTION: THESE CHANGES WILL OVERWRITE ANY LOCAL FILES AND SETTINGS**
 
+### Configuration
+
+Configure the use of `template-oss` in the root `package.json`.
+
+```js
+{
+  name: 'my-package',
+  // ...
+  templateOSS: {
+    // copy repo specific files for the root pkg
+    applyRootRepoFiles: true,
+    // modify package.json and copy module specific files for the root pkg
+    applyRootModuleFiles: true,
+    // copy repo files for each whitelisted workspaces
+    applyWorkspaceRepoFiles: true,
+    // whitelist workspace by package name to modify package.json
+    // and copy module files
+    workspaces: ['workspace-package-name'],
+    version: '2.3.1'
+  }
+}
+
 ### `package.json` patches
 
 These fields will be set in the project's `package.json`:
@@ -58,13 +80,18 @@ These files will be copied, overwriting any existing files:
 - `LICENSE.md`
 - `SECURITY.md`
 
+### Dynamic Files
+
+Currently, the only dynamic file generated is a github workflow for a given workspace.
+`.github/workflows/ci-$$package-name$$.yml`
+
 #### Extending
 
 Place files in the `lib/content/` directory, use only the file name and remove
 any leading `.` characters (i.e. `.github/workflows/ci.yml` becomes `ci.yml`
 and `.gitignore` becomes `gitignore`).
 
-Modify the `content` object at the top of `lib/postinstall/copy-content.js` to include
+Modify the `repoFiles` and `moduleFiles` objects at the top of `lib/postinstall/copy-content.js` to include
 your new file. The object keys are destination paths, and values are source.
 
 ### `package.json` checks
@@ -76,4 +103,4 @@ is not configured properly, with steps to run to correct any problems.
 
 Add any unwanted packages to `unwantedPackages` in `lib/check.js`. Currently
 the best way to install any packages is to include them as `peerDependencies`
-in this repo.
+in this repo.

package/bin/npm-template-check.js

@@ -2,6 +2,7 @@
 
 const checkPackage = require('../lib/postlint/check-package.js')
 const checkGitIgnore = require('../lib/postlint/check-gitignore.js')
+const getConfig = require('../lib/config.js')
 
 const main = async () => {
   const {
@@ -12,10 +13,19 @@ const main = async () => {
     throw new Error('This package requires npm >7.21.1')
   }
 
-  const problems = [
-    ...(await checkPackage(root)),
-    ...(await checkGitIgnore(root)),
-  ]
+  const config = await getConfig(root)
+
+  const problemSets = []
+  for (const path of config.paths) {
+    if (path !== root || config.applyRootModuleFiles) {
+      problemSets.push(await checkPackage(path))
+    }
+    if (path !== root || config.applyRootRepoFiles) {
+      problemSets.push(await checkGitIgnore(path))
+    }
+  }
+
+  const problems = problemSets.flat()
 
   if (problems.length) {
     console.error('Some problems were detected:')

package/bin/postinstall.js

@@ -2,6 +2,7 @@
 
 const copyContent = require('../lib/postinstall/copy-content.js')
 const patchPackage = require('../lib/postinstall/update-package.js')
+const getConfig = require('../lib/config.js')
 
 const main = async () => {
   const {
@@ -14,12 +15,14 @@ const main = async () => {
     return
   }
 
-  const needsAction = await patchPackage(root)
-  if (!needsAction) {
-    return
-  }
+  const config = await getConfig(root)
+  for (const path of config.paths) {
+    if (!await patchPackage(path, root, config)) {
+      continue
+    }
 
-  await copyContent(root)
+    await copyContent(path, root, config)
+  }
 }
 
 module.exports = main().catch((err) => {

package/lib/config.js

@@ -0,0 +1,48 @@
+const PackageJson = require('@npmcli/package-json')
+const mapWorkspaces = require('@npmcli/map-workspaces')
+
+const defaultConfig = {
+  applyRootRepoFiles: true,
+  applyWorkspaceRepoFiles: true,
+  applyRootModuleFiles: true,
+  workspaces: [],
+  paths: [],
+}
+
+module.exports = async (root) => {
+  let pkg
+  let pkgError = false
+  try {
+    pkg = (await PackageJson.load(root)).content
+  } catch (e) {
+    pkgError = true
+  }
+  if (pkgError || !pkg.templateOSS) {
+    return {
+      ...defaultConfig,
+      paths: [root],
+    }
+  }
+  const config = {
+    ...defaultConfig,
+    ...pkg.templateOSS,
+  }
+  const workspaceMap = await mapWorkspaces({
+    pkg,
+    cwd: root,
+  })
+  const wsPaths = []
+  const workspaceSet = new Set(config.workspaces)
+  for (const [name, path] of workspaceMap.entries()) {
+    if (workspaceSet.has(name)) {
+      wsPaths.push(path)
+    }
+  }
+  config.workspacePaths = wsPaths
+
+  config.paths = config.paths.concat(config.workspacePaths)
+
+  config.paths.push(root)
+
+  return config
+}

package/lib/content/audit.yml

@@ -0,0 +1,23 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: Audit
+
+on:
+  schedule:
+    # "At 01:00 on Monday" https://crontab.guru/#0_1_*_*_1
+    - cron: "0 1 * * 1"
+  workflow_dispatch:
+
+jobs:
+  audit:
+    name: npm audit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - name: Install deps
+        run: npm i --package-lock
+      - name: Audit
+        run: npm audit

package/lib/content/ci-workspace.yml

@@ -0,0 +1,76 @@
+name: Node Workspace CI %%pkgname%%
+
+on:
+  pull_request:
+    paths:
+      - %%pkgpath%%/**
+    branches:
+      - '*'
+  push:
+    paths:
+      - %%pkgpath%%/**
+    branches:
+      - release-next
+      - latest
+  workflow_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the npm/cli repo
+      - uses: actions/checkout@v2
+      - name: Use Node.js 16.x
+        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
+
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: ['12.13.0', 12.x, '14.15.0', 14.x, '16.0.0', 16.x]
+        platform:
+          - os: ubuntu-latest
+            shell: bash
+          - os: macos-latest
+            shell: bash
+          - os: windows-latest
+            shell: bash
+          - os: windows-latest
+            shell: powershell
+
+    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

package/lib/content/ci.yml

@@ -8,6 +8,9 @@ on:
     branches:
       - main
       - latest
+  schedule:
+    # "At 02:00 on Monday" https://crontab.guru/#0_1_*_*_1
+    - cron: "0 2 * * 1"
 
 jobs:
   lint:
@@ -17,9 +20,8 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: '16'
-          cache: npm
       - run: npm i --prefer-online -g npm@latest
-      - run: npm ci
+      - run: npm i
       - run: npm run lint
 
   test:
@@ -47,7 +49,6 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
-          cache: npm
       - run: npm i --prefer-online -g npm@latest
-      - run: npm ci
+      - run: npm i
       - run: npm test --ignore-scripts

package/lib/content/commitlintrc.js

@@ -0,0 +1,11 @@
+// This file is automatically added by @npmcli/template-oss. Do not edit.
+
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  // If you change rules be sure to also update release-please.yml
+  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']],
+  },
+}

package/lib/content/dependabot.yml

@@ -0,0 +1,16 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  allow:
+    - dependency-type: direct
+  versioning-strategy: increase-if-necessary
+  commit-message:
+    prefix: deps
+    prefix-development: chore
+  labels:
+    - "dependencies"

package/lib/content/gitignore

@@ -4,11 +4,12 @@
 /*
 
 # keep these
+!/.commitlintrc.js
+!/.npmrc
 !/.eslintrc*
 !/.github
 !**/.gitignore
 !/package.json
-!/package-lock.json
 !/docs
 !/bin
 !/lib

package/lib/content/npmrc

@@ -0,0 +1,3 @@
+;This file is automatically added by @npmcli/template-oss. Do not edit.
+
+package-lock=false

package/lib/content/pull-request.yml

@@ -0,0 +1,27 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: Pull Request Linting
+
+on:
+  pull_request:
+    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'
+      - 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 }}
+        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

package/lib/content/release-please.yml

@@ -0,0 +1,25 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v2
+        id: release
+        with:
+          package-name: conventional-test
+          release-type: node
+          # If you change changelog-types be sure to also update commitlintrc.js
+          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}]

package/lib/postinstall/copy-content.js

@@ -1,44 +1,51 @@
 const { dirname, join, resolve } = require('path')
 const fs = require('@npmcli/fs')
+const PackageJson = require('@npmcli/package-json')
 
 const contentDir = resolve(__dirname, '..', 'content')
 
 // keys are destination paths in the target project
 // values are paths to contents relative to '../content/'
-const content = {
+const moduleFiles = {
   '.eslintrc.js': './eslintrc.js',
+  '.gitignore': './gitignore',
+  '.npmrc': './npmrc',
+  'SECURITY.md': './SECURITY.md',
+}
+
+const repoFiles = {
+  '.commitlintrc.js': './commitlintrc.js',
   '.github/workflows/ci.yml': './ci.yml',
   '.github/ISSUE_TEMPLATE/bug.yml': './bug.yml',
   '.github/ISSUE_TEMPLATE/config.yml': './config.yml',
   '.github/CODEOWNERS': './CODEOWNERS',
-  '.gitignore': './gitignore',
-  'LICENSE.md': './LICENSE.md',
-  'SECURITY.md': './SECURITY.md',
+  '.github/dependabot.yml': './dependabot.yml',
+  '.github/workflows/audit.yml': './audit.yml',
+  '.github/workflows/pull-request.yml': './pull-request.yml',
+  '.github/workflows/release-please.yml': './release-please.yml',
 }
 
+// currently no workspace moduleFiles
+// const workspaceContent = {}
+// const workspaceRootContent = {}
+
 const filesToDelete = [
-  // remove any other license files
-  /^LICENSE*/,
   // remove any eslint config files that aren't local to the project
   /^\.eslintrc\.(?!(local\.)).*/,
 ]
 
-// given a root directory, copy all files in the content map
-// after purging any files we need to delete
-const copyContent = async (root) => {
-  const contents = await fs.readdir(root)
-
-  for (const file of contents) {
-    if (filesToDelete.some((p) => p.test(file))) {
-      await fs.rm(join(root, file))
-    }
-  }
+const defaultConfig = {
+  applyRootRepoFiles: true,
+  applyWorkspaceRepoFiles: true,
+  applyRootModuleFiles: true,
+}
 
-  for (let [target, source] of Object.entries(content)) {
+const copyFiles = async (targetDir, files) => {
+  for (let [target, source] of Object.entries(files)) {
     source = join(contentDir, source)
-    target = join(root, target)
-    // if the target is a subdirectory of the root, mkdirp it first
-    if (dirname(target) !== root) {
+    target = join(targetDir, target)
+    // if the target is a subdirectory of the path, mkdirp it first
+    if (dirname(target) !== targetDir) {
       await fs.mkdir(dirname(target), {
         owner: 'inherit',
         recursive: true,
@@ -48,6 +55,62 @@ const copyContent = async (root) => {
     await fs.copyFile(source, target, { owner: 'inherit' })
   }
 }
-copyContent.content = content
+
+// given a root directory, copy all files in the content map
+// after purging any files we need to delete
+const copyContent = async (path, rootPath, config) => {
+  config = { ...defaultConfig, ...config }
+  const isWorkspace = path !== rootPath
+
+  const contents = await fs.readdir(path)
+
+  if (isWorkspace || config.applyRootModuleFiles) {
+    // delete files and copy moduleFiles if it's a workspace
+    // or if we enabled doing so for the root
+    for (const file of contents) {
+      if (filesToDelete.some((p) => p.test(file))) {
+        await fs.rm(join(path, file))
+      }
+    }
+    await copyFiles(path, moduleFiles)
+  }
+
+  if (!isWorkspace) {
+    if (config.applyRootRepoFiles) {
+      await copyFiles(rootPath, repoFiles)
+    }
+    return
+  } // only workspace now
+
+  // TODO: await copyFiles(path, workspaceFiles)
+  // if we ever have workspace specific files
+
+  if (config.applyWorkspaceRepoFiles) {
+    // 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',
+      recursive: true,
+      force: true,
+    })
+
+    let workflowData = await fs.readFile(
+      join(contentDir, './ci-workspace.yml'),
+      { encoding: 'utf-8' }
+    )
+
+    const relPath = path.substring(rootPath.length + 1)
+    workflowData = workflowData.replace(/%%pkgpath%%/g, relPath)
+    workflowData = workflowData.replace(/%%pkgname%%/g, workspaceName)
+
+    await fs.writeFile(join(workflowPath, workspaceFile), workflowData)
+  }
+}
+copyContent.moduleFiles = moduleFiles
+copyContent.repoFiles = repoFiles
 
 module.exports = copyContent

package/lib/postinstall/update-package.js

@@ -8,8 +8,6 @@ const {
 const changes = {
   author: 'GitHub Inc.',
   files: ['bin', 'lib'],
-  license: 'ISC',
-  templateVersion: TEMPLATE_VERSION,
   scripts: {
     lint: `eslint '**/*.js'`,
     postlint: 'npm-template-check',
@@ -26,33 +24,57 @@ const changes = {
   },
 }
 
-const patchPackage = async (root) => {
-  const pkg = await PackageJson.load(root)
+const patchPackage = async (path, root, config) => {
+  const pkg = await PackageJson.load(path)
 
   // If we are running this on itself, we always run the script.
   // We also don't set templateVersion in package.json because
   // its not relavent and would cause git churn after running
   // `npm version`.
   const isDogfood = pkg.content.name === TEMPLATE_NAME
+  const currentVersion = (pkg.content.templateOSS === undefined) ?
+    pkg.content.templateVersion : pkg.content.templateOSS.version
 
   // 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 (pkg.content.templateVersion === TEMPLATE_VERSION && !isDogfood) {
+  if (currentVersion === TEMPLATE_VERSION && !isDogfood) {
     return false
   }
 
-  // we build a new object here so our exported set of changes is not modified
-  const update = {
-    ...changes,
-    scripts: {
-      ...pkg.content.scripts,
-      ...changes.scripts,
+  const templateConfig = {
+    templateOSS: {
+      ...pkg.content.templateOSS,
+      ...{ version: TEMPLATE_VERSION },
     },
   }
 
+  let update
+
+  if (path === root && !config.applyRootModuleFiles) {
+    // only update templateVersion if we're skipping root module files
+    update = {
+      ...templateConfig,
+    }
+  } else {
+    // we build a new object here so our exported set of changes is not modified
+    update = {
+      ...changes,
+      scripts: {
+        ...pkg.content.scripts,
+        ...changes.scripts,
+      },
+      ...templateConfig,
+    }
+  }
+
   if (isDogfood) {
     delete update.templateVersion
+    delete update.templateOSS
+  } else {
+    if (pkg.content.templateVersion) {
+      update.templateVersion = undefined
+    }
   }
 
   pkg.update(update)

package/lib/postlint/check-package.js

@@ -1,6 +1,4 @@
 const PackageJson = require('@npmcli/package-json')
-
-const { name: TEMPLATE_NAME } = require('../../package.json')
 const patchPackage = require('../postinstall/update-package.js')
 
 const unwantedPackages = [
@@ -14,18 +12,8 @@ const hasOwn = (obj, key) => Object.prototype.hasOwnProperty.call(obj, key)
 
 const check = async (root) => {
   const pkg = (await PackageJson.load(root)).content
-
-  // templateVersion doesn't apply if we're on this repo
-  // since we always run the scripts here
-  const changes = Object.entries(patchPackage.changes).filter(([key]) => {
-    if (pkg.name === TEMPLATE_NAME && key === 'templateVersion') {
-      return false
-    }
-    return true
-  })
-
+  const changes = Object.entries(patchPackage.changes)
   const problems = []
-
   const incorrectFields = []
   // 1. ensure package.json changes have been applied
   for (const [key, value] of changes) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "2.3.1",
+  "version": "2.4.3",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/index.js",
   "bin": {
@@ -30,7 +30,9 @@
   "license": "ISC",
   "dependencies": {
     "@npmcli/fs": "^1.0.0",
+    "@npmcli/map-workspaces": "^2.0.0",
     "@npmcli/package-json": "^1.0.1",
+    "json-parse-even-better-errors": "^2.3.1",
     "which": "^2.0.2"
   },
   "files": [
@@ -46,7 +48,7 @@
     "tap": "*"
   },
   "peerDependencies": {
-    "@npmcli/eslint-config": "^1.0.0",
+    "@npmcli/eslint-config": "^2.0.0",
     "tap": "^15.0.9"
   },
   "tap": {