feat: move functionality to private workspaces

.eslintrc.js

@@ -11,7 +11,7 @@ const localConfigs = readdir(__dirname)
 module.exports = {
   root: true,
   ignorePatterns: [
-    'workspaces/content/**',
+    'workspaces/**',
   ],
   extends: [
     '@npmcli',

.github/dependabot.yml

@@ -15,6 +15,18 @@ updates:
       prefix-development: chore
     labels:
       - "Dependencies"
+  - package-ecosystem: npm
+    directory: workspaces/config/
+    schedule:
+      interval: daily
+    allow:
+      - dependency-type: direct
+    versioning-strategy: increase-if-necessary
+    commit-message:
+      prefix: deps
+      prefix-development: chore
+    labels:
+      - "Dependencies"
   - package-ecosystem: npm
     directory: workspaces/content/
     schedule:
@@ -27,3 +39,27 @@ updates:
       prefix-development: chore
     labels:
       - "Dependencies"
+  - package-ecosystem: npm
+    directory: workspaces/files/
+    schedule:
+      interval: daily
+    allow:
+      - dependency-type: direct
+    versioning-strategy: increase-if-necessary
+    commit-message:
+      prefix: deps
+      prefix-development: chore
+    labels:
+      - "Dependencies"
+  - package-ecosystem: npm
+    directory: workspaces/release-please/
+    schedule:
+      interval: daily
+    allow:
+      - dependency-type: direct
+    versioning-strategy: increase-if-necessary
+    commit-message:
+      prefix: deps
+      prefix-development: chore
+    labels:
+      - "Dependencies"

.gitignore

@@ -28,4 +28,7 @@
 !/test/
 !/workspaces/
 /workspaces/*
+!/workspaces/config/
 !/workspaces/content/
+!/workspaces/files/
+!/workspaces/release-please/

bin/release-please.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 const core = require('@actions/core')
-const main = require('../lib/release-please/index.js')
+const main = require('@npmcli/template-oss-release-please')
 
 const dryRun = !process.env.CI
 const [branch, forcePullRequest] = process.argv.slice(2)

lib/apply/apply-files.js

@@ -1,6 +1,6 @@
 const fs = require('fs/promises')
 const log = require('proc-log')
-const { rmEach, parseEach } = require('../util/files.js')
+const { rmEach, parseEach } = require('@npmcli/template-oss-files')
 
 const run = async (dir, files, options) => {
   const { rm, add } = files

lib/check/check-apply.js

@@ -1,6 +1,6 @@
 const log = require('proc-log')
 const { relative, basename } = require('path')
-const { rmEach, parseEach } = require('../util/files.js')
+const { rmEach, parseEach } = require('@npmcli/template-oss-files')
 const { partition } = require('lodash')
 const localeCompare = require('@isaacs/string-locale-compare')('en')
 

lib/index.js

@@ -1,6 +1,6 @@
 const log = require('proc-log')
 const { resolve } = require('path')
-const getConfig = require('./config.js')
+const getConfig = require('@npmcli/template-oss-config')
 const PackageJson = require('@npmcli/package-json')
 const mapWorkspaces = require('@npmcli/map-workspaces')
 

package.json

@@ -41,22 +41,15 @@
     "@npmcli/git": "^4.0.0",
     "@npmcli/map-workspaces": "^3.0.0",
     "@npmcli/package-json": "^3.0.0",
+    "@npmcli/template-oss-config": "^1.0.0",
     "@npmcli/template-oss-content": "^1.0.0",
+    "@npmcli/template-oss-files": "^1.0.0",
+    "@npmcli/template-oss-release-please": "^1.0.0",
     "@octokit/rest": "^19.0.4",
-    "diff": "^5.0.0",
-    "glob": "^8.0.1",
-    "handlebars": "^4.7.7",
-    "hosted-git-info": "^6.0.0",
-    "ini": "^3.0.1",
-    "json-parse-even-better-errors": "^3.0.0",
-    "just-deep-map-values": "^1.1.1",
-    "just-diff": "^5.0.1",
     "lodash": "^4.17.21",
     "npm-package-arg": "^10.0.0",
     "proc-log": "^3.0.0",
-    "release-please": "npm:@npmcli/release-please@^14.2.6",
-    "semver": "^7.3.5",
-    "yaml": "^2.1.1"
+    "semver": "^7.3.5"
   },
   "files": [
     "bin/",
@@ -65,25 +58,27 @@
   "devDependencies": {
     "@npmcli/eslint-config": "^4.0.0",
     "@npmcli/template-oss": "file:./",
-    "tap": "^16.0.0"
+    "tap": "^16.0.0",
+    "yaml": "^2.2.1"
   },
   "tap": {
     "timeout": 600,
     "nyc-arg": [
       "--exclude",
-      "workspaces/content/**",
+      "workspaces/**",
       "--exclude",
       "tap-snapshots/**"
     ],
-    "test-ignore": "^(workspaces/content)/"
+    "test-ignore": "^(workspaces)/"
   },
   "templateOSS": {
-    "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten."
+    "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
+    "//@npmcli/template-oss-config": "This file is partially managed by @npmcli/template-oss-config. Edits may be overwritten."
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
   },
   "workspaces": [
-    "workspaces/content"
+    "workspaces/*"
   ]
 }

workspaces/config/.eslintrc.js

@@ -0,0 +1,17 @@
+/* This file is automatically added by @npmcli/template-oss. Do not edit. */
+
+'use strict'
+
+const { readdirSync: readdir } = require('fs')
+
+const localConfigs = readdir(__dirname)
+  .filter((file) => file.startsWith('.eslintrc.local.'))
+  .map((file) => `./${file}`)
+
+module.exports = {
+  root: true,
+  extends: [
+    '@npmcli',
+    ...localConfigs,
+  ],
+}

workspaces/config/.gitignore

@@ -0,0 +1,21 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+# ignore everything in the root
+/*
+
+# keep these
+!**/.gitignore
+!/.eslintrc.js
+!/.eslintrc.local.*
+!/.gitignore
+!/bin/
+!/CHANGELOG*
+!/docs/
+!/lib/
+!/LICENSE*
+!/map.js
+!/package.json
+!/README*
+!/scripts/
+!/tap-snapshots/
+!/test/

lib/config.js → workspaces/config/lib/index.js

@@ -1,16 +1,16 @@
 const { relative, dirname, join, extname, posix, win32 } = require('path')
 const { defaults, pick, omit, uniq } = require('lodash')
 const semver = require('semver')
-const parseCIVersions = require('./util/parse-ci-versions.js')
-const getGitUrl = require('./util/get-git-url.js')
-const gitignore = require('./util/gitignore.js')
-const { withArrays } = require('./util/merge.js')
-const { FILE_KEYS, parseConfig: parseFiles, getAddedFiles } = require('./util/files.js')
+const parseCIVersions = require('./parse-ci-versions.js')
+const getGitUrl = require('./get-git-url.js')
+const gitignore = require('./gitignore.js')
+const withArrays = require('./merge-with-arrays.js')
+const { FILE_KEYS, parseConfig: parseFiles, getAddedFiles } = require('@npmcli/template-oss-files')
 
 const CONFIG_KEY = 'templateOSS'
 const getPkgConfig = (pkg) => pkg[CONFIG_KEY] || {}
 
-const { name: NAME, version: LATEST_VERSION } = require('../package.json')
+const { name: NAME, version: LATEST_VERSION } = require('../../../package.json')
 const MERGE_KEYS = [...FILE_KEYS, 'defaultContent', 'content']
 const DEFAULT_CONTENT = require.resolve('@npmcli/template-oss-content')
 

lib/util/merge.js → workspaces/config/lib/merge-with-arrays.js

@@ -1,12 +1,5 @@
 const { mergeWith } = require('lodash')
 
-const merge = (...objects) => mergeWith({}, ...objects, (value, srcValue, key) => {
-  if (Array.isArray(srcValue)) {
-    // Dont merge arrays, last array wins
-    return srcValue
-  }
-})
-
 const mergeWithArrays = (...keys) =>
   (...objects) => mergeWith({}, ...objects, (value, srcValue, key) => {
     if (Array.isArray(srcValue)) {
@@ -17,5 +10,4 @@ const mergeWithArrays = (...keys) =>
     }
   })
 
-module.exports = merge
-module.exports.withArrays = mergeWithArrays
+module.exports = mergeWithArrays

workspaces/config/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@npmcli/template-oss-config",
+  "version": "1.0.0",
+  "description": "The config for @npmcli/template-oss",
+  "private": true,
+  "main": "lib/index.js",
+  "scripts": {
+    "test": "tap",
+    "lint": "eslint \"**/*.js\"",
+    "postlint": "template-oss-check",
+    "template-oss-apply": "template-oss-apply --force",
+    "lintfix": "npm run lint -- --fix",
+    "snap": "tap",
+    "posttest": "npm run lint"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/npm/template-oss.git",
+    "directory": "workspaces/config"
+  },
+  "dependencies": {
+    "@isaacs/string-locale-compare": "^1.1.0",
+    "@npmcli/git": "^4.0.3",
+    "@npmcli/template-oss-files": "^1.0.0",
+    "hosted-git-info": "^6.1.1",
+    "lodash": "^4.17.21",
+    "semver": "^7.3.8"
+  },
+  "devDependencies": {
+    "@npmcli/eslint-config": "^4.0.0",
+    "@npmcli/template-oss": "file:../../",
+    "tap": "^16.0.0"
+  },
+  "keywords": [],
+  "author": "GitHub Inc.",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/npm/template-oss/issues"
+  },
+  "homepage": "https://github.com/npm/template-oss#readme",
+  "files": [
+    "bin/",
+    "lib/"
+  ],
+  "engines": {
+    "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
+  },
+  "templateOSS": {
+    "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
+    "//@npmcli/template-oss-config": "This file is partially managed by @npmcli/template-oss-config. Edits may be overwritten."
+  },
+  "tap": {
+    "nyc-arg": [
+      "--exclude",
+      "tap-snapshots/**"
+    ],
+    "check-coverage": false
+  }
+}

