@fgv/repo-template 5.1.0-2 → 5.1.0-21

package/config/rig.json

@@ -1,4 +0,0 @@
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
-  "rigPackageName": "@rushstack/heft-node-rig"
-}

package/rush-logs/repo-template.build.cache.log

@@ -1,4 +0,0 @@
-This project was not found in the build cache.
-Caching build output folders: lib, temp, .rush/temp/operation/build
-Successfully set cache entry.
-Cache key: 92e27a75687fa5062b71fdb897f0928a8aa4e0c9

package/rush-logs/repo-template.build.log

@@ -1,7 +0,0 @@
-Invoking: heft build --clean 
- ---- build started ---- 
-[build:clean] Deleted 0 files and 2 folders
-[build:typescript] The TypeScript compiler version 5.9.3 is newer than the latest version that was tested with Heft (5.8); it may not work correctly.
-[build:typescript] Using TypeScript version 5.9.3
- ---- build finished (0.796s) ---- 
--------------------- Finished (0.797s) --------------------

package/src/cli.ts

@@ -1,141 +0,0 @@
-/**
- * CLI entry point — sets up commander with create, sync, and patch subcommands.
- */
-
-import { Command } from 'commander';
-import { detectSourceDir } from './packlets/fs';
-import { runCreate } from './commands/create';
-import { runSync } from './commands/sync';
-import { runPatch, parsePatchArgs } from './commands/patch';
-import { runInitLibrary, RigType, CategoryType } from './commands/init-library';
-
-export class RepoTemplateCli {
-  private readonly _program: Command;
-
-  public constructor() {
-    this._program = new Command();
-    this._setupCommands();
-  }
-
-  public async run(argv: string[]): Promise<void> {
-    await this._program.parseAsync(argv);
-  }
-
-  private _setupCommands(): void {
-    this._program
-      .name('repo-template')
-      .description('Create and maintain fgv-derived Rush monorepos')
-      .version('5.1.0');
-
-    // ── create ──
-    this._program
-      .command('create')
-      .description('Stamp out a new fgv-derived Rush monorepo using rush init + JSONC patching')
-      .requiredOption('-t, --target-dir <path>', 'Directory to create the new repo in')
-      .requiredOption('-u, --repo-url <url>', 'GitHub repository URL')
-      .option('-p, --version-policy <name>', 'Version policy name', 'default')
-      .option('--initial-version <ver>', 'Initial version', '0.1.0')
-      .option('-s, --source-dir <path>', 'Source repo for shared files (auto-detected if in fgv repo)')
-      .option('--allow-existing', 'Allow target directory to already exist', false)
-      .option('--no-git-init', 'Skip git init and initial commit')
-      .action(async (opts) => {
-        const sourceDir = opts.sourceDir ?? this._resolveSourceDir();
-        await runCreate({
-          targetDir: opts.targetDir,
-          repoUrl: opts.repoUrl,
-          versionPolicy: opts.versionPolicy,
-          version: opts.initialVersion,
-          sourceDir,
-          allowExisting: opts.allowExisting,
-          gitInit: opts.gitInit
-        });
-      });
-
-    // ── sync ──
-    this._program
-      .command('sync')
-      .description('Sync shared files from the fgv source repo to a consumer repo')
-      .requiredOption('-t, --target-dir <path>', 'Consumer repo to update')
-      .option('-s, --source-dir <path>', 'Source repo (auto-detected if in fgv repo)')
-      .option('-n, --dry-run', 'Show what would change without modifying files', false)
-      .action(async (opts) => {
-        const sourceDir = opts.sourceDir ?? this._resolveSourceDir();
-        await runSync({
-          targetDir: opts.targetDir,
-          sourceDir,
-          dryRun: opts.dryRun
-        });
-      });
-
-    // ── init-library ──
-    this._program
-      .command('init-library')
-      .description('Scaffold a new library package within an existing Rush monorepo')
-      .requiredOption('-n, --name <name>', 'Package name (e.g. "ts-my-lib" — auto-prefixed with @fgv/)')
-      .option('-d, --description <text>', 'Package description', '')
-      .option('-r, --rig <type>', 'Heft rig: dual (default), node, or browser', 'dual')
-      .option(
-        '-c, --category <type>',
-        'Category folder: libraries (default), tools, apps, services',
-        'libraries'
-      )
-      .option('--repo-dir <path>', 'Rush monorepo root (default: cwd)', process.cwd())
-      .option('-p, --version-policy <name>', 'Version policy name', 'default')
-      .option('--initial-version <ver>', 'Initial version', '0.1.0')
-      .option(
-        '--fgv-dep-version <ver>',
-        'Version spec for @fgv/* deps ("workspace:*" in fgv, version range in consumers)',
-        'workspace:*'
-      )
-      .action(async (opts) => {
-        await runInitLibrary({
-          name: opts.name,
-          description: opts.description,
-          rig: opts.rig as RigType,
-          category: opts.category as CategoryType,
-          repoDir: opts.repoDir,
-          versionPolicy: opts.versionPolicy,
-          version: opts.initialVersion,
-          fgvDepVersion: opts.fgvDepVersion
-        });
-      });
-
-    // ── patch ──
-    this._program
-      .command('patch <file>')
-      .description('Apply targeted edits to a JSONC config file while preserving comments')
-      .allowUnknownOption(true)
-      .helpOption(false)
-      .action(async (file, _opts, cmd) => {
-        // Parse the raw args after the file argument as patch operations
-        const rawArgs = cmd.args.slice(1); // skip the file arg
-        // Actually, commander passes remaining args differently. Let's get them from process.argv
-        const allArgs = process.argv;
-        const patchIdx = allArgs.indexOf('patch');
-        const fileIdx = patchIdx + 1;
-        const opArgs = allArgs.slice(fileIdx + 1);
-
-        const operations = parsePatchArgs(opArgs);
-        if (operations.length === 0) {
-          console.error('No operations specified. Use --set, --uncomment, --add-to-array, etc.');
-          process.exit(1);
-        }
-        await runPatch({ file, operations });
-      });
-  }
-
-  /**
-   * Auto-detect the fgv source directory by walking up from the current working directory.
-   */
-  private _resolveSourceDir(): string {
-    const detected = detectSourceDir(process.cwd());
-    if (!detected) {
-      console.error(
-        'ERROR: Could not auto-detect fgv source repo. ' +
-          'Please specify --source-dir or run from within the fgv repository.'
-      );
-      process.exit(1);
-    }
-    return detected;
-  }
-}

