@npmcli/template-oss 4.1.2 → 4.3.0

package/lib/util/template.js

@@ -3,35 +3,44 @@ 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)
+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 }) => 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))
 
-  // 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()
-    )
+  // Load all files as camelcase partial names.
+  // all other content dirs only get special underscore leading
+  // files as partials. this prevents recursion loops when overwriting
+  // a filename to use as a enw file
+  let isBase = true
+  for (const dir of partialDirs) {
+    for (const f of fs.readdirSync(dir)) {
+      if (f.startsWith('_') || isBase) {
+        Handlebars.registerPartial(
+          partialName(f),
+          fs.readFileSync(join(dir, f)).toString()
+        )
+      }
+    }
+    isBase = false
   }
 }
 
-const cache = new Map()
-
 const template = (str, { config, ...options }) => {
-  if (cache.size === 0) {
-    setupHandlebars(config.sourceDir)
-  }
+  setupHandlebars(...config.__PARTIAL_DIRS__)
 
-  let t = cache.get(str)
-  if (t == null) {
-    t = Handlebars.compile(str, { strict: true })
-    cache.set(str, t)
-  }
+  const t = Handlebars.compile(str, { strict: true })
 
   // merge in config as top level data in templates
   return t({ ...options, ...config })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.1.2",
+  "version": "4.3.0",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {
@@ -42,6 +42,7 @@
     "handlebars": "^4.7.7",
     "hosted-git-info": "^5.0.0",
     "json-parse-even-better-errors": "^2.3.1",
+    "just-deep-map-values": "^1.1.1",
     "just-diff": "^5.0.1",
     "lodash": "^4.17.21",
     "npm-package-arg": "^9.0.1",
@@ -60,7 +61,11 @@
     "tap": "^16.0.0"
   },
   "tap": {
-    "timeout": 600
+    "timeout": 600,
+    "nyc-arg": [
+      "--exclude",
+      "tap-snapshots/**"
+    ]
   },
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten."

package/lib/content/release-please.yml

@@ -1,73 +0,0 @@
-name: Release Please
-
-on:
-  push:
-    branches:
-      {{#each branches}}
-      - {{.}}
-      {{/each}}
-      {{#each releaseBranches}}
-      - {{.}}
-      {{/each}}
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  release-please:
-    runs-on: ubuntu-latest
-    outputs:
-      pr: $\{{ steps.release.outputs.pr }}
-      release: $\{{ steps.release.outputs.release }}
-    steps:
-      {{> setupGit}}
-      {{> setupNode}}
-      {{> setupDeps}}
-      - 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 with=(obj ref="${{ steps.ref.outputs.branch }}" fetch-depth=0)}}
-      {{> setupNode}}
-      {{> setupDeps}}
-      - name: Post pull request actions
-        env:
-          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
-        run: |
-          npm 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/{{releaseTest}}
-    with:
-      ref: $\{{ needs.post-pr.outputs.ref }}
-
-  post-release:
-    needs: release-please
-    if: needs.release-please.outputs.release
-    runs-on: ubuntu-latest
-    steps:
-      {{> setupGit}}
-      {{> setupNode}}
-      {{> setupDeps}}
-      - name: Post release actions
-        env:
-          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
-        run: |
-          npm run rp-release --ignore-scripts --if-present -ws -iwr

package/lib/content/release-test.yml

@@ -1,46 +0,0 @@
-name: Release
-
-on:
-  workflow_call:
-    inputs:
-      ref:
-        required: true
-        type: string
-
-jobs:
-  lint-all:
-    runs-on: ubuntu-latest
-    steps:
-      {{> setupGit with=(obj ref="${{ inputs.ref }}")}}
-      {{> setupNode}}
-      {{> setupDeps}}
-      - run: npm run lint --if-present --workspaces --include-workspace-root
-
-  test-all:
-    strategy:
-      fail-fast: false
-      matrix:
-        node-version:
-          {{#each ciVersions}}
-          - {{.}}
-          {{/each}}
-        platform:
-          - 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 }}
-    steps:
-      {{> setupGit with=(obj ref="${{ inputs.ref }}")}}
-      {{> setupNode useMatrix=true}}
-      {{> setupDeps}}
-      - name: add tap problem matcher
-        run: echo "::add-matcher::.github/matchers/tap.json"
-      - run: npm run test --if-present --workspaces --include-workspace-root

package/lib/content/setup-deps.yml

@@ -1 +0,0 @@
-- run: npm 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 with}}
-  with:
-  {{#each with}}
-    {{@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"