@npmcli/template-oss 2.9.0 → 3.0.0

package/lib/config.js

@@ -1,51 +1,162 @@
-const PackageJson = require('@npmcli/package-json')
-const mapWorkspaces = require('@npmcli/map-workspaces')
-
-const defaultConfig = {
-  applyRootRepoFiles: true,
-  applyWorkspaceRepoFiles: true,
-  applyRootModuleFiles: true,
-  workspaces: [],
-  paths: [],
-  force: false,
+const { relative, dirname, posix, win32 } = require('path')
+const log = require('proc-log')
+const { uniq, defaults } = require('lodash')
+const parseCIVersions = require('./util/parse-ci-versions.js')
+const getGitUrl = require('./util/get-git-url.js')
+const { name: NAME, version: LATEST_VERSION } = require('../package.json')
+
+const CONFIG_KEY = 'templateOSS'
+const getPkgConfig = (pkg) => pkg[CONFIG_KEY] || {}
+
+const getContent = (contentPath) => {
+  if (typeof contentPath === 'string') {
+    return defaults(require(contentPath), {
+      sourceDir: dirname(require.resolve(contentPath)),
+    })
+  } else {
+    // allow passing in content directly for tests
+    return contentPath
+  }
+}
+
+// falsy means no content of this type
+const getFiles = (config, content) => config ? content : null
+const getFileKeys = (files) => files ? Object.keys(files.add || {}) : []
+const negatePath = (p) => {
+  // XXX: this negates the first part of each path for the gitignore
+  // files. it might make sense to negate more specific portions of the
+  // path for some paths like workspaces. so instead of ignoring !/workspaces
+  // it would only ignore !/workspaces/a, !/workspaces/b, etc
+  const [first, ...parts] = p.split(posix.sep)
+  const isDir = parts.length > 0
+  return `!${posix.sep}${first}${isDir ? posix.sep : ''}`
 }
 
-module.exports = async (root) => {
-  let pkg
-  let pkgError = false
-  try {
-    pkg = (await PackageJson.load(root)).content
-  } catch (e) {
-    pkgError = true
+const makePosix = (str) => str.split(win32.sep).join(posix.sep)
+
+const getConfig = async ({
+  pkgs,
+  workspaces,
+  root,
+  path,
+  pkg,
+  // default content path is looked up via require.resolve
+  // so use the name of this module since package.json#main
+  // points to the content dir
+  content: contentPath = NAME,
+  config: {
+    rootRepo,
+    rootModule,
+    workspaceRepo,
+    workspaceModule,
+    version,
+    ...pkgContent
+  },
+}) => {
+  const isRoot = root === path
+  const isLatest = version === LATEST_VERSION
+  const isDogFood = pkg.name === NAME
+
+  // this is written to ci yml files so it needs to always use posix
+  const pkgRelPath = makePosix(relative(root, path))
+  const gitUrl = await getGitUrl(root)
+
+  const {
+    rootRepo: rootRepoContent,
+    rootModule: rootModuleContent,
+    workspaceRepo: workspaceRepoContent,
+    workspaceModule: workspaceModuleContent,
+    ...baseContent
+  } = getContent(contentPath)
+
+  let repoFiles, moduleFiles
+  const ignorePaths = []
+
+  if (isRoot) {
+    repoFiles = getFiles(rootRepo, rootRepoContent)
+    moduleFiles = getFiles(rootModule, rootModuleContent)
+    ignorePaths.push(
+      // allow workspace paths if they are set, this is directly from
+      // map-workspaces so normalize to posix paths for gitignore
+      ...workspaces.map((p) => makePosix(relative(root, p))),
+      // allow both the repo and module files since this is the root
+      ...getFileKeys(repoFiles),
+      ...getFileKeys(moduleFiles),
+      // allow all workspace repo level files
+      ...pkgs.filter((p) => p.path !== path).flatMap((p) =>
+        getFileKeys(getFiles(p.config.workspaceRepo, workspaceRepoContent))
+      )
+    )
+  } else {
+    repoFiles = getFiles(workspaceRepo, workspaceRepoContent)
+    moduleFiles = getFiles(workspaceModule, workspaceModuleContent)
+    // In a workspace gitignores are relative to the workspace dir
+    // so we should only allow added module files
+    ignorePaths.push(...getFileKeys(moduleFiles))
   }
-  if (pkgError || !pkg.templateOSS) {
-    return {
-      ...defaultConfig,
-      paths: [root],
-    }
+
+  // all derived keys
+  const derived = {
+    isRoot,
+    isWorkspace: !isRoot,
+    // repo
+    repoDir: root,
+    repoFiles,
+    applyRepo: !!repoFiles,
+    // module
+    moduleDir: path,
+    moduleFiles,
+    applyModule: !!moduleFiles,
+    // package
+    pkgName: pkg.name,
+    pkgNameFs: pkg.name.replace(/\//g, '-').replace(/@/g, ''),
+    pkgRelPath: pkgRelPath,
+    // force changes if we are dogfooding this repo or with force argv
+    // XXX: setup proper cli arg parsing
+    isForce: isDogFood || process.argv.includes('--force'),
+    isLatest,
+    needsUpdate: !isLatest,
+    // templateoss specific values
+    __NAME__: NAME,
+    __CONFIG_KEY__: CONFIG_KEY,
+    __VERSION__: LATEST_VERSION,
+    __DOGFOOD__: isDogFood,
   }
-  const config = {
-    ...defaultConfig,
-    ...pkg.templateOSS,
+
+  // merge the rest of base and pkg content to make the
+  // full content object
+  const content = { ...baseContent, ...pkgContent }
+
+  // set some defaults on content that can be overwritten unlike
+  // derived values which are calculated from other config
+  const contentDefaults = {}
+
+  if (Array.isArray(content.ciVersions)) {
+    const parsed = parseCIVersions(content.ciVersions)
+    contentDefaults.engines = parsed.engines
+    content.ciVersions = parsed.targets
+    log.verbose('config ci', parsed)
   }
-  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)
+
+  if (gitUrl) {
+    contentDefaults.repository = {
+      type: 'git',
+      url: gitUrl,
+      ...(pkgRelPath ? { directory: pkgRelPath } : {}),
     }
   }
-  config.workspacePaths = wsPaths
-
-  config.paths = config.paths.concat(config.workspacePaths)
 
-  config.paths.push(root)
+  contentDefaults.ignorePaths = uniq(
+    [...ignorePaths, ...(content.distPaths || [])].map(negatePath)
+  ).sort()
 
-  config.force = process.argv.indexOf('--force') !== -1
+  log.verbose('config', 'defaults', contentDefaults)
 
-  return config
+  return {
+    ...defaults(content, contentDefaults),
+    ...derived,
+  }
 }
+
+module.exports = getConfig
+module.exports.getPkgConfig = getPkgConfig

package/lib/content/CODEOWNERS

@@ -1 +1 @@
-*	@npm/cli-team
+* @npm/cli-team

package/lib/content/LICENSE.md

@@ -1,5 +1,3 @@
-<!-- This file is automatically added by @npmcli/template-oss. Do not edit. -->
-
 ISC License
 
 Copyright npm, Inc.

package/lib/content/SECURITY.md

@@ -1,3 +1 @@
-<!-- This file is automatically added by @npmcli/template-oss. Do not edit. -->
-
 Please send vulnerability reports through [hackerone](https://hackerone.com/github).

package/lib/content/audit.yml

@@ -1,23 +1,16 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
-
 name: Audit
 
 on:
+  workflow_dispatch:
   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
+      {{> setupGit}}
+      {{> setupNode }}
+      - run: npm i --package-lock
+      - run: npm audit

package/lib/content/bug.yml

@@ -1,54 +1,53 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
-
 name: Bug
 description: File a bug/issue
 title: "[BUG] <title>"
-labels: [Bug, Needs Triage]
+labels: [ Bug, Needs Triage ]
+
 body:
-- type: checkboxes
-  attributes:
-    label: Is there an existing issue for this?
-    description: Please [search here](./issues) to see if an issue already exists for your problem.
-    options:
-    - label: I have searched the existing issues
-      required: true
-- type: textarea
-  attributes:
-    label: Current Behavior
-    description: A clear & concise description of what you're experiencing.
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Expected Behavior
-    description: A clear & concise description of what you expected to happen.
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Steps To Reproduce
-    description: Steps to reproduce the behavior.
-    value: |
-      1. In this environment...
-      2. With this config...
-      3. Run '...'
-      4. See error...
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Environment
-    description: |
-      examples:
-        - **npm**: 7.6.3
-        - **Node**: 13.14.0
-        - **OS**: Ubuntu 20.04
-        - **platform**: Macbook Pro
-    value: |
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please [search here](./issues) to see if an issue already exists
+        for your problem.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: A clear & concise description of what you're experiencing.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A clear & concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      value: |
+        1. In this environment...
+        2. With this config...
+        3. Run '...'
+        4. See error...
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Environment
+      description: |
+        examples:
+          - **npm**: 7.6.3
+          - **Node**: 13.14.0
+          - **OS**: Ubuntu 20.04
+          - **platform**: Macbook Pro
+      value: |
         - npm:
         - Node:
         - OS:
         - platform:
-  validations:
-    required: false
-
+    validations:
+      required: false

package/lib/content/ci.yml

@@ -1,13 +1,23 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
-
-name: CI
+name: CI {{~#if isWorkspace}} - {{pkgName}}{{/if}}
 
 on:
+  workflow_dispatch:
   pull_request:
+    branches:
+      - '*'
+    {{#if pkgRelPath}}
+    paths:
+      - {{pkgRelPath}}
+    {{/if}}
   push:
     branches:
-      - main
-      - latest
+      {{#each branches}}
+      - {{.}}
+      {{/each}}
+    {{#if pkgRelPath}}
+    paths:
+      - {{pkgRelPath}}
+    {{/if}}
   schedule:
     # "At 02:00 on Monday" https://crontab.guru/#0_2_*_*_1
     - cron: "0 2 * * 1"
@@ -16,47 +26,34 @@ 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
+      {{> setupGit}}
+      {{> setupNode}}
       - run: npm i
-      - run: npm run lint
+      - run: npm run lint {{~#if isWorkspace}} -w {{pkgName}}{{/if}}
 
   test:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [12.13.0, 12.x, 14.15.0, 14.x, 16.13.0, 16.x]
+        node-version:
+          {{#each ciVersions}}
+          - {{.}}
+          {{/each}}
         platform:
-        - os: ubuntu-latest
-          shell: bash
-        - os: macos-latest
-          shell: bash
-        - os: windows-latest
-          shell: cmd
-    runs-on: ${{ matrix.platform.os }}
+          - os: ubuntu-latest
+            shell: bash
+          - os: macos-latest
+            shell: bash
+          {{#if windowsCI}}
+          - os: windows-latest
+            shell: cmd
+          {{/if}}
+    runs-on: $\{{ matrix.platform.os }}
     defaults:
       run:
-        shell: ${{ matrix.platform.shell }}
+        shell: $\{{ matrix.platform.shell }}
     steps:
-      - 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
+      {{> setupGit}}
+      {{> setupNode}}
       - run: npm i
-      - run: npm test --ignore-scripts
+      - run: npm test --ignore-scripts {{~#if isWorkspace}} -w {{pkgName}}{{/if}}

package/lib/content/codeql-analysis.yml

@@ -1,13 +1,17 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
-
 name: "CodeQL"
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      {{#each branches}}
+      - {{.}}
+      {{/each}}
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches:
+      {{#each branches}}
+      - {{.}}
+      {{/each}}
   schedule:
     # "At 03:00 on Monday" https://crontab.guru/#0_3_*_*_1
     - cron: "0 3 * * 1"
@@ -24,15 +28,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: [javascript]
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-
+    {{> setupGit}}
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1
       with:
-        languages: ${{ matrix.language }}
+        languages: $\{{ matrix.language }}
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v1

package/lib/content/commitlintrc.js

@@ -1,10 +1,7 @@
-// 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']],
+    'type-enum': [2, 'always', [{{#each changelogTypes}}'{{type}}'{{#unless @last}}, {{/unless}}{{/each}}]],
     'header-max-length': [2, 'always', 80],
     'subject-case': [0, 'always', ['lower-case', 'sentence-case', 'start-case']],
   },

package/lib/content/config.yml

@@ -1,3 +1 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
-
 blank_issues_enabled: true

package/lib/content/dependabot.yml

@@ -1,16 +1,15 @@
-# 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
-  commit-message:
-    prefix: deps
-    prefix-development: chore
-  labels:
-    - "Dependencies"
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: daily
+    allow:
+      - dependency-type: direct
+    versioning-strategy: increase
+    commit-message:
+      prefix: deps
+      prefix-development: chore
+    labels:
+      - "Dependencies"

package/lib/content/eslintrc.js

@@ -1,5 +1,3 @@
-// This file is automatically added by @npmcli/template-oss. Do not edit.
-
 const { readdirSync: readdir } = require('fs')
 
 const localConfigs = readdir(__dirname)

package/lib/content/gitignore

@@ -1,23 +1,17 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
-
 # ignore everything in the root
 /*
 
 # keep these
-!/.commitlintrc.js
-!/.npmrc
-!/.eslintrc*
-!/.github
+!/.eslintrc.local.*
 !**/.gitignore
-!/package.json
-!/docs
-!/bin
-!/lib
+!/docs/
+!/tap-snapshots/
+!/test/
 !/map.js
-!/tap-snapshots
-!/test
-!/scripts
+!/scripts/
 !/README*
 !/LICENSE*
-!/SECURITY*
 !/CHANGELOG*
+{{#each ignorePaths}}
+{{.}}
+{{/each}}

package/lib/content/index.js

@@ -0,0 +1,90 @@
+// Changes applied to the root of the repo
+const rootRepo = {
+  add: {
+    '.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',
+    '.github/dependabot.yml': 'dependabot.yml',
+    '.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': 'release-please.yml',
+  },
+}
+
+// These are also applied to the root of the repo
+// but can by controlled by the `rootModule` config
+// XXX: im not sure the distinction between repo
+// and module in the root. both are applied to the same
+// dir. so we might want to combine these
+const rootModule = {
+  add: {
+    '.eslintrc.js': 'eslintrc.js',
+    '.gitignore': 'gitignore',
+    '.npmrc': 'npmrc',
+    'SECURITY.md': 'SECURITY.md',
+    'package.json': 'package.json',
+  },
+  rm: [
+    '.eslintrc.!(js|local.*)',
+  ],
+}
+
+// Changes for each workspace but applied to the root of the repo
+const workspaceRepo = {
+  add: {
+    '.github/workflows/release-please-{{pkgNameFs}}.yml': 'release-please.yml',
+    '.github/workflows/ci-{{pkgNameFs}}.yml': 'ci.yml'
+  },
+}
+
+// Changes for each workspace but applied to the relative workspace dir
+const workspaceModule = {
+  add: {
+    '.eslintrc.js': 'eslintrc.js',
+    '.gitignore': 'gitignore',
+    'package.json': 'package.json',
+  },
+  rm: [
+    '.npmrc',
+    '.eslintrc.!(js|local.*)',
+  ],
+}
+
+module.exports = {
+  rootRepo,
+  rootModule,
+  workspaceRepo,
+  workspaceModule,
+  windowsCI: true,
+  branches: ['main', 'latest'],
+  distPaths: ['bin/', 'lib/'],
+  ciVersions: ['12.13.0', '12.x', '14.15.0', '14.x', '16.0.0', '16.x'],
+  unwantedPackages: [
+    'eslint',
+    'eslint-plugin-node',
+    '@npmcli/lint',
+    'eslint-plugin-promise',
+    'eslint-plugin-standard',
+    'eslint-plugin-import',
+    'standard',
+  ],
+  requiredPackages: {
+    devDependencies: {
+      '@npmcli/template-oss': '*',
+      '@npmcli/eslint-config': '>=3.0.0',
+      tap: '>=15.0.0',
+    },
+  },
+  allowedPackages: [],
+  changelogTypes: [
+    { 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/content/npmrc

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