package/src/commands/create.ts

@@ -1,216 +0,0 @@
-/**
- * Create command — stamps out a new fgv-derived Rush monorepo.
- *
- * Uses `rush init` to generate base config with full documentation,
- * then applies fgv-specific customizations via JSONC patching and shared file sync.
- */
-
-import * as fs from 'fs';
-import * as path from 'path';
-import { loadManifest, getDefaultManifestPath } from '../packlets/manifest';
-import { patchFile, IPatchOperation } from '../packlets/jsonc';
-import { renderTemplateFile, getDefaultTemplatesDir, ITemplateVars } from '../packlets/template';
-import { copyFile, copyPackage, exec, getGitCommit, getGitRemoteUrl } from '../packlets/fs';
-
-export interface ICreateOptions {
-  targetDir: string;
-  repoUrl: string;
-  versionPolicy: string;
-  version: string;
-  sourceDir: string;
-  allowExisting: boolean;
-  gitInit: boolean;
-}
-
-const RUSH_VERSION = '5.172.1';
-
-const NODE_VERSION_RANGE =
-  '>=14.15.0 <15.0.0 || >=16.13.0 <17.0.0 || >=18.15.0 <19.0.0 || >=20.18.0 <21.0.0 || >=22.22.0 <23.0.0';
-
-export async function runCreate(options: ICreateOptions): Promise<void> {
-  const { targetDir, repoUrl, versionPolicy, version, sourceDir, allowExisting, gitInit } = options;
-
-  // Validate
-  if (!allowExisting && fs.existsSync(targetDir)) {
-    throw new Error(`Target directory already exists: ${targetDir} (use --allow-existing to override)`);
-  }
-  if (!fs.existsSync(path.join(sourceDir, 'rush.json'))) {
-    throw new Error(`Source directory is not a Rush repo: ${sourceDir}`);
-  }
-
-  const manifestPath = getDefaultManifestPath();
-  const templatesDir = getDefaultTemplatesDir();
-  const manifest = loadManifest(manifestPath);
-
-  console.log(`Creating new monorepo at: ${targetDir}`);
-  console.log(`  Source repo: ${sourceDir}`);
-  console.log(`  Repo URL:    ${repoUrl}`);
-  console.log(`  Version:     ${versionPolicy}@${version}`);
-  console.log('');
-
-  fs.mkdirSync(targetDir, { recursive: true });
-
-  // ── Step 1: rush init ──
-  if (fs.existsSync(path.join(targetDir, 'rush.json'))) {
-    console.log('==> Target already has rush.json, skipping rush init');
-  } else {
-    console.log('==> Running rush init...');
-    try {
-      const output = exec(`npx "@microsoft/rush@${RUSH_VERSION}" init`, { cwd: targetDir });
-      for (const line of output.split('\n')) {
-        console.log(`  ${line}`);
-      }
-    } catch (err: unknown) {
-      // rush init writes to stderr for some messages, check if rush.json was created
-      if (!fs.existsSync(path.join(targetDir, 'rush.json'))) {
-        throw new Error(`rush init failed: ${(err as Error).message}`);
-      }
-    }
-  }
-
-  // ── Step 2: Patch rush.json ──
-  console.log('');
-  console.log('==> Patching rush.json with fgv customizations...');
-
-  const rushJsonOps: IPatchOperation[] = [
-    { type: 'set', path: 'nodeSupportedVersionRange', value: NODE_VERSION_RANGE },
-    { type: 'set', path: 'ensureConsistentVersions', value: true },
-    { type: 'uncomment', path: 'projectFolderMinDepth' },
-    { type: 'set', path: 'projectFolderMinDepth', value: 2 },
-    { type: 'uncomment', path: 'projectFolderMaxDepth' },
-    { type: 'set', path: 'projectFolderMaxDepth', value: 2 },
-    { type: 'uncomment', path: 'url' },
-    { type: 'set', path: 'repository.url', value: repoUrl },
-    { type: 'uncomment', path: 'defaultBranch' },
-    { type: 'uncomment', path: 'defaultRemote' }
-  ];
-
-  patchFile(path.join(targetDir, 'rush.json'), rushJsonOps);
-  for (const op of rushJsonOps) {
-    const desc =
-      op.type === 'uncomment' || op.type === 'remove'
-        ? `  ${op.type}: ${op.path}`
-        : `  ${op.type}: ${op.path}`;
-    console.log(desc);
-  }
-
-  // ── Step 3: Patch other rush config files ──
-  console.log('');
-  console.log('==> Patching rush config files...');
-
-  patchFile(path.join(targetDir, 'common/config/rush/build-cache.json'), [
-    { type: 'set', path: 'buildCacheEnabled', value: true }
-  ]);
-  console.log('  build-cache.json: buildCacheEnabled = true');
-
-  patchFile(path.join(targetDir, 'common/config/rush/pnpm-config.json'), [
-    { type: 'uncomment', path: 'strictPeerDependencies' },
-    { type: 'set', path: 'strictPeerDependencies', value: true }
-  ]);
-  console.log('  pnpm-config.json: strictPeerDependencies = true');
-
-  // ── Step 4: Generate templated files ──
-  console.log('');
-  console.log('==> Generating templated config files...');
-
-  const templateVars: ITemplateVars = {
-    REPO_URL: repoUrl,
-    VERSION_POLICY_NAME: versionPolicy,
-    VERSION: version
-  };
-
-  for (const tmpl of manifest.templated.files) {
-    const templatePath = path.join(sourceDir, tmpl.template);
-    const destPath = path.join(targetDir, tmpl.destination);
-    renderTemplateFile(templatePath, destPath, templateVars);
-  }
-
-  // ── Step 5: Copy shared files ──
-  console.log('');
-  console.log('==> Copying shared files...');
-
-  for (const file of manifest.shared.files) {
-    const srcPath = path.join(sourceDir, file.source);
-    const destPath = path.join(targetDir, file.destination);
-    if (!fs.existsSync(srcPath)) {
-      console.warn(`  WARNING: Source file not found, skipping: ${file.source}`);
-      continue;
-    }
-    copyFile(srcPath, destPath);
-    console.log(`  Copied: ${file.destination}`);
-  }
-
-  for (const pkg of manifest.sharedPackages.packages) {
-    const srcPath = path.join(sourceDir, pkg.source);
-    const destPath = path.join(targetDir, pkg.destination);
-    if (!fs.existsSync(srcPath)) {
-      console.warn(`  WARNING: Source directory not found, skipping: ${pkg.source}`);
-      continue;
-    }
-    copyPackage(srcPath, destPath);
-    console.log(`  Copied package: ${pkg.destination}`);
-  }
-
-  // ── Step 6: Create standard directories ──
-  console.log('');
-  console.log('==> Creating directory structure...');
-
-  const dirs = ['libraries', 'tools', 'apps', 'services', '.claude/project', '.claude/skills'];
-  for (const dir of dirs) {
-    fs.mkdirSync(path.join(targetDir, dir), { recursive: true });
-  }
-
-  const gitkeeps = ['.claude/project/.gitkeep', '.claude/skills/.gitkeep'];
-  for (const gk of gitkeeps) {
-    fs.writeFileSync(path.join(targetDir, gk), '');
-  }
-  console.log('  Created standard directory structure');
-
-  // ── Step 7: Record template metadata ──
-  console.log('');
-  console.log('==> Recording template metadata...');
-
-  const sourceCommit = getGitCommit(sourceDir);
-  const sourceRepo = getGitRemoteUrl(sourceDir);
-
-  const syncMetadata = {
-    templateSource: repoUrl,
-    sourceRepo,
-    sourceCommit,
-    createdAt: new Date().toISOString(),
-    lastSyncedAt: new Date().toISOString(),
-    manifestVersion: '1.0.0'
-  };
-  fs.writeFileSync(path.join(targetDir, '.template-sync'), JSON.stringify(syncMetadata, null, 2) + '\n');
-  console.log('  Created .template-sync');
-
-  // ── Step 8: Git init ──
-  if (gitInit) {
-    console.log('');
-    console.log('==> Initializing git repository...');
-    try {
-      exec('git init -b main', { cwd: targetDir });
-      exec('git add -A', { cwd: targetDir });
-      exec(
-        `git commit -m "Initial commit from fgv monorepo template\n\nSource: ${sourceDir}\nTemplate commit: ${sourceCommit}"`,
-        { cwd: targetDir }
-      );
-      console.log('  Git repository initialized with initial commit');
-    } catch (err: unknown) {
-      console.warn(`  WARNING: Git init failed: ${(err as Error).message}`);
-    }
-  }
-
-  // ── Done ──
-  console.log('');
-  console.log(`=== Monorepo created successfully at: ${targetDir} ===`);
-  console.log('');
-  console.log('Next steps:');
-  console.log('  1. Add your domain packages to libraries/, apps/, tools/, services/');
-  console.log('  2. Register them in rush.json');
-  console.log('  3. Fill in the project table in CLAUDE.md');
-  console.log('  4. Fill in ACTIVE_DEVELOPMENT.md with your domain projects');
-  console.log('  5. Add domain-specific Rush commands to common/config/rush/command-line.json');
-  console.log(`  6. Run: cd ${targetDir} && rush install && rush build`);
-  console.log('');
-}