workspaces/config/test/index.js

@@ -0,0 +1,8 @@
+const { resolve } = require('path')
+const t = require('tap')
+
+t.test('resolved to content index', async (t) => {
+  const path = require.resolve('..')
+  t.equal(path, resolve('lib/index.js'))
+  t.ok(require(path))
+})

test/util/parse-ci-versions.js → workspaces/config/test/parse-ci-versions.js

@@ -1,5 +1,5 @@
 const t = require('tap')
-const parse = require('../../lib/util/parse-ci-versions.js')
+const parse = require('../lib/parse-ci-versions.js')
 
 const targets = [
   [[], ''],

workspaces/content/package.json

@@ -38,12 +38,14 @@
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
   },
   "templateOSS": {
-    "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten."
+    "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
+    "//@npmcli/template-oss-config": "This file is partially managed by @npmcli/template-oss-config. Edits may be overwritten."
   },
   "tap": {
     "nyc-arg": [
       "--exclude",
       "tap-snapshots/**"
-    ]
+    ],
+    "check-coverage": false
   }
 }

workspaces/content/test/index.js

@@ -1,8 +1,8 @@
 const { resolve } = require('path')
 const t = require('tap')
 
-t.test('resolved to content index', () => {
+t.test('resolved to content index', async (t) => {
   const path = require.resolve('..')
   t.equal(path, resolve('lib/index.js'))
   t.ok(require(path))
-})
+})

