@npmcli/template-oss 1.0.0 → 2.0.0

package/LICENSE.md

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

package/bin/npm-template-check.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+const check = require('../lib/check.js')
+
+const main = async () => {
+  const {
+    npm_config_local_prefix: root,
+  } = process.env
+
+  if (!root) {
+    throw new Error('This package requires npm >7.21.1')
+  }
+
+  const problems = await check(root)
+  if (problems.length) {
+    console.error('Some problems were detected:')
+    console.error()
+    console.error(problems.map((problem) => problem.message).join('\n'))
+    console.error()
+    console.error('To correct them:')
+    console.error(problems.map((problem) => problem.solution).join('\n'))
+    process.exitCode = 1
+  }
+}
+
+module.exports = main().catch((err) => {
+  console.error(err.stack)
+  process.exitCode = 1
+})

package/bin/postinstall.js

@@ -1,28 +1,30 @@
 #!/usr/bin/env node
 
-const { dirname } = require('path')
-
 const copyContent = require('../lib/content/index.js')
-const installPackages = require('../lib/install.js')
 const patchPackage = require('../lib/package.js')
 
 const main = async () => {
-  const pkgPath = process.env.npm_package_json
-  if (!pkgPath) {
-    throw new Error('This script must be run as an npm lifecycle event')
-  }
+  const {
+    npm_config_global: globalMode,
+    npm_config_local_prefix: root,
+  } = process.env
 
-  const root = dirname(pkgPath)
+  // do nothing in global mode or when the local prefix isn't set
+  if (globalMode === 'true' || !root) {
+    return
+  }
 
   const needsAction = await patchPackage(root)
-  if (needsAction) {
-    await copyContent(root)
-    return installPackages(root)
+  if (!needsAction) {
+    return
   }
+
+  return copyContent(root)
 }
 
-// we export the promise so it can be awaited in tests
-module.exports = main().catch((err) => {
+// we export the promise so it can be awaited in tests, coverage is disabled
+// for the catch handler because it does so little it's not worth testing
+module.exports = main().catch(/* istanbul ignore next */ (err) => {
   console.error(err.stack)
   process.exitCode = 1
 })

package/lib/check.js

@@ -0,0 +1,95 @@
+const { join } = require('path')
+const fs = require('@npmcli/fs')
+
+const patchPackage = require('./package.js')
+
+const unwantedPackages = [
+  '@npmcli/lint',
+  'eslint-plugin-promise',
+  'eslint-plugin-standard',
+  'eslint-plugin-import',
+]
+
+const hasOwn = (obj, key) => Object.prototype.hasOwnProperty.call(obj, key)
+
+const check = async (root) => {
+  const pkgPath = join(root, 'package.json')
+  try {
+    var contents = await fs.readFile(pkgPath, { encoding: 'utf8' })
+  } catch (err) {
+    throw new Error('No package.json found')
+  }
+
+  const pkg = JSON.parse(contents)
+
+  const problems = []
+
+  const incorrectFields = []
+  // 1. ensure package.json changes have been applied
+  for (const [key, value] of Object.entries(patchPackage.changes)) {
+    if (!hasOwn(pkg, key)) {
+      incorrectFields.push({
+        name: key,
+        found: pkg[key],
+        expected: value,
+      })
+      continue
+    }
+
+    if (value && typeof value === 'object') {
+      for (const [subKey, subValue] of Object.entries(value)) {
+        if (!hasOwn(pkg[key], subKey) ||
+          pkg[key][subKey] !== subValue) {
+          incorrectFields.push({
+            name: `${key}.${subKey}`,
+            found: pkg[key][subKey],
+            expected: subValue,
+          })
+        }
+      }
+    } else {
+      if (pkg[key] !== patchPackage.changes[key]) {
+        incorrectFields.push({
+          name: key,
+          found: pkg[key],
+          expected: value,
+        })
+      }
+    }
+  }
+
+  if (incorrectFields.length) {
+    problems.push({
+      message: [
+        `The following package.json fields are incorrect:`,
+        ...incorrectFields.map((field) => {
+          const { name, found, expected } = field
+          return `  Field: "${name}" Expected: "${expected}" Found: "${found}"`
+        }),
+      ].join('\n'),
+      solution: 'npm rm @npmcli/template-oss && npm i -D @npmcli/template-oss',
+    })
+  }
+
+  // 2. ensure packages that should not be present are removed
+  const mustRemove = unwantedPackages.filter((name) => {
+    return hasOwn(pkg.dependencies || {}, name) ||
+      hasOwn(pkg.devDependencies || {}, name)
+  })
+
+  if (mustRemove.length) {
+    problems.push({
+      message: [
+        'The following unwanted packages were found:',
+        ...mustRemove,
+      ].join(' '),
+      solution: `npm rm ${mustRemove.join(' ')}`,
+    })
+  }
+
+  return problems
+}
+
+check.unwantedPackages = unwantedPackages
+
+module.exports = check

package/lib/content/LICENSE.md

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

package/lib/content/SECURITY.md

@@ -0,0 +1 @@
+Please send vulnerability reports through [hackerone](https://hackerone.com/github).

package/lib/content/bug.yml

@@ -0,0 +1,54 @@
+# 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]
+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: |
+        - npm:
+        - Node:
+        - OS:
+        - platform:
+  validations:
+    required: false
+

package/lib/content/ci.yml

@@ -1,3 +1,5 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
 name: CI
 
 on:
@@ -24,7 +26,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [10.0.x, 10.x, 12.0.x, 12.x, 14.0.x, 14.x, 15.x, 16.x]
+        node-version: [12.13.0, 12.x, 14.15.0, 14.x, 16.x]
         platform:
         - os: ubuntu-latest
           shell: bash

package/lib/content/config.yml

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

package/lib/content/eslintrc.js

@@ -1,3 +1,5 @@
+// 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,3 +1,5 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
 # ignore everything in the root
 /*
 

package/lib/content/index.js

@@ -6,8 +6,11 @@ const fs = require('@npmcli/fs')
 const content = {
   '.eslintrc.js': './eslintrc.js',
   '.github/workflows/ci.yml': './ci.yml',
+  '.github/ISSUE_TEMPLATE/bug.yml': './bug.yml',
+  '.github/ISSUE_TEMPLATE/config.yml': './config.yml',
   '.gitignore': './gitignore',
   'LICENSE.md': './LICENSE.md',
+  'SECURITY.md': './SECURITY.md',
 }
 
 // given a root directory, copy all files in the content map

package/lib/package.js

@@ -9,6 +9,7 @@ const changes = {
   templateVersion: TEMPLATE_VERSION,
   scripts: {
     lint: `eslint '**/*.js'`,
+    postlint: 'npm-template-check',
     lintfix: 'npm run lint -- --fix',
     preversion: 'npm test',
     postversion: 'npm publish',
@@ -17,6 +18,9 @@ const changes = {
     test: 'tap',
     posttest: 'npm run lint',
   },
+  engines: {
+    node: '^12.13.0 || ^14.15.0 || >=16',
+  },
 }
 
 const patchPackage = async (root) => {

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/index.js",
+  "bin": {
+    "npm-template-check": "bin/npm-template-check.js"
+  },
   "scripts": {
     "lint": "eslint '**/*.js'",
     "lintfix": "npm run lint -- --fix",
-    "preversion": "npm test",
+    "postinstall": "node bin/postinstall.js",
+    "postlint": "npm-template-check",
+    "posttest": "npm run lint",
     "postversion": "npm publish",
+    "prelint": "ln -sf ../../bin/npm-template-check.js node_modules/.bin/npm-template-check",
     "prepublishOnly": "git push origin --follow-tags",
+    "preversion": "npm test",
     "snap": "tap",
-    "test": "tap",
-    "posttest": "npm run lint",
-    "postinstall": "node bin/postinstall.js"
+    "test": "tap"
   },
   "repository": {
     "type": "git",
@@ -34,11 +39,17 @@
     "lib"
   ],
   "devDependencies": {
-    "@npmcli/eslint-config": "^1.0.0",
+    "@npmcli/eslint-config": "*",
     "eslint": "^7.32.0",
     "eslint-plugin-node": "^11.1.0",
-    "spawk": "^1.7.1",
+    "tap": "*"
+  },
+  "peerDependencies": {
+    "@npmcli/eslint-config": "^1.0.0",
     "tap": "^15.0.9"
   },
-  "templateVersion": "1.0.0"
+  "templateVersion": "1.0.3",
+  "engines": {
+    "node": "^12.13.0 || ^14.15.0 || >=16"
+  }
 }

package/lib/install.js

@@ -1,31 +0,0 @@
-const spawn = require('@npmcli/promise-spawn')
-
-const removeDeps = [
-  'eslint-plugin-import',
-  'eslint-plugin-promise',
-  'eslint-plugin-standard',
-  '@npmcli/lint',
-]
-
-const devDeps = [
-  'eslint',
-  'eslint-plugin-node',
-  '@npmcli/eslint-config',
-  'tap',
-]
-
-const npm = (root, args) => {
-  return spawn('npm', args, {
-    cwd: root,
-    stdioString: true,
-  })
-}
-
-const installPackages = async (root) => {
-  await npm(root, ['uninstall', ...removeDeps])
-  return npm(root, ['install', '--save-dev', ...devDeps])
-}
-installPackages.removeDeps = removeDeps
-installPackages.devDeps = devDeps
-
-module.exports = installPackages