create-packkit 2.4.0 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-packkit",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Highly configurable scaffolder for modern npm packages and CLIs — pick your stack (TS/JS, bundler, tests, linter, CI, releases) from a CLI or a web configurator.",
   "type": "module",
   "bin": {

package/src/cli/args.js

@@ -56,6 +56,7 @@ export function parseCliArgs(argv) {
       'pkg-checks': { type: 'boolean' },
       knip: { type: 'boolean' },
       'size-limit': { type: 'boolean' },
+      doctor: { type: 'boolean' },
       jsr: { type: 'boolean' },
       help: { type: 'boolean', short: 'h' },
       version: { type: 'boolean', short: 'v' },
@@ -86,6 +87,7 @@ export function parseCliArgs(argv) {
   if (values['pkg-checks']) overrides.pkgChecks = true;
   if (values.knip) overrides.knip = true;
   if (values['size-limit']) overrides.sizeLimit = true;
+  if (values.doctor) overrides.doctor = true;
   if (values.jsr) overrides.jsr = true;
   for (const [flag, key] of Object.entries(NEGATABLE)) {
     if (values[flag]) overrides[key] = false;

package/src/cli/index.js

@@ -48,7 +48,7 @@ Options:
   --workflows <ci|npm-publish|pages|codeql|codecov|stale>   (repeatable)
   --deps <renovate|dependabot|none>  --license <MIT|Apache-2.0|ISC|none>
   --pkg-checks (publint + are-the-types-wrong)   --knip   --jsr   --canary
-  --size-limit (bundle-size budget, libraries)
+  --size-limit (bundle-size budget, libraries)   --doctor (env check)
   --no-coverage  --no-community  --no-agents  --no-vscode  --no-editorconfig
   --schema            Print the full option/preset schema as JSON (for tools/agents)
   -h, --help          Show this help

package/src/core/features/doctor.js

@@ -0,0 +1,54 @@
+// A tiny environment doctor: checks the local Node and package manager match
+// what this project expects, and warns (never fails) otherwise. `npm run doctor`
+// runs it any time; for private projects it also runs on postinstall. It is NOT
+// wired to postinstall for publishable packages — that would run in every
+// consumer's install.
+
+export default {
+  id: 'doctor',
+  active: (cfg) => cfg.doctor && !cfg.monorepo,
+  apply(cfg) {
+    const files = { 'scripts/doctor.mjs': script(cfg) };
+    const pkg = { scripts: { doctor: 'node scripts/doctor.mjs' } };
+    if (!cfg.publishable) pkg.scripts.postinstall = 'node scripts/doctor.mjs';
+    return { files, pkg };
+  },
+};
+
+function script(cfg) {
+  return [
+    `/* global process, console, URL */`,
+    `// Checks your environment matches this project. Warns only — never fails.`,
+    `import { readFileSync } from 'node:fs';`,
+    ``,
+    `const pkg = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8'));`,
+    `const gte = (a, b) => {`,
+    `\tconst pa = String(a).split('.').map(Number);`,
+    `\tconst pb = String(b).split('.').map(Number);`,
+    `\tfor (let i = 0; i < 3; i++) if ((pa[i] || 0) !== (pb[i] || 0)) return (pa[i] || 0) > (pb[i] || 0);`,
+    `\treturn true;`,
+    `};`,
+    ``,
+    `let issues = 0;`,
+    `const floor = (pkg.engines?.node || '').replace(/[^0-9.]/g, '');`,
+    `const node = process.versions.node;`,
+    `if (floor && !gte(node, floor)) {`,
+    "\tconsole.warn(`⚠  Node ${node} is below the required >=${floor} — run: nvm install ${floor.split('.')[0]}`);",
+    `\tissues++;`,
+    `} else {`,
+    "\tconsole.log(`✓ Node ${node}`);",
+    `}`,
+    ``,
+    `const expectedPm = '${cfg.packageManager}';`,
+    `const usingPm = (process.env.npm_config_user_agent || '').split('/')[0];`,
+    `if (usingPm && usingPm !== expectedPm) {`,
+    "\tconsole.warn(`⚠  This project uses ${expectedPm}, but you ran ${usingPm}.`);",
+    `\tissues++;`,
+    `} else {`,
+    "\tconsole.log(`✓ Package manager: ${expectedPm}`);",
+    `}`,
+    ``,
+    `if (issues) console.warn('\\nSee the README "Requirements" section to fix these.');`,
+    ``,
+  ].join('\n');
+}

package/src/core/features/index.js

@@ -22,6 +22,7 @@ import storybook from './storybook.js';
 import community from './community.js';
 import agents from './agents.js';
 import vscode from './vscode.js';
+import doctor from './doctor.js';
 import gitfiles from './gitfiles.js';
 
 export default [
@@ -46,5 +47,6 @@ export default [
   community,
   agents,
   vscode,
+  doctor,
   gitfiles,
 ];

package/src/core/options.js

@@ -111,6 +111,7 @@ export const OPTIONS = {
   pkgChecks: { group: 'quality', type: 'boolean', label: 'Package checks (publint + are-the-types-wrong)', default: false },
   knip: { group: 'quality', type: 'boolean', label: 'Knip (unused files / deps / exports)', default: false },
   sizeLimit: { group: 'quality', type: 'boolean', label: 'size-limit (bundle-size budget, libraries)', default: false },
+  doctor: { group: 'quality', type: 'boolean', label: 'Env doctor (warn on Node / package-manager mismatch)', default: false },
 
   // ---- lint / format ----
   lint: {