workspaces/files/.eslintrc.js

@@ -0,0 +1,17 @@
+/* This file is automatically added by @npmcli/template-oss. Do not edit. */
+
+'use strict'
+
+const { readdirSync: readdir } = require('fs')
+
+const localConfigs = readdir(__dirname)
+  .filter((file) => file.startsWith('.eslintrc.local.'))
+  .map((file) => `./${file}`)
+
+module.exports = {
+  root: true,
+  extends: [
+    '@npmcli',
+    ...localConfigs,
+  ],
+}

workspaces/files/.gitignore

@@ -0,0 +1,21 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+# ignore everything in the root
+/*
+
+# keep these
+!**/.gitignore
+!/.eslintrc.js
+!/.eslintrc.local.*
+!/.gitignore
+!/bin/
+!/CHANGELOG*
+!/docs/
+!/lib/
+!/LICENSE*
+!/map.js
+!/package.json
+!/README*
+!/scripts/
+!/tap-snapshots/
+!/test/

lib/util/files.js → workspaces/files/lib/index.js

@@ -1,9 +1,9 @@
 const { join } = require('path')
-const { defaultsDeep } = require('lodash')
 const { promisify } = require('util')
-const merge = require('./merge.js')
+const { defaultsDeep } = require('lodash')
 const deepMapValues = require('just-deep-map-values')
 const glob = promisify(require('glob'))
+const merge = require('./merge.js')
 const Parser = require('./parser.js')
 const template = require('./template.js')