@git.zone/cli 2.13.10 → 2.13.12

package/ts/mod_format/formatters/smartconfig.formatter.ts

@@ -0,0 +1,213 @@
+import { BaseFormatter } from '../classes.baseformatter.js';
+import type { IPlannedChange } from '../interfaces.format.js';
+import * as plugins from '../mod.plugins.js';
+import { logger, logVerbose } from '../../gitzone.logging.js';
+
+/**
+ * Migrates .smartconfig.json from old namespace keys to new package-scoped keys
+ */
+const migrateNamespaceKeys = (smartconfigJson: any): boolean => {
+  let migrated = false;
+  const migrations = [
+    { oldKey: 'gitzone', newKey: '@git.zone/cli' },
+    { oldKey: 'tsdoc', newKey: '@git.zone/tsdoc' },
+    { oldKey: 'npmdocker', newKey: '@git.zone/tsdocker' },
+    { oldKey: 'npmci', newKey: '@ship.zone/szci' },
+    { oldKey: 'szci', newKey: '@ship.zone/szci' },
+  ];
+  for (const { oldKey, newKey } of migrations) {
+    if (smartconfigJson[oldKey]) {
+      if (!smartconfigJson[newKey]) {
+        smartconfigJson[newKey] = smartconfigJson[oldKey];
+      } else {
+        smartconfigJson[newKey] = {
+          ...smartconfigJson[oldKey],
+          ...smartconfigJson[newKey],
+        };
+      }
+      delete smartconfigJson[oldKey];
+      migrated = true;
+    }
+  }
+  return migrated;
+};
+
+/**
+ * Migrates npmAccessLevel from @ship.zone/szci to @git.zone/cli.release.accessLevel
+ */
+const migrateAccessLevel = (smartconfigJson: any): boolean => {
+  const szciConfig = smartconfigJson['@ship.zone/szci'];
+
+  if (!szciConfig?.npmAccessLevel) {
+    return false;
+  }
+
+  const gitzoneConfig = smartconfigJson['@git.zone/cli'] || {};
+  if (gitzoneConfig?.release?.accessLevel) {
+    delete szciConfig.npmAccessLevel;
+    return true;
+  }
+
+  if (!smartconfigJson['@git.zone/cli']) {
+    smartconfigJson['@git.zone/cli'] = {};
+  }
+  if (!smartconfigJson['@git.zone/cli'].release) {
+    smartconfigJson['@git.zone/cli'].release = {};
+  }
+
+  smartconfigJson['@git.zone/cli'].release.accessLevel = szciConfig.npmAccessLevel;
+  delete szciConfig.npmAccessLevel;
+
+  return true;
+};
+
+// Config file names in priority order (newest → oldest)
+const CONFIG_FILE_NAMES = ['.smartconfig.json', 'smartconfig.json', 'npmextra.json'];
+const TARGET_CONFIG_FILE = '.smartconfig.json';
+
+export class SmartconfigFormatter extends BaseFormatter {
+  get name(): string {
+    return 'smartconfig';
+  }
+
+  /**
+   * Find the config file, checking in priority order.
+   * Returns the path and whether it needs renaming.
+   */
+  private async findConfigFile(): Promise<{ path: string; needsRename: boolean } | null> {
+    for (const filename of CONFIG_FILE_NAMES) {
+      const exists = await plugins.smartfs.file(filename).exists();
+      if (exists) {
+        return {
+          path: filename,
+          needsRename: filename !== TARGET_CONFIG_FILE,
+        };
+      }
+    }
+    return null;
+  }
+
+  async analyze(): Promise<IPlannedChange[]> {
+    const changes: IPlannedChange[] = [];
+
+    const configFile = await this.findConfigFile();
+    if (!configFile) {
+      logVerbose('No config file found (.smartconfig.json, smartconfig.json, or npmextra.json), skipping');
+      return changes;
+    }
+
+    // Read current content
+    const currentContent = (await plugins.smartfs
+      .file(configFile.path)
+      .encoding('utf8')
+      .read()) as string;
+
+    // Parse and apply migrations
+    const smartconfigJson = JSON.parse(currentContent);
+    migrateNamespaceKeys(smartconfigJson);
+    migrateAccessLevel(smartconfigJson);
+
+    // Ensure namespaces exist
+    if (!smartconfigJson['@git.zone/cli']) {
+      smartconfigJson['@git.zone/cli'] = {};
+    }
+    if (!smartconfigJson['@ship.zone/szci']) {
+      smartconfigJson['@ship.zone/szci'] = {};
+    }
+
+    const newContent = JSON.stringify(smartconfigJson, null, 2);
+
+    // If file needs renaming, plan a create + delete
+    if (configFile.needsRename) {
+      changes.push({
+        type: 'create',
+        path: TARGET_CONFIG_FILE,
+        module: this.name,
+        description: `Migrate ${configFile.path} to ${TARGET_CONFIG_FILE}`,
+        content: newContent,
+      });
+      changes.push({
+        type: 'delete',
+        path: configFile.path,
+        module: this.name,
+        description: `Remove old ${configFile.path}`,
+      });
+    } else if (newContent !== currentContent) {
+      // File is already .smartconfig.json, just needs content update
+      changes.push({
+        type: 'modify',
+        path: TARGET_CONFIG_FILE,
+        module: this.name,
+        description: 'Migrate and format .smartconfig.json',
+        content: newContent,
+      });
+    }
+
+    return changes;
+  }
+
+  async applyChange(change: IPlannedChange): Promise<void> {
+    if (change.type === 'delete') {
+      await this.deleteFile(change.path);
+      logger.log('info', `Removed old config file ${change.path}`);
+      return;
+    }
+
+    if (!change.content) return;
+
+    // Parse the content to check for missing required fields
+    const smartconfigJson = JSON.parse(change.content);
+
+    const expectedRepoInformation: string[] = [
+      'projectType',
+      'module.githost',
+      'module.gitscope',
+      'module.gitrepo',
+      'module.description',
+      'module.npmPackagename',
+      'module.license',
+    ];
+
+    const interactInstance = new plugins.smartinteract.SmartInteract();
+    for (const expectedRepoInformationItem of expectedRepoInformation) {
+      if (
+        !plugins.smartobject.smartGet(
+          smartconfigJson['@git.zone/cli'],
+          expectedRepoInformationItem,
+        )
+      ) {
+        interactInstance.addQuestions([
+          {
+            message: `What is the value of ${expectedRepoInformationItem}`,
+            name: expectedRepoInformationItem,
+            type: 'input',
+            default: 'undefined variable',
+          },
+        ]);
+      }
+    }
+
+    const answerbucket = await interactInstance.runQueue();
+    for (const expectedRepoInformationItem of expectedRepoInformation) {
+      const cliProvidedValue = answerbucket.getAnswerFor(
+        expectedRepoInformationItem,
+      );
+      if (cliProvidedValue) {
+        plugins.smartobject.smartAdd(
+          smartconfigJson['@git.zone/cli'],
+          expectedRepoInformationItem,
+          cliProvidedValue,
+        );
+      }
+    }
+
+    const finalContent = JSON.stringify(smartconfigJson, null, 2);
+
+    if (change.type === 'create') {
+      await this.createFile(change.path, finalContent);
+    } else {
+      await this.modifyFile(change.path, finalContent);
+    }
+    logger.log('info', `Updated ${change.path}`);
+  }
+}

