@git.zone/cli 2.13.13 → 2.14.0

package/ts/mod_format/classes.formatcontext.ts

@@ -1,14 +1,31 @@
-import * as plugins from './mod.plugins.js';
-import { FormatStats } from './classes.formatstats.js';
+import * as plugins from "./mod.plugins.js";
+import { FormatStats } from "./classes.formatstats.js";
+
+interface IFormatContextOptions {
+  interactive?: boolean;
+  jsonOutput?: boolean;
+}
 
 export class FormatContext {
   private formatStats: FormatStats;
+  private interactive: boolean;
+  private jsonOutput: boolean;
 
-  constructor() {
+  constructor(options: IFormatContextOptions = {}) {
     this.formatStats = new FormatStats();
+    this.interactive = options.interactive ?? true;
+    this.jsonOutput = options.jsonOutput ?? false;
   }
 
   getFormatStats(): FormatStats {
     return this.formatStats;
   }
+
+  isInteractive(): boolean {
+    return this.interactive;
+  }
+
+  isJsonOutput(): boolean {
+    return this.jsonOutput;
+  }
 }

package/ts/mod_format/formatters/packagejson.formatter.ts

@@ -4,77 +4,6 @@ import * as plugins from '../mod.plugins.js';
 import * as paths from '../../paths.js';
 import { logger, logVerbose } from '../../gitzone.logging.js';
 
-/**
- * Ensures a certain dependency exists or is excluded
- */
-const ensureDependency = async (
-  packageJsonObject: any,
-  position: 'dep' | 'devDep' | 'everywhere',
-  constraint: 'exclude' | 'include' | 'latest',
-  dependencyArg: string,
-): Promise<void> => {
-  // Parse package name and version, handling scoped packages like @scope/name@version
-  const isScoped = dependencyArg.startsWith('@');
-  const lastAtIndex = dependencyArg.lastIndexOf('@');
-
-  // For scoped packages, the version @ must come after the /
-  // For unscoped packages, any @ indicates a version
-  const hasVersion = isScoped
-    ? lastAtIndex > dependencyArg.indexOf('/')
-    : lastAtIndex >= 0;
-
-  const packageName = hasVersion ? dependencyArg.slice(0, lastAtIndex) : dependencyArg;
-  const version = hasVersion ? dependencyArg.slice(lastAtIndex + 1) : 'latest';
-
-  const targetSections: string[] = [];
-
-  switch (position) {
-    case 'dep':
-      targetSections.push('dependencies');
-      break;
-    case 'devDep':
-      targetSections.push('devDependencies');
-      break;
-    case 'everywhere':
-      targetSections.push('dependencies', 'devDependencies');
-      break;
-  }
-
-  for (const section of targetSections) {
-    if (!packageJsonObject[section]) {
-      packageJsonObject[section] = {};
-    }
-
-    switch (constraint) {
-      case 'exclude':
-        delete packageJsonObject[section][packageName];
-        break;
-      case 'include':
-        if (!packageJsonObject[section][packageName]) {
-          packageJsonObject[section][packageName] =
-            version === 'latest' ? '^1.0.0' : version;
-        }
-        break;
-      case 'latest':
-        try {
-          const registry = new plugins.smartnpm.NpmRegistry();
-          const packageInfo = await registry.getPackageInfo(packageName);
-          const latestVersion = packageInfo['dist-tags'].latest;
-          packageJsonObject[section][packageName] = `^${latestVersion}`;
-        } catch (error) {
-          logVerbose(
-            `Could not fetch latest version for ${packageName}, using existing or default`,
-          );
-          if (!packageJsonObject[section][packageName]) {
-            packageJsonObject[section][packageName] =
-              version === 'latest' ? '^1.0.0' : version;
-          }
-        }
-        break;
-    }
-  }
-};
-
 export class PackageJsonFormatter extends BaseFormatter {
   get name(): string {
     return 'packagejson';
@@ -141,11 +70,6 @@ export class PackageJsonFormatter extends BaseFormatter {
       packageJson.scripts.build = `echo "Not needed for now"`;
     }
 
-    // Ensure buildDocs script exists
-    if (!packageJson.scripts.buildDocs) {
-      packageJson.scripts.buildDocs = `tsdoc`;
-    }
-
     // Set files array
     packageJson.files = [
       'ts/**/*',
@@ -160,21 +84,6 @@ export class PackageJsonFormatter extends BaseFormatter {
       'readme.md',
     ];
 
-    // Handle dependencies
-    await ensureDependency(
-      packageJson,
-      'devDep',
-      'exclude',
-      '@push.rocks/tapbundle',
-    );
-    await ensureDependency(packageJson, 'devDep', 'latest', '@git.zone/tstest');
-    await ensureDependency(
-      packageJson,
-      'devDep',
-      'latest',
-      '@git.zone/tsbuild',
-    );
-
     // Set pnpm overrides from assets
     try {
       const overridesContent = (await plugins.smartfs

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

@@ -1,7 +1,7 @@
-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';
+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
@@ -9,11 +9,11 @@ import { logger, logVerbose } from '../../gitzone.logging.js';
 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' },
+    { 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]) {
@@ -36,109 +36,78 @@ const migrateNamespaceKeys = (smartconfigJson: any): boolean => {
  * Migrates npmAccessLevel from @ship.zone/szci to @git.zone/cli.release.accessLevel
  */
 const migrateAccessLevel = (smartconfigJson: any): boolean => {
-  const szciConfig = smartconfigJson['@ship.zone/szci'];
+  const szciConfig = smartconfigJson["@ship.zone/szci"];
 
   if (!szciConfig?.npmAccessLevel) {
     return false;
   }
 
-  const gitzoneConfig = smartconfigJson['@git.zone/cli'] || {};
+  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"]) {
+    smartconfigJson["@git.zone/cli"] = {};
   }
-  if (!smartconfigJson['@git.zone/cli'].release) {
-    smartconfigJson['@git.zone/cli'].release = {};
+  if (!smartconfigJson["@git.zone/cli"].release) {
+    smartconfigJson["@git.zone/cli"].release = {};
   }
 
-  smartconfigJson['@git.zone/cli'].release.accessLevel = szciConfig.npmAccessLevel;
+  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';
+const 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;
+    return "smartconfig";
   }
 
   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');
+    // File rename (npmextra.json/smartconfig.json → .smartconfig.json)
+    // is handled by the orchestrator before analysis.
+    // This formatter only operates on .smartconfig.json.
+    const exists = await plugins.smartfs.file(CONFIG_FILE).exists();
+    if (!exists) {
+      logVerbose(".smartconfig.json does not exist, skipping");
       return changes;
     }
 
-    // Read current content
     const currentContent = (await plugins.smartfs
-      .file(configFile.path)
-      .encoding('utf8')
+      .file(CONFIG_FILE)
+      .encoding("utf8")
       .read()) as string;
 
-    // Parse and apply migrations
     const smartconfigJson = JSON.parse(currentContent);
+
+    // Apply key migrations
     migrateNamespaceKeys(smartconfigJson);
     migrateAccessLevel(smartconfigJson);
 
     // Ensure namespaces exist
-    if (!smartconfigJson['@git.zone/cli']) {
-      smartconfigJson['@git.zone/cli'] = {};
+    if (!smartconfigJson["@git.zone/cli"]) {
+      smartconfigJson["@git.zone/cli"] = {};
     }
-    if (!smartconfigJson['@ship.zone/szci']) {
-      smartconfigJson['@ship.zone/szci'] = {};
+    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) {
+    if (newContent !== currentContent) {
       changes.push({
-        type: 'create',
-        path: TARGET_CONFIG_FILE,
+        type: "modify",
+        path: 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',
+        description: "Migrate and format .smartconfig.json",
         content: newContent,
       });
     }
@@ -147,32 +116,41 @@ export class SmartconfigFormatter extends BaseFormatter {
   }
 
   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;
+    if (change.type !== "modify" || !change.content) return;
 
-    // Parse the content to check for missing required fields
     const smartconfigJson = JSON.parse(change.content);
 
+    // Check for missing required module information
     const expectedRepoInformation: string[] = [
-      'projectType',
-      'module.githost',
-      'module.gitscope',
-      'module.gitrepo',
-      'module.description',
-      'module.npmPackagename',
-      'module.license',
+      "projectType",
+      "module.githost",
+      "module.gitscope",
+      "module.gitrepo",
+      "module.description",
+      "module.npmPackagename",
+      "module.license",
     ];
 
     const interactInstance = new plugins.smartinteract.SmartInteract();
+    const missingRepoInformation = expectedRepoInformation.filter(
+      (expectedRepoInformationItem) => {
+        return !plugins.smartobject.smartGet(
+          smartconfigJson["@git.zone/cli"],
+          expectedRepoInformationItem,
+        );
+      },
+    );
+
+    if (missingRepoInformation.length > 0 && !this.context.isInteractive()) {
+      throw new Error(
+        `Missing required .smartconfig.json fields: ${missingRepoInformation.join(", ")}`,
+      );
+    }
+
     for (const expectedRepoInformationItem of expectedRepoInformation) {
       if (
         !plugins.smartobject.smartGet(
-          smartconfigJson['@git.zone/cli'],
+          smartconfigJson["@git.zone/cli"],
           expectedRepoInformationItem,
         )
       ) {
@@ -180,8 +158,8 @@ export class SmartconfigFormatter extends BaseFormatter {
           {
             message: `What is the value of ${expectedRepoInformationItem}`,
             name: expectedRepoInformationItem,
-            type: 'input',
-            default: 'undefined variable',
+            type: "input",
+            default: "undefined variable",
           },
         ]);
       }
@@ -194,7 +172,7 @@ export class SmartconfigFormatter extends BaseFormatter {
       );
       if (cliProvidedValue) {
         plugins.smartobject.smartAdd(
-          smartconfigJson['@git.zone/cli'],
+          smartconfigJson["@git.zone/cli"],
           expectedRepoInformationItem,
           cliProvidedValue,
         );
@@ -202,12 +180,7 @@ export class SmartconfigFormatter extends BaseFormatter {
     }
 
     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}`);
+    await this.modifyFile(change.path, finalContent);
+    logger.log("info", "Updated .smartconfig.json");
   }
 }