@npmcli/template-oss 2.9.2 → 3.1.1

package/lib/util/parser.js

@@ -0,0 +1,280 @@
+const fs = require('@npmcli/fs')
+const { EOL } = require('os')
+const { basename, extname, dirname } = require('path')
+const yaml = require('yaml')
+const NpmPackageJson = require('@npmcli/package-json')
+const jsonParse = require('json-parse-even-better-errors')
+const Diff = require('diff')
+const { unset, merge } = require('lodash')
+const template = require('./template.js')
+const jsonDiff = require('./json-diff')
+const setFirst = (first, rest) => ({ ...first, ...rest })
+const traverse = (value, visit, keys = []) => {
+  if (keys.length) {
+    const res = visit(keys, value)
+    if (res != null) {
+      return
+    }
+  }
+  if (typeof value === 'object' && value !== null) {
+    for (const [k, v] of Object.entries(value)) {
+      traverse(v, visit, keys.concat(k))
+    }
+  }
+}
+
+class Base {
+  static types = []
+  static header = 'This file is automatically added by {{__NAME__}}. Do not edit.'
+  comment = (v) => v
+  merge = false // supply a merge function which runs on prepare for certain types
+  DELETE = template.DELETE
+
+  constructor (target, source, options) {
+    this.target = target
+    this.source = source
+    this.options = options
+  }
+
+  header () {
+    if (typeof this.comment === 'function') {
+      return this.comment(this.template(this.constructor.header || ''))
+    }
+  }
+
+  read (s) {
+    return fs.readFile(s, { encoding: 'utf-8' })
+  }
+
+  template (s) {
+    return template(s, this.options)
+  }
+
+  parse (s) {
+    return s
+  }
+
+  prepare (s) {
+    const header = this.header()
+    return header ? header + EOL + EOL + s : s
+  }
+
+  prepareTarget (s) {
+    return s
+  }
+
+  toString (s) {
+    return s.toString()
+  }
+
+  async write (s) {
+    // XXX: find more efficient way to do this. we can build all possible dirs before get here
+    await fs.mkdir(dirname(this.target), { owner: 'inherit', recursive: true, force: true })
+    return fs.writeFile(this.target, this.toString(s), { owner: 'inherit' })
+  }
+
+  diffPatch (t, s) {
+    // create a patch and strip out the filename. if it ends up an empty string
+    // then return true since the files are equal
+    return Diff.createPatch('', t.replace(/\r\n/g, '\n'), s.replace(/\r\n/g, '\n'))
+      .split('\n').slice(4).join('\n')
+  }
+
+  diff (t, s) {
+    return this.diffPatch(t, s)
+  }
+
+  // the apply methods are the only ones that should be called publically
+  // XXX: everything is allowed to be overridden in base classes but we could
+  // find a different solution than making everything public
+  applyWrite () {
+    return Promise.resolve(this.read(this.source))
+      // replace template vars first, this will throw for nonexistant vars
+      // because it must be parseable after this step
+      .then((s) => this.template(s))
+      // parse into whatever data structure is necessary for maniuplating
+      // diffing, merging, etc. by default its a string
+      .then((s) => this.parse(s))
+      // prepare the source for writing and diffing, pass in current
+      // target for merging. errors parsing or preparing targets are ok here
+      .then((s) => this.applyTarget().catch(() => null).then((t) => this.prepare(s, t)))
+      .then((s) => this.write(s))
+  }
+
+  applyTarget () {
+    return Promise.resolve(this.read(this.target))
+      .then((s) => this.parse(s))
+      // for only preparing the target for diffing
+      .then((s) => this.prepareTarget(s))
+  }
+
+  async applyDiff () {
+    const target = await this.applyTarget().catch((e) => {
+      // handle if old does not exist
+      if (e.code === 'ENOENT') {
+        return null
+      } else {
+        return { code: 'ETARGETERROR', error: e }
+      }
+    })
+
+    // no need to diff if current file does not exist
+    if (target === null) {
+      return null
+    }
+
+    const source = await Promise.resolve(this.read(this.source))
+      .then((s) => this.template(s))
+      .then((s) => this.parse(s))
+      // gets the target to diff against in case it needs to merge, etc
+      .then((s) => this.prepare(s, target))
+
+    // if there was a target error then there is no need to diff
+    // so we just show the source with an error message
+    if (target.code === 'ETARGETERROR') {
+      const msg = `[${this.options.config.__NAME__} ERROR]`
+      return [
+        `${msg} There was an erroring getting the target file`,
+        `${msg} ${target.error}`,
+        `${msg} It will be overwritten with the following source:`,
+        '-'.repeat(40),
+        this.toString(source),
+      ].join('\n')
+    }
+
+    // individual diff methods are responsible for returning a string
+    // representing the diff. an empty trimmed string means no diff
+    const diffRes = this.diff(target, source).trim()
+    return diffRes || true
+  }
+}
+
+class Gitignore extends Base {
+  static types = ['codeowners', 'gitignore']
+  comment = (c) => `# ${c}`
+}
+
+class Js extends Base {
+  static types = ['js']
+  comment = (c) => `/* ${c} */`
+}
+
+class Ini extends Base {
+  // XXX: add merge mode for updating ini files
+  static types = ['npmrc']
+  comment = (c) => `; ${c}`
+}
+
+class Markdown extends Base {
+  static types = ['md']
+  comment = (c) => `<!-- ${c} -->`
+}
+
+class Yml extends Base {
+  static types = ['yml']
+  comment = (c) => ` ${c}`
+
+  toString (s) {
+    return s.toString({ lineWidth: 0, indent: 2 })
+  }
+
+  parse (s) {
+    return yaml.parseDocument(s)
+  }
+
+  prepare (s) {
+    s.commentBefore = this.header()
+    return this.toString(s)
+  }
+
+  prepareTarget (s) {
+    return this.toString(s)
+  }
+}
+
+class Json extends Base {
+  static types = ['json']
+  // its a json comment! not really but we do add a special key
+  // to json objects
+  comment = (c) => ({ [`//${this.options.config.__NAME__}`]: c })
+
+  toString (s) {
+    return JSON.stringify(s, (_, v) => v === this.DELETE ? undefined : v, 2)
+  }
+
+  parse (s) {
+    return jsonParse(s)
+  }
+
+  prepare (s, t) {
+    let source = s
+    if (typeof this.merge === 'function' && t) {
+      source = this.merge(t, s)
+    }
+    return setFirst(this.header(), source)
+  }
+
+  diff (t, s) {
+    return jsonDiff(t, s, this.DELETE)
+  }
+}
+
+class JsonMerge extends Json {
+  static header = 'This file is partially managed by {{__NAME__}}. Edits may be overwritten.'
+  merge = (t, s) => merge({}, t, s)
+}
+
+class PackageJson extends JsonMerge {
+  static types = ['pkg.json']
+
+  async prepare (s, t) {
+    // merge new source with current pkg content
+    const update = super.prepare(s, t)
+
+    // move comment to config field
+    const configKey = this.options.config.__CONFIG_KEY__
+    const header = this.header()
+    const headerKey = Object.keys(header)[0]
+    update[configKey] = setFirst(header, update[configKey])
+    delete update[headerKey]
+
+    return update
+  }
+
+  async write (s) {
+    const pkg = await NpmPackageJson.load(dirname(this.target))
+    pkg.update(s)
+    traverse(pkg.content, (keys, value) => {
+      if (value === this.DELETE) {
+        return unset(pkg.content, keys)
+      }
+    })
+    pkg.save()
+  }
+}
+
+const Parsers = {
+  Base,
+  Gitignore,
+  Js,
+  Ini,
+  Markdown,
+  Yml,
+  Json,
+  JsonMerge,
+  PackageJson,
+}
+
+const parserLookup = Object.values(Parsers)
+
+const getParser = (file) => {
+  const base = basename(file).toLowerCase()
+  const ext = extname(file).slice(1).toLowerCase()
+
+  return parserLookup.find((p) => p.types.includes(base))
+    || parserLookup.find((p) => p.types.includes(ext))
+    || Parsers.Base
+}
+
+module.exports = getParser
+module.exports.Parsers = Parsers