package/src/commands/init-library.ts

@@ -1,249 +0,0 @@
-/**
- * init-library command — scaffolds a new library package within an existing Rush monorepo.
- */
-
-import * as fs from 'fs';
-import * as path from 'path';
-import { patchFile, IPatchOperation } from '../packlets/jsonc';
-
-export type RigType = 'dual' | 'node' | 'browser';
-export type CategoryType = 'libraries' | 'tools' | 'apps' | 'services';
-
-export interface IInitLibraryOptions {
-  /** Package name (e.g. "ts-my-lib" — will be prefixed with @fgv/) */
-  name: string;
-  /** Short description */
-  description: string;
-  /** Heft rig to use */
-  rig: RigType;
-  /** Category folder */
-  category: CategoryType;
-  /** Rush monorepo root */
-  repoDir: string;
-  /** Version policy name (from version-policies.json) */
-  versionPolicy: string;
-  /** Initial version */
-  version: string;
-  /** Dependency version for @fgv/* packages ("workspace:*" for fgv, "^5.1.0-0" for consumers) */
-  fgvDepVersion: string;
-}
-
-interface IRigConfig {
-  rigPackageName: string;
-  rigProfile?: string;
-  rigDevDeps: Record<string, string>;
-  tsconfigExtends: string;
-  tsconfigTypes: string[];
-  tsconfigLib?: string[];
-}
-
-const RIG_CONFIGS: Record<RigType, IRigConfig> = {
-  dual: {
-    rigPackageName: '@fgv/heft-dual-rig',
-    rigDevDeps: {
-      '@fgv/heft-dual-rig': 'FGV_DEP',
-      '@rushstack/heft': '1.2.7',
-      '@rushstack/heft-node-rig': '2.11.27'
-    },
-    tsconfigExtends: './node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json',
-    tsconfigTypes: ['heft-jest', 'node'],
-    tsconfigLib: ['es2018']
-  },
-  node: {
-    rigPackageName: '@rushstack/heft-node-rig',
-    rigDevDeps: {
-      '@rushstack/heft': '1.2.7',
-      '@rushstack/heft-node-rig': '2.11.27'
-    },
-    tsconfigExtends: './node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json',
-    tsconfigTypes: ['heft-jest', 'node']
-  },
-  browser: {
-    rigPackageName: '@rushstack/heft-web-rig',
-    rigProfile: 'library',
-    rigDevDeps: {
-      '@rushstack/heft': '1.2.7',
-      '@rushstack/heft-web-rig': '1.4.3'
-    },
-    tsconfigExtends: './node_modules/@rushstack/heft-web-rig/profiles/library/tsconfig-base.json',
-    tsconfigTypes: ['heft-jest', 'node'],
-    tsconfigLib: ['es2018', 'DOM']
-  }
-};
-
-export async function runInitLibrary(options: IInitLibraryOptions): Promise<void> {
-  const { name, description, rig, category, repoDir, versionPolicy, version, fgvDepVersion } = options;
-
-  const packageName = name.startsWith('@fgv/') ? name : `@fgv/${name}`;
-  const shortName = packageName.replace('@fgv/', '');
-  const projectFolder = `${category}/${shortName}`;
-  const projectDir = path.join(repoDir, projectFolder);
-
-  if (fs.existsSync(projectDir)) {
-    throw new Error(`Project directory already exists: ${projectDir}`);
-  }
-
-  const rushJsonPath = path.join(repoDir, 'rush.json');
-  if (!fs.existsSync(rushJsonPath)) {
-    throw new Error(`Not a Rush repo (no rush.json): ${repoDir}`);
-  }
-
-  const rigConfig = RIG_CONFIGS[rig];
-
-  console.log(`Initializing library: ${packageName}`);
-  console.log(`  Directory: ${projectFolder}`);
-  console.log(`  Rig:       ${rig} (${rigConfig.rigPackageName})`);
-  console.log(`  Version:   ${versionPolicy}@${version}`);
-  console.log('');
-
-  // ── Create directory structure ──
-  fs.mkdirSync(path.join(projectDir, 'src', 'test', 'unit'), { recursive: true });
-  fs.mkdirSync(path.join(projectDir, 'config'), { recursive: true });
-
-  // ── package.json ──
-  console.log('==> Creating package.json...');
-
-  const devDependencies: Record<string, string> = {};
-  // Add rig dependencies — @fgv/* packages use fgvDepVersion, others use their pinned version
-  for (const [dep, ver] of Object.entries(rigConfig.rigDevDeps)) {
-    devDependencies[dep] = dep.startsWith('@fgv/') ? fgvDepVersion : ver;
-  }
-  // Standard dev dependencies
-  devDependencies['@fgv/ts-utils-jest'] = fgvDepVersion;
-  devDependencies['@types/heft-jest'] = '1.0.6';
-  devDependencies['@types/jest'] = '^29.5.14';
-  devDependencies['@types/node'] = '^20.14.9';
-  devDependencies['typescript'] = '5.9.3';
-  devDependencies['@rushstack/eslint-config'] = '4.6.4';
-  devDependencies['eslint'] = '^9.39.2';
-
-  const packageJson: Record<string, unknown> = {
-    name: packageName,
-    version,
-    description,
-    main: 'lib/index.js',
-    types: 'lib/index.d.ts',
-    scripts: {
-      build: 'heft build --clean',
-      clean: 'heft clean',
-      test: 'heft test --clean',
-      coverage: 'jest --coverage',
-      lint: 'eslint src --ext .ts',
-      fixlint: 'eslint src --ext .ts --fix'
-    },
-    author: '',
-    license: 'MIT',
-    dependencies: {
-      '@fgv/ts-utils': fgvDepVersion,
-      '@fgv/ts-json-base': fgvDepVersion
-    },
-    devDependencies,
-    repository: {
-      type: 'git',
-      url: ''
-    }
-  };
-
-  // Add dual-emit exports for dual rig
-  if (rig === 'dual') {
-    packageJson['module'] = 'dist/index.js';
-    packageJson['exports'] = {
-      '.': {
-        types: './lib/index.d.ts',
-        import: './dist/index.js',
-        require: './lib/index.js',
-        default: './lib/index.js'
-      }
-    };
-  }
-
-  fs.writeFileSync(path.join(projectDir, 'package.json'), JSON.stringify(packageJson, null, 2) + '\n');
-
-  // ── tsconfig.json ──
-  console.log('  Creating tsconfig.json...');
-
-  const tsconfig: Record<string, unknown> = {
-    extends: rigConfig.tsconfigExtends,
-    compilerOptions: {
-      types: rigConfig.tsconfigTypes,
-      ...(rigConfig.tsconfigLib ? { lib: rigConfig.tsconfigLib } : {})
-    }
-  };
-
-  fs.writeFileSync(path.join(projectDir, 'tsconfig.json'), JSON.stringify(tsconfig, null, 2) + '\n');
-
-  // ── config/rig.json ──
-  console.log('  Creating config/rig.json...');
-
-  const rigJson: Record<string, unknown> = {
-    $schema: 'https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json',
-    rigPackageName: rigConfig.rigPackageName
-  };
-  if (rigConfig.rigProfile) {
-    rigJson['rigProfile'] = rigConfig.rigProfile;
-  }
-
-  fs.writeFileSync(path.join(projectDir, 'config', 'rig.json'), JSON.stringify(rigJson, null, 2) + '\n');
-
-  // ── config/jest.config.json ──
-  console.log('  Creating config/jest.config.json...');
-
-  const jestConfig = {
-    extends: '@rushstack/heft-node-rig/profiles/default/config/jest.config.json',
-    coverageThreshold: {
-      global: {
-        branches: 100,
-        functions: 100,
-        lines: 100,
-        statements: 100
-      }
-    },
-    collectCoverage: true,
-    coverageReporters: ['text', 'lcov', 'html']
-  };
-
-  fs.writeFileSync(
-    path.join(projectDir, 'config', 'jest.config.json'),
-    JSON.stringify(jestConfig, null, 2) + '\n'
-  );
-
-  // ── src/index.ts ──
-  console.log('  Creating src/index.ts...');
-
-  fs.writeFileSync(
-    path.join(projectDir, 'src', 'index.ts'),
-    `/**\n * @packageDocumentation\n * ${description}\n */\n`
-  );
-
-  // ── Register in rush.json ──
-  console.log('');
-  console.log('==> Registering in rush.json...');
-
-  const rushJsonOps: IPatchOperation[] = [
-    {
-      type: 'add-to-array',
-      path: 'projects',
-      value: JSON.stringify({
-        packageName,
-        projectFolder,
-        shouldPublish: true,
-        versionPolicyName: versionPolicy,
-        tags: [category]
-      })
-    }
-  ];
-
-  patchFile(rushJsonPath, rushJsonOps);
-  console.log(`  Added ${packageName} at ${projectFolder}`);
-
-  // ── Done ──
-  console.log('');
-  console.log(`=== Library ${packageName} initialized at ${projectFolder} ===`);
-  console.log('');
-  console.log('Next steps:');
-  console.log(`  1. cd ${projectDir}`);
-  console.log('  2. rush update');
-  console.log('  3. rushx build');
-  console.log('  4. Start adding code to src/');
-  console.log('');
-}