@npmcli/template-oss 4.2.0 → 4.3.0

package/lib/util/parser.js

@@ -8,7 +8,9 @@ const { unset } = require('lodash')
 const template = require('./template.js')
 const jsonDiff = require('./json-diff')
 const merge = require('./merge.js')
+
 const setFirst = (first, rest) => ({ ...first, ...rest })
+
 const traverse = (value, visit, keys = []) => {
   if (keys.length) {
     const res = visit(keys, value)
@@ -23,17 +25,25 @@ const traverse = (value, visit, keys = []) => {
   }
 }
 
+const fsOk = (code) => (error) => {
+  if (error.code === 'ENOENT') {
+    return null
+  }
+  return Object.assign(error, { code })
+}
+
 class Base {
   static types = []
-  static header = 'This file is automatically added by {{__NAME__}}. Do not edit.'
+  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) {
+  constructor (target, source, options, fileOptions) {
     this.target = target
     this.source = source
     this.options = options
+    this.fileOptions = fileOptions
   }
 
   header () {
@@ -42,6 +52,13 @@ class Base {
     }
   }
 
+  clean () {
+    if (this.fileOptions.clean) {
+      return fs.rm(this.target).catch(fsOk())
+    }
+    return null
+  }
+
   read (s) {
     return fs.readFile(s, { encoding: 'utf-8' })
   }
@@ -88,13 +105,17 @@ class Base {
   // 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))
+    return Promise.resolve(this.clean())
+      .then(() => 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))
+      .then((s) => {
+        this.sourcePreParse = s
+        return 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)))
@@ -109,14 +130,9 @@ class Base {
   }
 
   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 }