package/lib/util/template.js

@@ -0,0 +1,41 @@
+const Handlebars = require('handlebars')
+const { basename, extname, join } = require('path')
+const fs = require('fs')
+const DELETE = '__DELETE__'
+
+const partialName = (s) =>
+  basename(s, extname(s)).replace(/-([a-z])/g, (_, g) => g.toUpperCase())
+
+const setupHandlebars = (partialsDir) => {
+  Handlebars.registerHelper('obj', ({ hash }) => hash)
+  Handlebars.registerHelper('json', (c) => JSON.stringify(c))
+  Handlebars.registerHelper('del', () => JSON.stringify(DELETE))
+
+  // Load all content files as camelcase partial names
+  for (const f of fs.readdirSync(join(partialsDir))) {
+    Handlebars.registerPartial(
+      partialName(f),
+      fs.readFileSync(join(partialsDir, f)).toString()
+    )
+  }
+}
+
+const cache = new Map()
+
+const template = (str, { config, ...options }) => {
+  if (cache.size === 0) {
+    setupHandlebars(config.sourceDir)
+  }
+
+  let t = cache.get(str)
+  if (t == null) {
+    t = Handlebars.compile(str, { strict: true })
+    cache.set(str, t)
+  }
+
+  // merge in config as top level data in templates
+  return t({ ...options, ...config })
+}
+
+module.exports = template
+module.exports.DELETE = DELETE

