@produck/agent-toolkit 0.8.2 → 0.9.1

package/bin/command/sync-git/index.mjs

@@ -13,8 +13,14 @@ const PACKAGE_ROOT = path.resolve(COMMAND_DIR, '../../..');
 const REPO_ROOT = path.resolve(PACKAGE_ROOT, '../..');
 const TOOLKIT_PACKAGE_JSON = path.resolve(PACKAGE_ROOT, 'package.json');
 const TOOLING_BASELINE_CANDIDATE_PATHS = [
-  path.resolve(REPO_ROOT, '.github/distribution/produck/tooling-version-baseline.json'),
-  path.resolve(PACKAGE_ROOT, 'publish-assets/instructions/produck/tooling-version-baseline.json'),
+  path.resolve(
+    REPO_ROOT,
+    '.github/distribution/produck/tooling-version-baseline.json',
+  ),
+  path.resolve(
+    PACKAGE_ROOT,
+    'publish-assets/instructions/produck/tooling-version-baseline.json',
+  ),
 ];
 
 const GITATTRIBUTES_FILE = '.gitattributes';
@@ -26,7 +32,8 @@ const REQUIRED_BASELINE_SCRIPT_KEY = 'produck:baseline';
 const REQUIRED_BASELINE_SCRIPT_VALUE =
   'npm exec --package=@produck/agent-toolkit@latest -- agent-toolkit enforce-node-baseline --cwd .';
 const REQUIRED_COMMIT_CHECK_SCRIPT_KEY = 'produck:commit:check';
-const REQUIRED_COMMIT_CHECK_SCRIPT_VALUE = 'npm run produck:format && npm run produck:lint';
+const REQUIRED_COMMIT_CHECK_SCRIPT_VALUE =
+  'npm run produck:format && npm run produck:lint';
 const REQUIRED_PREPARE_SCRIPT_KEY = 'prepare';
 const REQUIRED_PREPARE_SCRIPT_VALUE = 'husky';
 
@@ -39,7 +46,8 @@ const GITIGNORE_SOURCE_CANDIDATE_PATHS = [
   path.resolve(PACKAGE_ROOT, 'publish-assets/gitignore'),
 ];
 
-const REQUIRED_PRE_COMMIT_HOOK = '#!/usr/bin/env sh\nnpm run produck:commit:check\n';
+const REQUIRED_PRE_COMMIT_HOOK =
+  '#!/usr/bin/env sh\nnpm run produck:commit:check\n';
 const REQUIRED_COMMIT_MSG_HOOK =
   '#!/usr/bin/env sh\nnode ./node_modules/@produck/agent-toolkit/bin/agent-toolkit.mjs validate-commit-msg --file "$1"\n';
 