-      }
-    })
+    // handle if old does not exist
+    const targetError = 'ETARGETERROR'
+    const target = await this.applyTarget().catch(fsOk(targetError))
 
     // no need to diff if current file does not exist
     if (target === null) {
@@ -131,11 +147,11 @@ class Base {
 
     // 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') {
+    if (target.code === targetError) {
       const msg = `[${this.options.config.__NAME__} ERROR]`
       return [
         `${msg} There was an erroring getting the target file`,
-        `${msg} ${target.error}`,
+        `${msg} ${target}`,
         `${msg} It will be overwritten with the following source:`,
         '-'.repeat(40),
         this.toString(source),
@@ -175,7 +191,12 @@ class Yml extends Base {
   comment = (c) => ` ${c}`
 
   toString (s) {
-    return s.toString({ lineWidth: 0, indent: 2 })
+    try {
+      return s.toString({ lineWidth: 0, indent: 2 })
+    } catch (err) {
+      err.message = [this.target, this.sourcePreParse, ...s.errors, err.message].join('\n')
+      throw err
+    }
   }
 
   parse (s) {
@@ -192,6 +213,41 @@ class Yml extends Base {
   }
 }
 
+class YmlMerge extends Yml {
+  prepare (source, t) {
+    if (t === null) {
+      // If target does not exist or is in an
+      // error state, we cant do anything but write
+      // the whole document
+      return super.prepare(source)
+    }
+
+    const key = [].concat(this.key)
+
+    const getId = (node) => {
+      const index = node.items.findIndex(p => p.key?.value === this.id)
+      return index !== -1 ? node.items[index].value?.value : node.toJSON()
+    }
+
+    const target = this.parse(t)
+    const targetNodes = target.getIn(key).items.reduce((acc, node, index) => {
+      acc[getId(node)] = { node, index }
+      return acc
+    }, {})
+
+    for (const node of source.getIn(key).items) {
+      const index = targetNodes[getId(node)]?.index
+      if (typeof index === 'number' && index !== -1) {
+        target.setIn([...key, index], node)
+      } else {
+        target.addIn(key, node)
+      }
+    }
+
+    return super.prepare(target)
+  }
+}
+
 class Json extends Base {
   static types = ['json']
   // its a json comment! not really but we do add a special key
@@ -220,7 +276,7 @@ class Json extends Base {
 }
 
 class JsonMerge extends Json {
-  static header = 'This file is partially managed by {{__NAME__}}. Edits may be overwritten.'
+  static header = 'This file is partially managed by {{ __NAME__ }}. Edits may be overwritten.'
   merge = (t, s) => merge(t, s)
 }
 
@@ -260,6 +316,7 @@ const Parsers = {
   Ini,
   Markdown,
   Yml,
+  YmlMerge,
   Json,
   JsonMerge,
   PackageJson,

package/lib/util/template.js

@@ -3,12 +3,19 @@ const { basename, extname, join } = require('path')
 const fs = require('fs')
 const DELETE = '__DELETE__'
 
+const safeValues = (obj) => Object.entries(obj).map(([key, value]) =>
+  [key, new Handlebars.SafeString(value)])
+
 const partialName = (s) => basename(s, extname(s)) // remove extension
   .replace(/^_/, '') // remove leading underscore
   .replace(/-([a-z])/g, (_, g) => g.toUpperCase()) // camelcase
 
 const setupHandlebars = (...partialDirs) => {
-  Handlebars.registerHelper('obj', ({ hash }) => hash)
+  Handlebars.registerHelper('obj', ({ hash }) => Object.fromEntries(safeValues(hash)))
+  Handlebars.registerHelper('join', (arr, sep) => arr.join(typeof sep === 'string' ? sep : ', '))
+  Handlebars.registerHelper('pluck', (arr, key) => arr.map(a => a[key]))
+  Handlebars.registerHelper('quote', (arr) => arr.map(a => `'${a}'`))
+  Handlebars.registerHelper('last', (arr) => arr[arr.length - 1])
   Handlebars.registerHelper('json', (c) => JSON.stringify(c))
   Handlebars.registerHelper('del', () => JSON.stringify(DELETE))
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {

package/lib/content/_setup-deps.yml

@@ -1 +0,0 @@
-- run: {{rootNpmPath}} i --ignore-scripts --no-audit --no-fund {{~#if flags}} {{flags}}{{/if}}

package/lib/content/_setup-git.yml

@@ -1,11 +0,0 @@
-- uses: actions/checkout@v3
-{{#if checkout}}
-  with:
-  {{#each checkout}}
-    {{@key}}: {{this}}
-  {{/each}}
-{{/if}}
-- name: Setup git user
-  run: |
-    git config --global user.email "npm-cli+bot@github.com"
-    git config --global user.name "npm CLI robot"

package/lib/content/_setup-job.yml

@@ -1,6 +0,0 @@
-if: github.repository_owner == 'npm' {{~#if jobIf}} && {{{jobIf}}}{{/if}}
-runs-on: ubuntu-latest
-steps:
-  {{> setupGit}}
-  {{> setupNode}}
-  {{> setupDeps}}

package/lib/content/release-please.yml

@@ -1,64 +0,0 @@
-name: Release Please
-
-on:
-  push:
-    branches:
-      {{#each branches}}
-      - {{.}}
-      {{/each}}
-      {{#each releaseBranches}}
-      - {{.}}
-      {{/each}}
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  release-please:
-    outputs:
-      pr: $\{{ steps.release.outputs.pr }}
-      release: $\{{ steps.release.outputs.release }}
-    {{> setupJob }}
-      - name: Release Please
-        id: release
-        run: npx --offline template-oss-release-please $\{{ github.ref_name }}
-        env:
-          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
-
-  post-pr:
-    needs: release-please
-    if: needs.release-please.outputs.pr
-    runs-on: ubuntu-latest
-    outputs:
-      ref: $\{{ steps.ref.outputs.branch }}
-    steps:
-      - name: Output ref
-        id: ref
-        run: echo "::set-output name=branch::$\{{ fromJSON(needs.release-please.outputs.pr).headBranchName }}"
-      {{> setupGit checkout=(obj ref="${{ steps.ref.outputs.branch }}" fetch-depth=0)}}
-      {{> setupNode}}
-      {{> setupDeps}}
-      - name: Post pull request actions
-        env:
-          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
-        run: |
-          {{rootNpmPath}} run rp-pull-request --ignore-scripts --if-present -ws -iwr
-          git commit -am "chore: post pull request" || true
-          git push
-  
-  release-test:
-    needs: post-pr
-    if: needs.post-pr.outputs.ref
-    uses: ./.github/workflows/release.yml
-    with:
-      ref: $\{{ needs.post-pr.outputs.ref }}
-
-  post-release:
-    needs: release-please
-    {{> setupJob jobIf="needs.release-please.outputs.release" }}
-      - name: Post release actions
-        env:
-          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
-        run: |
-          {{rootNpmPath}} run rp-release --ignore-scripts --if-present -ws -iwr