package/package.json

@@ -1,28 +1,28 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "2.9.2",
+  "version": "3.1.1",
   "description": "templated files used in npm CLI team oss projects",
-  "main": "lib/index.js",
+  "main": "lib/content/index.js",
   "bin": {
-    "npm-template-check": "bin/npm-template-check.js",
-    "npm-template-copy": "bin/postinstall.js"
+    "template-oss-apply": "bin/apply.js",
+    "template-oss-check": "bin/check.js"
   },
   "scripts": {
-    "lint": "eslint '**/*.js'",
+    "lint": "eslint \"**/*.js\"",
     "lintfix": "npm run lint -- --fix",
-    "postinstall": "node bin/postinstall.js",
-    "postlint": "npm-template-check",
     "posttest": "npm run lint",
     "postversion": "npm publish",
     "prepublishOnly": "git push origin --follow-tags",
     "preversion": "npm test",
     "snap": "tap",
     "test": "tap",
-    "template-copy": "npm-template-copy --force"
+    "template-oss-apply": "template-oss-apply --force",
+    "postlint": "template-oss-check",
+    "postinstall": "template-oss-apply"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/npm/template-oss.git"
+    "url": "https://github.com/npm/template-oss.git"
   },
   "keywords": [
     "npm",
@@ -32,31 +32,33 @@
   "license": "ISC",
   "dependencies": {
     "@npmcli/fs": "^2.0.1",
-    "@npmcli/map-workspaces": "^2.0.1",
+    "@npmcli/git": "^3.0.0",
+    "@npmcli/map-workspaces": "^2.0.2",
     "@npmcli/package-json": "^1.0.1",
+    "diff": "^5.0.0",
+    "handlebars": "^4.7.7",
+    "hosted-git-info": "^5.0.0",
     "json-parse-even-better-errors": "^2.3.1",
-    "which": "^2.0.2"
+    "just-diff": "^5.0.1",
+    "lodash": "^4.17.21",
+    "npm-package-arg": "^9.0.1",
+    "proc-log": "^2.0.0",
+    "semver": "^7.3.5",
+    "yaml": "^2.0.0-10"
   },
   "files": [
-    "bin",
-    "lib"
+    "bin/",
+    "lib/"
   ],
   "devDependencies": {
-    "@npmcli/eslint-config": "*",
-    "@npmcli/promise-spawn": "^2.0.0",
+    "@npmcli/eslint-config": "^3.0.1",
     "@npmcli/template-oss": "file:./",
-    "eslint": "^8.10.0",
-    "eslint-plugin-node": "^11.1.0",
-    "tap": "*"
+    "tap": "^16.0.0"
   },
-  "peerDependencies": {
-    "@npmcli/eslint-config": "^2.0.0",
-    "tap": "^15.0.9"
-  },
-  "tap": {
-    "coverage-map": "map.js"
+  "templateOSS": {
+    "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten."
   },
   "engines": {
-    "node": "^12.13.0 || ^14.15.0 || >=16"
+    "node": "^12.13.0 || ^14.15.0 || >=16.0.0"
   }
 }

package/bin/.gitattributes

@@ -1,3 +0,0 @@
-# Dont modify line endings of our bin scripts
-# so git status stays clean for windows tests
-*.js -crlf

package/bin/npm-template-check.js

@@ -1,44 +0,0 @@
-#!/usr/bin/env node
-
-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 {
-    npm_config_local_prefix: root,
-  } = process.env
-
-  if (!root) {
-    throw new Error('This package requires npm >7.21.1')
-  }
-
-  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:')
-    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,31 +0,0 @@
-#!/usr/bin/env node
-
-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 {
-    npm_config_global: globalMode,
-    npm_config_local_prefix: root,
-  } = process.env
-
-  // do nothing in global mode or when the local prefix isn't set
-  if (globalMode === 'true' || !root) {
-    return
-  }
-
-  const config = await getConfig(root)
-  for (const path of config.paths) {
-    if (!await patchPackage(path, root, config)) {
-      continue
-    }
-
-    await copyContent(path, root, config)
-  }
-}
-
-module.exports = main().catch((err) => {
-  console.error(err.stack)
-  process.exitCode = 1
-})