package/ts/mod_format/formatters/templates.formatter.ts

@@ -9,6 +9,32 @@ export class TemplatesFormatter extends BaseFormatter {
     return 'templates';
   }
 
+  /**
+   * Render a template directory through smartscaf and return a map of path → content.
+   */
+  private async renderTemplate(templateName: string): Promise<Map<string, string>> {
+    const templateDir = plugins.path.join(paths.templatesDir, templateName);
+
+    const scafTemplate = new plugins.smartscaf.ScafTemplate(templateDir);
+    await scafTemplate.readTemplateFromDir();
+
+    const gitzoneData = this.project.gitzoneConfig?.data;
+    if (gitzoneData) {
+      await scafTemplate.supplyVariables({
+        module: gitzoneData.module,
+        projectType: gitzoneData.projectType,
+      });
+    }
+
+    const renderedFiles = await scafTemplate.renderToMemory();
+
+    const fileMap = new Map<string, string>();
+    for (const file of renderedFiles) {
+      fileMap.set(file.path, file.contents.toString());
+    }
+    return fileMap;
+  }
+
   async analyze(): Promise<IPlannedChange[]> {
     const changes: IPlannedChange[] = [];
     const project = this.project;
@@ -25,7 +51,8 @@ export class TemplatesFormatter extends BaseFormatter {
     switch (projectType) {
       case 'npm':
       case 'wcc':
-        const accessLevel = project.gitzoneConfig?.data?.npmciOptions?.npmAccessLevel;
+        const accessLevel = (project.gitzoneConfig?.data as any)?.release?.accessLevel
+          || project.gitzoneConfig?.data?.npmciOptions?.npmAccessLevel;
         const ciTemplate = accessLevel === 'public' ? 'ci_default' : 'ci_default_private';
         const ciChanges = await this.analyzeTemplate(ciTemplate, [
           { templatePath: '.gitea/workflows/default_nottags.yaml', destPath: '.gitea/workflows/default_nottags.yaml' },
@@ -62,9 +89,6 @@ export class TemplatesFormatter extends BaseFormatter {
         { templatePath: 'html/index.html', destPath: 'html/index.html' },
       ]);
       changes.push(...websiteChanges);
-    } else if (projectType === 'service') {
-      const serviceChanges = await this.analyzeTemplate('service_update', []);
-      changes.push(...serviceChanges);
     } else if (projectType === 'wcc') {
       const wccChanges = await this.analyzeTemplate('wcc_update', [
         { templatePath: 'html/index.html', destPath: 'html/index.html' },
@@ -83,53 +107,47 @@ export class TemplatesFormatter extends BaseFormatter {
     const changes: IPlannedChange[] = [];
     const templateDir = plugins.path.join(paths.templatesDir, templateName);
 
-    // Check if template exists
     const templateExists = await plugins.smartfs.directory(templateDir).exists();
     if (!templateExists) {
       logVerbose(`Template ${templateName} not found`);
       return changes;
     }
 
+    let renderedFiles: Map<string, string>;
+    try {
+      renderedFiles = await this.renderTemplate(templateName);
+    } catch (error) {
+      logVerbose(`Failed to render template ${templateName}: ${error.message}`);
+      return changes;
+    }
+
     for (const file of files) {
-      const templateFilePath = plugins.path.join(templateDir, file.templatePath);
-      const destFilePath = file.destPath;
+      // Look up by templatePath first, then destPath (frontmatter may rename files)
+      const processedContent = renderedFiles.get(file.templatePath)
+        || renderedFiles.get(file.destPath);
 
-      // Check if template file exists
-      const fileExists = await plugins.smartfs.file(templateFilePath).exists();
-      if (!fileExists) {
-        logVerbose(`Template file ${templateFilePath} not found`);
+      if (!processedContent) {
+        logVerbose(`Template file ${file.templatePath} not found in rendered output`);
         continue;
       }
 
-      try {
-        // Read template content
-        const templateContent = (await plugins.smartfs
-          .file(templateFilePath)
+      const destExists = await plugins.smartfs.file(file.destPath).exists();
+      let currentContent = '';
+      if (destExists) {
+        currentContent = (await plugins.smartfs
+          .file(file.destPath)
           .encoding('utf8')
           .read()) as string;
+      }
 
-        // Check if destination file exists
-        const destExists = await plugins.smartfs.file(destFilePath).exists();
-        let currentContent = '';
-        if (destExists) {
-          currentContent = (await plugins.smartfs
-            .file(destFilePath)
-            .encoding('utf8')
-            .read()) as string;
-        }
-
-        // Only add change if content differs
-        if (templateContent !== currentContent) {
-          changes.push({
-            type: destExists ? 'modify' : 'create',
-            path: destFilePath,
-            module: this.name,
-            description: `Apply template ${templateName}/${file.templatePath}`,
-            content: templateContent,
-          });
-        }
-      } catch (error) {
-        logVerbose(`Failed to read template ${templateFilePath}: ${error.message}`);
+      if (processedContent !== currentContent) {
+        changes.push({
+          type: destExists ? 'modify' : 'create',
+          path: file.destPath,
+          module: this.name,
+          description: `Apply template ${templateName}/${file.templatePath}`,
+          content: processedContent,
+        });
       }
     }
 
@@ -139,12 +157,6 @@ export class TemplatesFormatter extends BaseFormatter {
   async applyChange(change: IPlannedChange): Promise<void> {
     if (!change.content) return;
 
-    // Ensure destination directory exists
-    const destDir = plugins.path.dirname(change.path);
-    if (destDir && destDir !== '.') {
-      await plugins.smartfs.directory(destDir).recursive().create();
-    }
-
     if (change.type === 'create') {
       await this.createFile(change.path, change.content);
     } else {

package/ts/mod_format/formatters/tsconfig.formatter.ts

@@ -30,9 +30,10 @@ export class TsconfigFormatter extends BaseFormatter {
     const tsconfigObject = JSON.parse(currentContent);
     tsconfigObject.compilerOptions = tsconfigObject.compilerOptions || {};
     tsconfigObject.compilerOptions.baseUrl = '.';
-    tsconfigObject.compilerOptions.paths = {};
+    const existingPaths = tsconfigObject.compilerOptions.paths || {};
 
-    // Get module paths from tspublish
+    // Get module paths from tspublish, merging with existing custom paths
+    const tspublishPaths: Record<string, string[]> = {};
     try {
       const tsPublishMod = await import('@git.zone/tspublish');
       const tsPublishInstance = new tsPublishMod.TsPublish();
@@ -40,7 +41,7 @@ export class TsconfigFormatter extends BaseFormatter {
 
       for (const publishModule of Object.keys(publishModules)) {
         const publishConfig = publishModules[publishModule];
-        tsconfigObject.compilerOptions.paths[`${publishConfig.name}`] = [
+        tspublishPaths[`${publishConfig.name}`] = [
           `./${publishModule}/index.js`,
         ];
       }
@@ -48,6 +49,8 @@ export class TsconfigFormatter extends BaseFormatter {
       logVerbose(`Could not get tspublish modules: ${error.message}`);
     }
 
+    tsconfigObject.compilerOptions.paths = { ...existingPaths, ...tspublishPaths };
+
     const newContent = JSON.stringify(tsconfigObject, null, 2);
 
     // Only add change if content differs

package/ts/mod_format/index.ts

@@ -5,9 +5,8 @@ import { FormatPlanner } from './classes.formatplanner.js';
 import { BaseFormatter } from './classes.baseformatter.js';
 import { logger, setVerboseMode } from '../gitzone.logging.js';
 
-// Import wrapper classes for formatters
 import { CleanupFormatter } from './formatters/cleanup.formatter.js';
-import { NpmextraFormatter } from './formatters/npmextra.formatter.js';
+import { SmartconfigFormatter } from './formatters/smartconfig.formatter.js';
 import { LicenseFormatter } from './formatters/license.formatter.js';
 import { PackageJsonFormatter } from './formatters/packagejson.formatter.js';
 import { TemplatesFormatter } from './formatters/templates.formatter.js';
@@ -17,82 +16,66 @@ import { PrettierFormatter } from './formatters/prettier.formatter.js';
 import { ReadmeFormatter } from './formatters/readme.formatter.js';
 import { CopyFormatter } from './formatters/copy.formatter.js';
 
+// Shared formatter class map used by both run() and runFormatter()
+const formatterMap: Record<string, new (ctx: FormatContext, proj: Project) => BaseFormatter> = {
+  cleanup: CleanupFormatter,
+  smartconfig: SmartconfigFormatter,
+  license: LicenseFormatter,
+  packagejson: PackageJsonFormatter,
+  templates: TemplatesFormatter,
+  gitignore: GitignoreFormatter,
+  tsconfig: TsconfigFormatter,
+  prettier: PrettierFormatter,
+  readme: ReadmeFormatter,
+  copy: CopyFormatter,
+};
+
+// Formatters that don't require projectType to be set
+const formattersNotRequiringProjectType = ['smartconfig', 'prettier', 'cleanup', 'packagejson'];
+
 export let run = async (
   options: {
-    write?: boolean;      // Explicitly write changes (default: false, dry-mode)
-    dryRun?: boolean;     // Deprecated, kept for compatibility
+    write?: boolean;
+    dryRun?: boolean; // Deprecated, kept for compatibility
     yes?: boolean;
     planOnly?: boolean;
     savePlan?: string;
     fromPlan?: string;
     detailed?: boolean;
     interactive?: boolean;
-    parallel?: boolean;
     verbose?: boolean;
-    diff?: boolean;       // Show file diffs
+    diff?: boolean;
   } = {},
 ): Promise<any> => {
-  // Set verbose mode if requested
   if (options.verbose) {
     setVerboseMode(true);
   }
 
-  // Determine if we should write changes
-  // Default is dry-mode (no writing) unless --write/-w is specified
   const shouldWrite = options.write ?? (options.dryRun === false);
 
   const project = await Project.fromCwd({ requireProjectType: false });
   const context = new FormatContext();
-  // Cache system removed - no longer needed
   const planner = new FormatPlanner();
 
-  // Get configuration from npmextra
-  const npmextraConfig = new plugins.npmextra.Smartconfig();
-  const formatConfig = npmextraConfig.dataFor<any>('@git.zone/cli.format', {
+  const smartconfigInstance = new plugins.smartconfig.Smartconfig();
+  const formatConfig = smartconfigInstance.dataFor<any>('@git.zone/cli.format', {
     interactive: true,
     showDiffs: false,
     autoApprove: false,
-    planTimeout: 30000,
-    rollback: {
-      enabled: true,
-      autoRollbackOnError: true,
-      backupRetentionDays: 7,
-      maxBackupSize: '100MB',
-      excludePatterns: ['node_modules/**', '.git/**'],
-    },
     modules: {
       skip: [],
       only: [],
-      order: [],
-    },
-    parallel: true,
-    cache: {
-      enabled: true,
-      clean: true, // Clean invalid entries from cache
     },
   });
 
-  // Cache cleaning removed - no longer using cache system
-
-  // Override config with command options
   const interactive = options.interactive ?? formatConfig.interactive;
   const autoApprove = options.yes ?? formatConfig.autoApprove;
-  const parallel = options.parallel ?? formatConfig.parallel;
 
   try {
-    // Initialize formatters
-    const formatters = [
-      new CleanupFormatter(context, project),
-      new NpmextraFormatter(context, project),
-      new LicenseFormatter(context, project),
-      new PackageJsonFormatter(context, project),
-      new TemplatesFormatter(context, project),
-      new GitignoreFormatter(context, project),
-      new TsconfigFormatter(context, project),
-      new PrettierFormatter(context, project),
-      new ReadmeFormatter(context, project),
-      new CopyFormatter(context, project),
-    ];
+    // Initialize formatters in execution order
+    const formatters = Object.entries(formatterMap).map(
+      ([, FormatterClass]) => new FormatterClass(context, project),
+    );
 
     // Filter formatters based on configuration
     const activeFormatters = formatters.filter((formatter) => {
@@ -128,13 +111,13 @@ export let run = async (
       logger.log('info', `Plan saved to ${options.savePlan}`);
     }
 
-    // Exit if plan-only mode
     if (options.planOnly) {
       return;
     }
 
-    // Show diffs if requested (works in both dry-run and write modes)
-    if (options.diff) {
+    // Show diffs if explicitly requested or before interactive write confirmation
+    const showDiffs = options.diff || (shouldWrite && interactive && !autoApprove);
+    if (showDiffs) {
       logger.log('info', 'Showing file diffs:');
       console.log('');
 
@@ -171,22 +154,16 @@ export let run = async (
     }
 
     // Execute phase
-    logger.log(
-      'info',
-      `Executing format operations${parallel ? ' in parallel' : ' sequentially'}...`,
-    );
-    await planner.executePlan(plan, activeFormatters, context, parallel);
+    logger.log('info', 'Executing format operations...');
+    await planner.executePlan(plan, activeFormatters, context);
 
-    // Finish statistics tracking
     context.getFormatStats().finish();
 
-    // Display statistics
-    const showStats = npmextraConfig.dataFor('gitzone.format.showStats', true);
+    const showStats = smartconfigInstance.dataFor('gitzone.format.showStats', true);
     if (showStats) {
       context.getFormatStats().displayStats();
     }
 
-    // Save stats if requested
     if (options.detailed) {
       const statsPath = `.nogit/format-stats-${Date.now()}.json`;
       await context.getFormatStats().saveReport(statsPath);
@@ -195,36 +172,13 @@ export let run = async (
     logger.log('success', 'Format operations completed successfully!');
   } catch (error) {
     logger.log('error', `Format operation failed: ${error.message}`);
-
-    // Rollback system has been removed for stability
-
     throw error;
   }
 };
 
-// Export CLI command handlers
-export const handleRollback = async (operationId?: string): Promise<void> => {
-  logger.log('info', 'Rollback system has been disabled for stability');
-};
-
-export const handleListBackups = async (): Promise<void> => {
-  logger.log('info', 'Backup system has been disabled for stability');
-};
-
-export const handleCleanBackups = async (): Promise<void> => {
-  logger.log(
-    'info',
-    'Backup cleaning has been disabled - backup system removed',
-  );
-};
-
-// Import the ICheckResult type for external use
 import type { ICheckResult } from './interfaces.format.js';
 export type { ICheckResult };
 
-// Formatters that don't require projectType to be set
-const formattersNotRequiringProjectType = ['npmextra', 'prettier', 'cleanup', 'packagejson'];
-
 /**
  * Run a single formatter by name (for use by other modules)
  */
@@ -232,29 +186,14 @@ export const runFormatter = async (
   formatterName: string,
   options: {
     silent?: boolean;
-    checkOnly?: boolean;    // Only check for diffs, don't apply
-    showDiff?: boolean;     // Show the diff output
+    checkOnly?: boolean;
+    showDiff?: boolean;
   } = {}
 ): Promise<ICheckResult | void> => {
-  // Determine if this formatter requires projectType
   const requireProjectType = !formattersNotRequiringProjectType.includes(formatterName);
   const project = await Project.fromCwd({ requireProjectType });
   const context = new FormatContext();
 
-  // Map formatter names to classes
-  const formatterMap: Record<string, new (ctx: FormatContext, proj: Project) => BaseFormatter> = {
-    cleanup: CleanupFormatter,
-    npmextra: NpmextraFormatter,
-    license: LicenseFormatter,
-    packagejson: PackageJsonFormatter,
-    templates: TemplatesFormatter,
-    gitignore: GitignoreFormatter,
-    tsconfig: TsconfigFormatter,
-    prettier: PrettierFormatter,
-    readme: ReadmeFormatter,
-    copy: CopyFormatter,
-  };
-
   const FormatterClass = formatterMap[formatterName];
   if (!FormatterClass) {
     throw new Error(`Unknown formatter: ${formatterName}`);
@@ -262,7 +201,6 @@ export const runFormatter = async (
 
   const formatter = new FormatterClass(context, project);
 
-  // Check-only mode: just check for diffs and optionally display them
   if (options.checkOnly) {
     const result = await formatter.check();
     if (result.hasDiff && options.showDiff) {
@@ -271,7 +209,6 @@ export const runFormatter = async (
     return result;
   }
 
-  // Normal mode: analyze and apply changes
   const changes = await formatter.analyze();
 
   for (const change of changes) {