@rtorcato/js-tooling 2.2.0 → 2.3.0

package/dist/cli/commands/doctor.js

@@ -1,6 +1,6 @@
+import path from 'node:path';
 import chalk from 'chalk';
 import fs from 'fs-extra';
-import path from 'node:path';
 const PACKAGE = '@rtorcato/js-tooling';
 const NODE_MIN_MAJOR = 22;
 const NODE_LTS_REQUIREMENTS = {
@@ -71,6 +71,7 @@ const FILE_CHECKS = [
         expected: `imports "${PACKAGE}/prettier"`,
         matcher: /@rtorcato\/js-tooling\/prettier/,
         optional: true,
+        hint: `Re-export from "${PACKAGE}/prettier" in prettier.config.mjs`,
     },
     {
         check: 'Vitest',
@@ -114,17 +115,29 @@ async function checkFile(dir, spec) {
         hint: spec.hint,
     };
 }
-async function checkPackageJson(dir) {
+async function readPackageJson(dir) {
     const filepath = path.join(dir, 'package.json');
-    if (!(await fs.pathExists(filepath))) {
+    if (!(await fs.pathExists(filepath)))
+        return null;
+    try {
+        return (await fs.readJson(filepath));
+    }
+    catch {
+        return null;
+    }
+}
+function checkPackageJson(pkg) {
+    if (!pkg) {
         return {
             check: 'package.json',
             status: 'missing',
             detail: 'no package.json found',
         };
     }
-    const pkg = await fs.readJson(filepath);
-    const deps = { ...(pkg.dependencies ?? {}), ...(pkg.devDependencies ?? {}) };
+    const deps = {
+        ...(pkg.dependencies ?? {}),
+        ...(pkg.devDependencies ?? {}),
+    };
     if (deps[PACKAGE]) {
         return {
             check: 'package.json',
@@ -139,14 +152,282 @@ async function checkPackageJson(dir) {
         hint: `Run \`pnpm add -D ${PACKAGE}\``,
     };
 }
+function checkEnginesNode(pkg) {
+    if (!pkg) {
+        return {
+            check: 'engines.node',
+            status: 'missing',
+            detail: 'no package.json',
+        };
+    }
+    const engines = pkg.engines ?? {};
+    if (!engines.node) {
+        return {
+            check: 'engines.node',
+            status: 'drift',
+            detail: 'engines.node not set in package.json',
+            hint: `Add \`"engines": { "node": ">=${NODE_MIN_MAJOR}" }\` to package.json`,
+        };
+    }
+    return {
+        check: 'engines.node',
+        status: 'ok',
+        detail: `engines.node = ${engines.node}`,
+    };
+}
+async function checkEditorConfig(dir) {
+    const exists = await fs.pathExists(path.join(dir, '.editorconfig'));
+    return {
+        check: 'EditorConfig',
+        status: exists ? 'ok' : 'optional-missing',
+        detail: exists ? '.editorconfig found' : 'no .editorconfig',
+        hint: exists ? undefined : 'Add an .editorconfig for cross-editor formatting consistency',
+    };
+}
+async function checkNodeVersionPin(dir) {
+    for (const candidate of ['.nvmrc', '.node-version']) {
+        if (await fs.pathExists(path.join(dir, candidate))) {
+            return {
+                check: 'Node version pin',
+                status: 'ok',
+                detail: `${candidate} found`,
+            };
+        }
+    }
+    return {
+        check: 'Node version pin',
+        status: 'optional-missing',
+        detail: 'no .nvmrc / .node-version',
+        hint: 'Add .nvmrc to pin Node version per repo (e.g. `echo 22 > .nvmrc`)',
+    };
+}
+async function checkHusky(dir, pkg) {
+    const huskyDir = await fs.pathExists(path.join(dir, '.husky'));
+    const scripts = pkg?.scripts ?? {};
+    const prepareScript = scripts.prepare ?? '';
+    const hasHookScript = /\bhusky\b/.test(prepareScript);
+    if (huskyDir && hasHookScript) {
+        return {
+            check: 'Husky',
+            status: 'ok',
+            detail: '.husky/ directory and prepare script configured',
+        };
+    }
+    if (huskyDir || hasHookScript) {
+        return {
+            check: 'Husky',
+            status: 'drift',
+            detail: huskyDir
+                ? '.husky/ exists but no `prepare: husky` script'
+                : '`prepare: husky` set but no .husky/ directory',
+            hint: 'Run `pnpm exec husky init` to scaffold both halves',
+        };
+    }
+    return {
+        check: 'Husky',
+        status: 'optional-missing',
+        detail: 'husky not configured',
+        hint: 'Run `pnpm add -D husky && pnpm exec husky init` to enable git hooks',
+    };
+}
+const LINT_STAGED_FILES = [
+    '.lintstagedrc',
+    '.lintstagedrc.json',
+    '.lintstagedrc.yaml',
+    '.lintstagedrc.yml',
+    '.lintstagedrc.js',
+    '.lintstagedrc.cjs',
+    '.lintstagedrc.mjs',
+    'lint-staged.config.js',
+    'lint-staged.config.cjs',
+    'lint-staged.config.mjs',
+];
+async function checkLintStaged(dir, pkg) {
+    const inPkg = pkg ? 'lint-staged' in pkg : false;
+    let inFile = null;
+    for (const candidate of LINT_STAGED_FILES) {
+        if (await fs.pathExists(path.join(dir, candidate))) {
+            inFile = candidate;
+            break;
+        }
+    }
+    if (inPkg || inFile) {
+        return {
+            check: 'lint-staged',
+            status: 'ok',
+            detail: inPkg ? '`lint-staged` field in package.json' : `${inFile} found`,
+        };
+    }
+    return {
+        check: 'lint-staged',
+        status: 'optional-missing',
+        detail: 'lint-staged not configured',
+        hint: 'Add a `lint-staged` field to package.json and wire it into the husky pre-commit hook',
+    };
+}
+const KNIP_FILES = [
+    'knip.json',
+    'knip.jsonc',
+    'knip.ts',
+    'knip.config.ts',
+    'knip.config.js',
+    'knip.config.mjs',
+];
+async function checkKnip(dir, pkg) {
+    const inPkg = pkg ? 'knip' in pkg : false;
+    let inFile = null;
+    for (const candidate of KNIP_FILES) {
+        if (await fs.pathExists(path.join(dir, candidate))) {
+            inFile = candidate;
+            break;
+        }
+    }
+    if (inPkg || inFile) {
+        return {
+            check: 'knip',
+            status: 'ok',
+            detail: inPkg ? '`knip` field in package.json' : `${inFile} found`,
+        };
+    }
+    return {
+        check: 'knip',
+        status: 'optional-missing',
+        detail: 'knip not configured',
+        hint: 'Add `knip` to detect unused files, deps, and exports',
+    };
+}
+const SEMANTIC_RELEASE_FILES = [
+    '.releaserc',
+    '.releaserc.json',
+    '.releaserc.yaml',
+    '.releaserc.yml',
+    '.releaserc.js',
+    '.releaserc.cjs',
+    'release.config.js',
+    'release.config.cjs',
+    'release.config.mjs',
+];
+async function checkSemanticRelease(dir, pkg) {
+    const isPrivate = pkg?.private === true;
+    const inPkg = pkg ? 'release' in pkg : false;
+    let configFile = null;
+    let configContent = null;
+    for (const candidate of SEMANTIC_RELEASE_FILES) {
+        const filepath = path.join(dir, candidate);
+        if (await fs.pathExists(filepath)) {
+            configFile = candidate;
+            try {
+                configContent = await fs.readFile(filepath, 'utf-8');
+            }
+            catch {
+                configContent = '';
+            }
+            break;
+        }
+    }
+    if (!inPkg && !configFile) {
+        return {
+            check: 'semantic-release',
+            status: isPrivate ? 'optional-missing' : 'drift',
+            detail: isPrivate
+                ? 'semantic-release not configured (package is private)'
+                : 'semantic-release not configured',
+            hint: isPrivate
+                ? undefined
+                : `Extend "${PACKAGE}/semantic-release" or "${PACKAGE}/semantic-release/github" in a release config`,
+        };
+    }
+    const presetRegex = /@rtorcato\/js-tooling\/semantic-release/;
+    const pkgReleaseStr = inPkg ? JSON.stringify(pkg?.release ?? '') : '';
+    const usesPreset = (configContent && presetRegex.test(configContent)) || presetRegex.test(pkgReleaseStr);
+    if (usesPreset) {
+        return {
+            check: 'semantic-release',
+            status: 'ok',
+            detail: configFile
+                ? `${configFile} extends ${PACKAGE}/semantic-release`
+                : `release field extends ${PACKAGE}/semantic-release`,
+        };
+    }
+    return {
+        check: 'semantic-release',
+        status: 'drift',
+        detail: configFile
+            ? `${configFile} does not extend ${PACKAGE}/semantic-release`
+            : '`release` field does not extend our preset',
+        hint: `Extend "${PACKAGE}/semantic-release" or "${PACKAGE}/semantic-release/github"`,
+    };
+}
+async function checkGitHubActions(dir) {
+    const workflowsDir = path.join(dir, '.github', 'workflows');
+    if (!(await fs.pathExists(workflowsDir))) {
+        return {
+            check: 'GitHub Actions',
+            status: 'optional-missing',
+            detail: 'no .github/workflows/',
+            hint: 'Run `npx @rtorcato/js-tooling setup` to scaffold a CI workflow',
+        };
+    }
+    try {
+        const files = await fs.readdir(workflowsDir);
+        const workflows = files.filter((f) => f.endsWith('.yml') || f.endsWith('.yaml'));
+        if (workflows.length === 0) {
+            return {
+                check: 'GitHub Actions',
+                status: 'optional-missing',
+                detail: '.github/workflows/ is empty',
+                hint: 'Add a workflow file (e.g. ci.yml) under .github/workflows/',
+            };
+        }
+        return {
+            check: 'GitHub Actions',
+            status: 'ok',
+            detail: `${workflows.length} workflow${workflows.length === 1 ? '' : 's'} in .github/workflows/`,
+        };
+    }
+    catch {
+        return {
+            check: 'GitHub Actions',
+            status: 'optional-missing',
+            detail: 'unable to read .github/workflows/',
+        };
+    }
+}
+async function checkGitLabCI(dir) {
+    for (const candidate of ['.gitlab-ci.yml', '.gitlab-ci.yaml']) {
+        if (await fs.pathExists(path.join(dir, candidate))) {
+            return {
+                check: 'GitLab CI',
+                status: 'ok',
+                detail: `${candidate} found`,
+            };
+        }
+    }
+    return {
+        check: 'GitLab CI',
+        status: 'optional-missing',
+        detail: 'no .gitlab-ci.yml',
+        hint: 'Add a .gitlab-ci.yml if this repo is hosted on GitLab',
+    };
+}
 export async function runDoctor(dir) {
     const targetDir = path.resolve(dir);
+    const pkg = await readPackageJson(targetDir);
     const results = [];
     results.push(evaluateNodeVersion(process.version));
-    results.push(await checkPackageJson(targetDir));
+    results.push(checkPackageJson(pkg));
+    results.push(checkEnginesNode(pkg));
+    results.push(await checkEditorConfig(targetDir));
+    results.push(await checkNodeVersionPin(targetDir));
     for (const spec of FILE_CHECKS) {
         results.push(await checkFile(targetDir, spec));
     }
+    results.push(await checkHusky(targetDir, pkg));
+    results.push(await checkLintStaged(targetDir, pkg));
+    results.push(await checkSemanticRelease(targetDir, pkg));
+    results.push(await checkKnip(targetDir, pkg));
+    results.push(await checkGitHubActions(targetDir));
+    results.push(await checkGitLabCI(targetDir));
     return results;
 }
 const STATUS_ICONS = {
@@ -186,7 +467,7 @@ export async function doctorCommand(options = {}) {
         for (const r of results) {
             console.log(`  ${STATUS_ICONS[r.status]} ${chalk.bold(r.check)} — ${statusLabel(r.status)}`);
             console.log(`     ${chalk.gray(r.detail)}`);
-            if (r.hint && (r.status === 'drift' || r.status === 'missing')) {
+            if (r.hint && r.status !== 'ok') {
                 console.log(`     ${chalk.dim('hint:')} ${chalk.dim(r.hint)}`);
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rtorcato/js-tooling",
-	"version": "2.2.0",
+	"version": "2.3.0",
 	"description": "JavaScript and TypeScript tooling for Node.js, React, Next.js, and Vitest.",
 	"type": "module",
 	"keywords": [