package/lib/content/ci-no-windows.yml

@@ -1,48 +0,0 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
-
-name: CI
-
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-      - latest
-  schedule:
-    # "At 02:00 on Monday" https://crontab.guru/#0_1_*_*_1
-    - cron: "0 2 * * 1"
-
-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
-      - run: npm i
-      - run: npm run lint
-
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        node-version: [12.13.0, 12.x, 14.15.0, 14.x, 16.13.0, 16.x]
-        platform:
-        - os: ubuntu-latest
-          shell: bash
-        - os: macos-latest
-          shell: bash
-    runs-on: ${{ matrix.platform.os }}
-    defaults:
-      run:
-        shell: ${{ matrix.platform.shell }}
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm i --prefer-online -g npm@latest
-      - run: npm i
-      - run: npm test --ignore-scripts

package/lib/content/ci-workspace.yml

@@ -1,63 +0,0 @@
-name: Node Workspace CI %%pkgname%%
-
-on:
-  pull_request:
-    paths:
-      - %%pkgpath%%/**
-  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
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '16'
-      - run: npm i --prefer-online -g npm@latest
-      - run: npm i
-      - run: npm run lint -w %%pkgpath%%
-
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        node-version: [12.13.0, 12.x, 14.15.0, 14.x, 16.13.0, 16.x]
-        platform:
-          - os: ubuntu-latest
-            shell: bash
-          - os: macos-latest
-            shell: bash
-          - os: windows-latest
-            shell: cmd
-    runs-on: ${{ matrix.platform.os }}
-    defaults:
-      run:
-        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
-      - run: npm i
-      - run: npm test --ignore-scripts -w %%pkgpath%%

package/lib/content/release-please-workspace.yml

@@ -1,29 +0,0 @@
-# This file is automatically added by @npmcli/template-oss. Do not edit.
-
-name: Node Workspace Release Please %%pkgname%%
-
-on:
-  push:
-    paths:
-      - %%pkgpath%%/**
-    branches:
-      - release-next
-      - latest
-
-jobs:
-  release-please:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: google-github-actions/release-please-action@v2
-        id: release
-        with:
-          release-type: node
-          monorepo-tags: true
-          path: %%pkgpath%%
-          # 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}]