@@ -57,26 +65,40 @@ function parseJsonFile(filePath, label) {
 }
 
 function getRequiredToolkitDevDependency() {
-  const overrideVersion = String(process.env.PRODUCK_TOOLKIT_VERSION_OVERRIDE || '').trim();
+  const overrideVersion = String(
+    process.env.PRODUCK_TOOLKIT_VERSION_OVERRIDE || '',
+  ).trim();
   if (overrideVersion) {
     return overrideVersion;
   }
-
+  // The 'npm' (non-.cmd) branch is only reached on non-Windows platforms.
+  // Tests run on Windows only.
+  /* c8 ignore next */
   const npmCommand = process.platform === 'win32' ? 'npm.cmd' : 'npm';
-  const latestResult = spawnSync(npmCommand, ['view', '@produck/agent-toolkit', 'version'], {
-    encoding: 'utf8',
-  });
+  const latestResult = spawnSync(
+    npmCommand,
+    ['view', '@produck/agent-toolkit', 'version'],
+    {
+      encoding: 'utf8',
+    },
+  );
 
   const latestVersion = String(latestResult.stdout || '').trim();
+  // The npm registry call succeeds with a version in production but is not made
+  // during tests (no network access).
+  /* c8 ignore start */
   if (latestResult.status === 0 && latestVersion) {
     return latestVersion;
   }
+  /* c8 ignore stop */
 
   const pkg = parseJsonFile(TOOLKIT_PACKAGE_JSON, 'Toolkit package.json');
   const version = typeof pkg.version === 'string' ? pkg.version.trim() : '';
 
   if (!version) {
-    console.error(`Toolkit package version is missing: ${TOOLKIT_PACKAGE_JSON}`);
+    console.error(
+      `Toolkit package version is missing: ${TOOLKIT_PACKAGE_JSON}`,
+    );
     process.exit(2);
   }
 
@@ -84,12 +106,16 @@ function getRequiredToolkitDevDependency() {
 }
 
 function loadToolingBaseline() {
-  const toolingBaselinePath = TOOLING_BASELINE_CANDIDATE_PATHS.find((candidatePath) => {
-    return fs.existsSync(candidatePath);
-  });
+  const toolingBaselinePath = TOOLING_BASELINE_CANDIDATE_PATHS.find(
+    (candidatePath) => {
+      return fs.existsSync(candidatePath);
+    },
+  );
 
   if (!toolingBaselinePath) {
-    console.error('Tooling baseline file does not exist in expected locations:');
+    console.error(
+      'Tooling baseline file does not exist in expected locations:',
+    );
     for (const candidatePath of TOOLING_BASELINE_CANDIDATE_PATHS) {
       console.error(`- ${candidatePath}`);
     }
@@ -134,16 +160,20 @@ function findMissingGitignoreEntries(currentContent, requiredEntries) {
     return [...requiredEntries];
   }
 
-  const existingLines = new Set(currentContent.split('\n').map((line) => line.trimEnd()));
+  const existingLines = new Set(
+    currentContent.split('\n').map((line) => line.trimEnd()),
+  );
 
   return requiredEntries.filter((entry) => !existingLines.has(entry));
 }
 
 function loadGitSourceFiles() {
-  const gitattributesSourcePath = GITATTRIBUTES_SOURCE_CANDIDATE_PATHS.find((p) =>
+  const gitattributesSourcePath = GITATTRIBUTES_SOURCE_CANDIDATE_PATHS.find(
+    (p) => fs.existsSync(p),
+  );
+  const gitignoreSourcePath = GITIGNORE_SOURCE_CANDIDATE_PATHS.find((p) =>
     fs.existsSync(p),
   );
-  const gitignoreSourcePath = GITIGNORE_SOURCE_CANDIDATE_PATHS.find((p) => fs.existsSync(p));
 
   if (!gitattributesSourcePath) {
     console.error('Org .gitattributes source not found in expected locations:');
@@ -175,7 +205,9 @@ function loadGitSourceFiles() {
 
 function buildScriptState(pkg) {
   const scripts =
-    pkg.scripts && typeof pkg.scripts === 'object' && !Array.isArray(pkg.scripts)
+    pkg.scripts &&
+    typeof pkg.scripts === 'object' &&
+    !Array.isArray(pkg.scripts)
       ? { ...pkg.scripts }
       : {};
 
@@ -207,8 +239,14 @@ function buildDevDependencyState(pkg) {
   return {
     devDependencies,
     previousManaged: {
-      husky: typeof devDependencies.husky === 'string' ? devDependencies.husky : null,
-      lerna: typeof devDependencies.lerna === 'string' ? devDependencies.lerna : null,
+      husky:
+        typeof devDependencies.husky === 'string'
+          ? devDependencies.husky
+          : null,
+      lerna:
+        typeof devDependencies.lerna === 'string'
+          ? devDependencies.lerna
+          : null,
       '@produck/agent-toolkit':
         typeof devDependencies['@produck/agent-toolkit'] === 'string'
           ? devDependencies['@produck/agent-toolkit']
@@ -260,11 +298,15 @@ export function runSyncGit(options) {
     requiredDevDependencies,
   );
 
-  const matchesRequiredBaseline = !(REQUIRED_BASELINE_SCRIPT_KEY in scriptValidation.mismatches);
+  const matchesRequiredBaseline = !(
+    REQUIRED_BASELINE_SCRIPT_KEY in scriptValidation.mismatches
+  );
   const matchesRequiredCommitCheck = !(
     REQUIRED_COMMIT_CHECK_SCRIPT_KEY in scriptValidation.mismatches
   );
-  const matchesRequiredPrepare = !(REQUIRED_PREPARE_SCRIPT_KEY in scriptValidation.mismatches);
+  const matchesRequiredPrepare = !(
+    REQUIRED_PREPARE_SCRIPT_KEY in scriptValidation.mismatches
+  );
   const matchesRequiredManagedDevDependencies = dependencyValidation.ok;
 
   const gitAttributesPath = path.resolve(cwd, GITATTRIBUTES_FILE);
@@ -280,14 +322,17 @@ export function runSyncGit(options) {
   const gitignoreExists = currentGitignoreContent !== null;
   const preCommitHookExists = currentPreCommitHook !== null;
   const commitMsgHookExists = currentCommitMsgHook !== null;
-  const matchesRequiredGitAttributes = currentContent === requiredGitAttributesContent;
+  const matchesRequiredGitAttributes =
+    currentContent === requiredGitAttributesContent;
   const missingGitignoreEntries = findMissingGitignoreEntries(
     currentGitignoreContent,
     gitignoreRequiredEntries,
   );
   const matchesRequiredGitignore = missingGitignoreEntries.length === 0;
-  const matchesRequiredPreCommitHook = currentPreCommitHook === REQUIRED_PRE_COMMIT_HOOK;
-  const matchesRequiredCommitMsgHook = currentCommitMsgHook === REQUIRED_COMMIT_MSG_HOOK;
+  const matchesRequiredPreCommitHook =
+    currentPreCommitHook === REQUIRED_PRE_COMMIT_HOOK;
+  const matchesRequiredCommitMsgHook =
+    currentCommitMsgHook === REQUIRED_COMMIT_MSG_HOOK;
 
   const mismatches = [];
   if (!matchesRequiredGitAttributes) {
@@ -337,16 +382,23 @@ export function runSyncGit(options) {
         fs.writeFileSync(gitignorePath, gitignoreOrgContent, 'utf8');
       } else {
         const appendText = `\n# produck:org-baseline\n${missingGitignoreEntries.join('\n')}\n`;
-        fs.writeFileSync(gitignorePath, currentGitignoreContent + appendText, 'utf8');
+        fs.writeFileSync(
+          gitignorePath,
+          currentGitignoreContent + appendText,
+          'utf8',
+        );
       }
     }
 
     fs.writeFileSync(preCommitHookPath, REQUIRED_PRE_COMMIT_HOOK, 'utf8');
     fs.writeFileSync(commitMsgHookPath, REQUIRED_COMMIT_MSG_HOOK, 'utf8');
 
-    scriptState.scripts[REQUIRED_BASELINE_SCRIPT_KEY] = REQUIRED_BASELINE_SCRIPT_VALUE;
-    scriptState.scripts[REQUIRED_COMMIT_CHECK_SCRIPT_KEY] = REQUIRED_COMMIT_CHECK_SCRIPT_VALUE;
-    scriptState.scripts[REQUIRED_PREPARE_SCRIPT_KEY] = REQUIRED_PREPARE_SCRIPT_VALUE;
+    scriptState.scripts[REQUIRED_BASELINE_SCRIPT_KEY] =
+      REQUIRED_BASELINE_SCRIPT_VALUE;
+    scriptState.scripts[REQUIRED_COMMIT_CHECK_SCRIPT_KEY] =
+      REQUIRED_COMMIT_CHECK_SCRIPT_VALUE;
+    scriptState.scripts[REQUIRED_PREPARE_SCRIPT_KEY] =
+      REQUIRED_PREPARE_SCRIPT_VALUE;
     pkg.scripts = scriptState.scripts;
 
     for (const [name, version] of Object.entries(requiredDevDependencies)) {
@@ -354,7 +406,11 @@ export function runSyncGit(options) {
     }
     pkg.devDependencies = dependencyState.devDependencies;
 
-    fs.writeFileSync(rootPackageJsonPath, `${JSON.stringify(pkg, null, 2)}\n`, 'utf8');
+    fs.writeFileSync(
+      rootPackageJsonPath,
+      `${JSON.stringify(pkg, null, 2)}\n`,
+      'utf8',
+    );
   }
 
   const report = {
@@ -393,12 +449,16 @@ export function runSyncGit(options) {
       matchesRequiredBaselineBefore: matchesRequiredBaseline,
       matchesRequiredCommitCheckBefore: matchesRequiredCommitCheck,
       matchesRequiredPrepareBefore: matchesRequiredPrepare,
-      matchesRequiredManagedDevDependenciesBefore: matchesRequiredManagedDevDependencies,
+      matchesRequiredManagedDevDependenciesBefore:
+        matchesRequiredManagedDevDependencies,
       mismatchesBefore: mismatches,
       fileExistsAfter: requiresUpdate && mode === 'sync' ? true : fileExists,
-      gitignoreExistsAfter: requiresUpdate && mode === 'sync' ? true : gitignoreExists,
-      preCommitHookExistsAfter: requiresUpdate && mode === 'sync' ? true : preCommitHookExists,
-      commitMsgHookExistsAfter: requiresUpdate && mode === 'sync' ? true : commitMsgHookExists,
+      gitignoreExistsAfter:
+        requiresUpdate && mode === 'sync' ? true : gitignoreExists,
+      preCommitHookExistsAfter:
+        requiresUpdate && mode === 'sync' ? true : preCommitHookExists,
+      commitMsgHookExistsAfter:
+        requiresUpdate && mode === 'sync' ? true : commitMsgHookExists,
       matchesRequiredGitAttributesAfter:
         requiresUpdate && mode === 'sync' ? true : matchesRequiredGitAttributes,
       matchesRequiredGitignoreAfter:
@@ -416,7 +476,9 @@ export function runSyncGit(options) {
       matchesRequiredPrepareAfter:
         requiresUpdate && mode === 'sync' ? true : matchesRequiredPrepare,
       matchesRequiredManagedDevDependenciesAfter:
-        requiresUpdate && mode === 'sync' ? true : matchesRequiredManagedDevDependencies,
+        requiresUpdate && mode === 'sync'
+          ? true
+          : matchesRequiredManagedDevDependencies,
       mismatchesAfter: requiresUpdate && mode === 'sync' ? [] : mismatches,
       updated: requiresUpdate && mode === 'sync',
     },

package/bin/command/sync-install/index.mjs

@@ -44,7 +44,9 @@ export function runSyncInstall(options) {
 
   const pkg = parseJsonFile(rootPackageJsonPath, 'Root package.json');
   const scripts =
-    pkg.scripts && typeof pkg.scripts === 'object' && !Array.isArray(pkg.scripts)
+    pkg.scripts &&
+    typeof pkg.scripts === 'object' &&
+    !Array.isArray(pkg.scripts)
       ? { ...pkg.scripts }
       : {};
 
@@ -57,7 +59,8 @@ export function runSyncInstall(options) {
       ? scripts[LEGACY_INSTALL_SCRIPT_KEY]
       : null;
 
-  const matchesRequiredInstall = previousInstall === REQUIRED_INSTALL_SCRIPT_VALUE;
+  const matchesRequiredInstall =
+    previousInstall === REQUIRED_INSTALL_SCRIPT_VALUE;
   const legacyInstallScriptPresent = previousLegacyInstall !== null;
   const requiresUpdate = !matchesRequiredInstall || legacyInstallScriptPresent;
 
@@ -65,7 +68,11 @@ export function runSyncInstall(options) {
     delete scripts[LEGACY_INSTALL_SCRIPT_KEY];
     scripts[REQUIRED_INSTALL_SCRIPT_KEY] = REQUIRED_INSTALL_SCRIPT_VALUE;
     pkg.scripts = scripts;
-    fs.writeFileSync(rootPackageJsonPath, `${JSON.stringify(pkg, null, 2)}\n`, 'utf8');
+    fs.writeFileSync(
+      rootPackageJsonPath,
+      `${JSON.stringify(pkg, null, 2)}\n`,
+      'utf8',
+    );
   }
 
   const report = {

package/bin/command/sync-instructions/index.mjs

@@ -3,18 +3,30 @@ import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 
 import { getSingle, hasFlag } from '../shared/args.mjs';
-import { loadTextResource, printTextResource } from '../shared/text-resource.mjs';
+import {
+  loadTextResource,
+  printTextResource,
+} from '../shared/text-resource.mjs';
 
 const COMMAND_DIR = path.dirname(fileURLToPath(import.meta.url));
 const PACKAGE_ROOT = path.resolve(COMMAND_DIR, '../../..');
 const PUBLISH_ASSETS_ROOT = path.resolve(PACKAGE_ROOT, 'publish-assets');
-const PUBLISH_INSTRUCTIONS_ROOT = path.resolve(PUBLISH_ASSETS_ROOT, 'instructions');
-const PUBLISH_NAMESPACE_ROOT = path.resolve(PUBLISH_INSTRUCTIONS_ROOT, 'produck');
+const PUBLISH_INSTRUCTIONS_ROOT = path.resolve(
+  PUBLISH_ASSETS_ROOT,
+  'instructions',
+);
+const PUBLISH_NAMESPACE_ROOT = path.resolve(
+  PUBLISH_INSTRUCTIONS_ROOT,
+  'produck',
+);
 const MANAGED_MARKER = '<!-- managed-by: @produck/agent-toolkit -->';
 const DEFAULT_NAMESPACE_OUT_DIR = '.github/instructions/produck';
 const USER_SPACE_ENTRYPOINT = '.github/copilot-instructions.md';
 const HELP_FILE = path.resolve(COMMAND_DIR, 'help.txt');
-const USER_SPACE_BOOTSTRAP_FILE = path.resolve(COMMAND_DIR, 'user-space-bootstrap.md');
+const USER_SPACE_BOOTSTRAP_FILE = path.resolve(
+  COMMAND_DIR,
+  'user-space-bootstrap.md',
+);
 
 export function printSyncInstructionsHelp() {
   printTextResource(HELP_FILE);
@@ -46,7 +58,9 @@ function loadDefaultInstructionsTemplate() {
   }
 
   console.error('No built-in instruction assets found.');
-  console.error('Run prepack/publish to generate publish-assets, or pass --source explicitly.');
+  console.error(
+    'Run prepack/publish to generate publish-assets, or pass --source explicitly.',
+  );
   process.exit(2);
 }
 
@@ -75,9 +89,14 @@ function isManagedFile(filePath) {
 }
 
 function buildUserSpaceBootstrapContent(namespaceDirPath, cwd) {
-  const namespaceDisplayPath = path.relative(cwd, namespaceDirPath).replace(/\\/g, '/');
+  const namespaceDisplayPath = path
+    .relative(cwd, namespaceDirPath)
+    .replace(/\\/g, '/');
   let content = loadTextResource(USER_SPACE_BOOTSTRAP_FILE);
-  content = content.replace(/\{\{NAMESPACE_GLOB\}\}/g, `${namespaceDisplayPath}/*.instructions.md`);
+  content = content.replace(
+    /\{\{NAMESPACE_GLOB\}\}/g,
+    `${namespaceDisplayPath}/*.instructions.md`,
+  );
   if (!content.endsWith('\n')) {
     content = `${content}\n`;
   }
@@ -114,7 +133,9 @@ export function runSyncInstructions(options) {
       sourceResolved = sourcePath;
       entries = readInstructionEntriesFromDirectory(sourcePath);
       if (entries.length === 0) {
-        console.error(`No .instructions.md files in source directory: ${sourcePath}`);
+        console.error(
+          `No .instructions.md files in source directory: ${sourcePath}`,
+        );
         process.exit(2);
       }
     } else {
@@ -138,7 +159,9 @@ export function runSyncInstructions(options) {
   const outLooksLikeFile = outArg.endsWith('.md');
 
   if (outLooksLikeFile && entries.length > 1) {
-    console.error('Target --out is a file path but source has multiple instruction files.');
+    console.error(
+      'Target --out is a file path but source has multiple instruction files.',
+    );
     console.error('Use an output directory for multi-file sync.');
     process.exit(2);
   }
@@ -190,7 +213,9 @@ export function runSyncInstructions(options) {
     }
   }
 
-  const toWrite = planned.filter((item) => !unchanged.includes(item.targetPath));
+  const toWrite = planned.filter(
+    (item) => !unchanged.includes(item.targetPath),
+  );
 
   const pruneDeletes = [];
   if (prune && fs.existsSync(outDir)) {

package/bin/command/sync-lint/eslint.config.template.mjs

@@ -0,0 +1,32 @@
+import js from '@eslint/js';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+import json from '@eslint/json';
+import markdown from '@eslint/markdown';
+import { defineConfig } from 'eslint/config';
+import * as ProduckRule from '@produck/eslint-rules';
+
+export default defineConfig([
+  {
+    files: ['**/*.{js,mjs,cjs,ts,mts,cts}'],
+    plugins: { js },
+    extends: ['js/recommended'],
+    languageOptions: { globals: { ...globals.browser, ...globals.node } },
+  },
+  tseslint.configs.recommended,
+  {
+    files: ['**/*.json'],
+    ignores: ['**/package-lock.json'],
+    plugins: { json },
+    language: 'json/json',
+    extends: ['json/recommended'],
+  },
+  {
+    files: ['**/*.md'],
+    plugins: { markdown },
+    language: 'markdown/gfm',
+    extends: ['markdown/recommended'],
+  },
+  ProduckRule.config,
+  ProduckRule.excludeGitIgnore(import.meta.url),
+]);