@npmcli/template-oss 4.25.1 → 4.26.0

package/lib/config.js

@@ -129,6 +129,9 @@ const getFullConfig = async ({
 
   const esm = pkg.pkgJson?.type === 'module' || !!pkgConfig.typescript || !!pkgConfig.esm
 
+  // test runner configuration
+  const isNodeTest = pkgConfig.testRunner === 'node:test'
+
   // all derived keys
   const derived = {
     isRoot,
@@ -168,10 +171,12 @@ const getFullConfig = async ({
     esm,
     cjsExt: esm ? 'cjs' : 'js',
     deleteJsExt: esm ? 'js' : 'cjs',
+    // test runner
+    isNodeTest,
     // tap
     // 18 and up doesn't like nyc-arg
-    tap18: semver.coerce(pkg.pkgJson?.devDependencies?.tap)?.major >= 18,
-    tap16: semver.coerce(pkg.pkgJson?.devDependencies?.tap)?.major === 16,
+    tap18: !isNodeTest && semver.coerce(pkg.pkgJson?.devDependencies?.tap)?.major >= 18,
+    tap16: !isNodeTest && semver.coerce(pkg.pkgJson?.devDependencies?.tap)?.major === 16,
     // booleans to control application of updates
     isForce,
     isDogFood,
@@ -202,6 +207,11 @@ const getFullConfig = async ({
     )
   }
 
+  // When using node:test, we don't need tap as a dependency
+  if (isNodeTest && Array.isArray(pkgConfig.requiredPackages?.devDependencies)) {
+    pkgConfig.requiredPackages.devDependencies = pkgConfig.requiredPackages.devDependencies.filter(p => p !== 'tap')
+  }
+
   pkgConfig.lintIgnorePaths = [
     ...(pkgConfig.ignorePaths || []),
     ...(pkgConfig.lintIgnorePaths || []),

package/lib/content/_step-test-yml.hbs

@@ -1,4 +1,15 @@
+{{#unless isNodeTest}}
 - name: Add Problem Matcher
   run: echo "::add-matcher::.github/matchers/tap.json"
+{{/unless}}
+{{#if isNodeTest}}
+- name: Test (with coverage on Node >= 24)
+  if: $\{{ fromJSON(matrix.node-version) >= 24 }}
+  run: {{ rootNpmPath }} run test:cover --ignore-scripts {{~#if jobRunFlags}} {{ jobRunFlags }}{{/if}}
+- name: Test (without coverage on Node < 24)
+  if: $\{{ fromJSON(matrix.node-version) < 24 }}
+  run: {{ rootNpmPath }} test --ignore-scripts {{~#if jobRunFlags}} {{ jobRunFlags }}{{/if}}
+{{else}}
 - name: Test
   run: {{ rootNpmPath }} test --ignore-scripts {{~#if jobRunFlags}} {{ jobRunFlags }}{{/if}}
+{{/if}}

package/lib/content/index.js

@@ -37,7 +37,10 @@ const sharedRootAdd = name => ({
     filter: isPublic,
   },
   // ci
-  '.github/matchers/tap.json': 'tap-json.hbs',
+  '.github/matchers/tap.json': {
+    file: 'tap-json.hbs',
+    filter: p => !p.config.isNodeTest,
+  },
   [`.github/workflows/ci${name ? `-${name}` : ''}.yml`]: 'ci-yml.hbs',
   // dependabot
   '.github/dependabot.yml': {
@@ -185,6 +188,7 @@ module.exports = {
   publish: false,
   typescript: false,
   esm: false,
+  testRunner: 'tap',
   updateNpm: true,
   dependabot: 'increase-if-necessary',
   dependabotInterval: 'daily',

package/lib/content/package-json.hbs

@@ -17,8 +17,16 @@
     {{/if}}
     "postlint": "template-oss-check",
     "template-oss-apply": "template-oss-apply --force",
+    {{#if isNodeTest}}
+    "snap": "node --test --test-update-snapshots",
+    "test": "node --test --test-timeout=3000",
+    "test:cover": "node --test --experimental-test-coverage --test-timeout=3000 --test-coverage-lines=100 --test-coverage-functions=100 --test-coverage-branches=100",
+    {{else}}
     "snap": "{{#if typescript}}{{#if tap16}}c8 {{/if}}{{/if}}tap",
     "test": "{{#if typescript}}{{#if tap16}}c8 {{/if}}{{/if}}tap",
+    "test:cover": {{{ del }}},
+    "test:nocover": {{{ del }}},
+    {{/if}}
     "posttest": "{{ localNpmPath }} run lint",
     {{#if isRootMono}}
     "test-all": "{{ localNpmPath }} run test {{ allFlags }}",
@@ -40,6 +48,10 @@
   },
   "templateVersion": {{{ del }}},
   "standard": {{{ del }}},
+  {{#if isNodeTest}}
+  "nyc": {{{ del }}},
+  "tap": {{{ del }}}
+  {{else}}
   "nyc": {{#if tap18}}{
     "exclude": {{{ json workspaceGlobs }}}
   }{{else}}{{{ del }}}{{/if}},
@@ -78,4 +90,5 @@
       "tap-snapshots/**"
     ]{{/if}}
   }
+  {{/if}}
 }

package/package.json

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