@rtorcato/js-tooling 2.11.0 → 2.12.0

package/dist/cli/commands/doctor.js

@@ -630,6 +630,23 @@ function checkLockfile(lock) {
         detail: `.js-tooling.json v${lock.version} (written by ${lock.writtenBy})`,
     };
 }
+async function checkCodeowners(dir) {
+    for (const candidate of ['CODEOWNERS', '.github/CODEOWNERS', 'docs/CODEOWNERS']) {
+        if (await fs.pathExists(path.join(dir, candidate))) {
+            return {
+                check: 'CODEOWNERS',
+                status: 'ok',
+                detail: `${candidate} found`,
+            };
+        }
+    }
+    return {
+        check: 'CODEOWNERS',
+        status: 'optional-missing',
+        detail: 'no CODEOWNERS file',
+        hint: 'Run `npx @rtorcato/js-tooling fix codeowners` to scaffold .github/CODEOWNERS',
+    };
+}
 async function checkGitLabCI(dir) {
     for (const candidate of ['.gitlab-ci.yml', '.gitlab-ci.yaml']) {
         if (await fs.pathExists(path.join(dir, candidate))) {
@@ -672,6 +689,7 @@ export async function runDoctor(dir) {
     results.push(await checkDependabot(targetDir));
     results.push(await checkCodeQL(targetDir));
     results.push(await checkGitLabCI(targetDir));
+    results.push(await checkCodeowners(targetDir));
     results.push(await checkTreeshakeSetup(targetDir, pkg));
     // Lockfile-driven demotion: if the lock records an intentional opt-out for a
     // check that's currently optional-missing, demote it to ok with a clear detail.

package/dist/cli/commands/fix-targets.js

@@ -20,6 +20,7 @@ export const FIX_TARGETS = {
     'GitHub Actions': 'github-actions',
     Dependabot: 'dependabot',
     CodeQL: 'codeql',
+    CODEOWNERS: 'codeowners',
     lockfile: 'lockfile',
     '.js-tooling.json': 'lockfile',
 };

package/dist/cli/commands/fix.js

@@ -6,7 +6,7 @@ import { generateSemanticReleaseConfig } from '../generators/build.js';
 import { generateCommitlintConfig, generateHuskyConfig, generatePrePushHook, } from '../generators/git.js';
 import { generateGitHubActions } from '../generators/github-actions.js';
 import { generateESLintConfig, generatePrettierConfig } from '../generators/linting.js';
-import { ensureEnginesNode, generateEditorConfig, generateKnipConfig, generateNvmrc, generateSizeLimitConfig, } from '../generators/misc.js';
+import { ensureEnginesNode, generateCodeowners, generateEditorConfig, generateKnipConfig, generateNvmrc, generateSizeLimitConfig, } from '../generators/misc.js';
 import { composeVerifyScriptFromPkg } from '../generators/package-json.js';
 import { generateCodeQLWorkflow, generateDependabotConfig } from '../generators/security.js';
 import { generateVitestConfig } from '../generators/testing.js';
@@ -229,6 +229,18 @@ const FIXERS = [
             return { filesWritten: ['.github/workflows/codeql.yml'] };
         },
     },
+    {
+        target: 'codeowners',
+        description: 'Scaffold .github/CODEOWNERS with commented examples',
+        appliesTo: ['CODEOWNERS'],
+        outputs: ['.github/CODEOWNERS'],
+        riskLevel: 'safe-add',
+        canFixDrift: false,
+        async run({ targetDir }) {
+            const written = await generateCodeowners(targetDir);
+            return { filesWritten: [written] };
+        },
+    },
     {
         target: 'editorconfig',
         description: 'Scaffold .editorconfig (UTF-8, LF, tab indent)',
@@ -380,6 +392,16 @@ function logTargets() {
         console.log(`  ${chalk.green('●')} ${chalk.bold(f.target)}: ${chalk.gray(f.description)}`);
     }
 }
+export function listFixers() {
+    return FIXERS.map((f) => ({
+        target: f.target,
+        description: f.description,
+        appliesTo: f.appliesTo,
+        outputs: f.outputs,
+        riskLevel: f.riskLevel ?? 'destructive',
+        canFixDrift: f.canFixDrift ?? false,
+    }));
+}
 async function applyFixer(fixer, result, targetDir, pkg, lock, dryRun, silent) {
     if (dryRun) {
         if (!silent) {
@@ -442,6 +464,21 @@ export async function fixCommand(target, options = {}) {
     // JSON mode implies --yes so prompts don't corrupt the output stream.
     const assumeYes = options.yes === true || json;
     const silent = json;
+    if (options.list) {
+        const summary = listFixers();
+        if (json) {
+            console.log(JSON.stringify({ targets: summary }, null, 2));
+            return;
+        }
+        console.log(chalk.cyan('\n🔧 Registered fix targets:\n'));
+        for (const f of summary) {
+            console.log(`  ${chalk.green('●')} ${chalk.bold(f.target)}`);
+            console.log(`     ${chalk.gray(f.description)}`);
+            console.log(`     ${chalk.dim(`risk=${f.riskLevel}, drift=${f.canFixDrift ? 'yes' : 'no'}, outputs=${f.outputs.join(', ')}`)}`);
+        }
+        console.log();
+        return;
+    }
     const pkg = await readPackageJson(targetDir);
     const lock = await readLockfile(targetDir);
     const results = await runDoctor(targetDir);

package/dist/cli/generators/misc.js

@@ -30,6 +30,20 @@ const SIZE_LIMIT_CONFIG = [
         limit: '10 kB',
     },
 ];
+const CODEOWNERS_CONTENT = `# .github/CODEOWNERS
+# Each line is a file pattern followed by one or more owners.
+# Owners can be GitHub usernames (@user) or team names (@org/team).
+# Order matters — the last matching pattern wins.
+# See https://docs.github.com/articles/about-code-owners/
+#
+# Examples:
+#   *              @your-username
+#   /src/api/      @backend-team
+#   /docs/         @docs-team @your-username
+#   *.md           @docs-team
+
+* @TODO-owner
+`;
 export async function generateEditorConfig(targetDir) {
     await fs.writeFile(path.join(targetDir, '.editorconfig'), EDITORCONFIG_CONTENT);
 }
@@ -54,6 +68,12 @@ export async function generateKnipConfig(targetDir) {
 export async function generateSizeLimitConfig(targetDir) {
     await fs.writeJson(path.join(targetDir, '.size-limit.json'), SIZE_LIMIT_CONFIG, { spaces: 2 });
 }
+export async function generateCodeowners(targetDir) {
+    const filepath = path.join(targetDir, '.github', 'CODEOWNERS');
+    await fs.ensureDir(path.dirname(filepath));
+    await fs.writeFile(filepath, CODEOWNERS_CONTENT);
+    return '.github/CODEOWNERS';
+}
 export async function generateMiscBaseline(targetDir) {
     await generateEditorConfig(targetDir);
     await generateNvmrc(targetDir);

package/dist/cli/index.js

@@ -221,15 +221,20 @@ program
     .option('--yes', 'Assume yes to all prompts (including drift overwrites)')
     .option('--dry-run', 'Print what would change without writing files')
     .option('--json', 'Emit machine-readable JSON output (implies --yes)')
+    .option('--list', 'List all registered fix targets and exit')
     .action((target, options) => fixCommand(target, {
     directory: options.directory,
     yes: options.yes,
     dryRun: options.dryRun,
     json: options.json,
+    list: options.list,
 }));
 program.hook('preAction', async (_, actionCommand) => {
     const name = actionCommand.name();
     if (name === 'setup' || name === 'doctor' || name === 'fix') {
+        // `fix --list` is read-only and safe to run anywhere, including this repo.
+        if (name === 'fix' && actionCommand.opts().list)
+            return;
         const dir = actionCommand.opts().directory ?? process.cwd();
         if (await isSelfRepo(dir)) {
             console.log(chalk.yellow('\n⚠️  This command cannot be run inside the @rtorcato/js-tooling repo itself.\n'));

package/package.json

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