@git.zone/cli 2.3.0 → 2.7.0

package/ts/mod_format/classes.baseformatter.ts

@@ -1,6 +1,6 @@
 import * as plugins from './mod.plugins.js';
 import { FormatContext } from './classes.formatcontext.js';
-import type { IPlannedChange } from './interfaces.format.js';
+import type { IPlannedChange, ICheckResult } from './interfaces.format.js';
 import { Project } from '../classes.project.js';
 
 export abstract class BaseFormatter {
@@ -79,4 +79,94 @@ export abstract class BaseFormatter {
   protected async shouldProcessFile(filepath: string): Promise<boolean> {
     return true;
   }
+
+  /**
+   * Check for diffs without applying changes
+   * Returns information about what would change
+   */
+  async check(): Promise<ICheckResult> {
+    const changes = await this.analyze();
+    const diffs: ICheckResult['diffs'] = [];
+
+    for (const change of changes) {
+      // Skip generic changes that don't have actual content
+      if (change.path === '<various files>') {
+        continue;
+      }
+
+      if (change.type === 'modify' || change.type === 'create') {
+        // Read current content if file exists
+        let currentContent: string | undefined;
+        try {
+          currentContent = await plugins.smartfs.file(change.path).encoding('utf8').read() as string;
+        } catch {
+          // File doesn't exist yet
+          currentContent = undefined;
+        }
+
+        const newContent = change.content;
+
+        // Check if there's an actual diff
+        if (currentContent !== newContent && newContent !== undefined) {
+          diffs.push({
+            path: change.path,
+            type: change.type,
+            before: currentContent,
+            after: newContent,
+          });
+        }
+      } else if (change.type === 'delete') {
+        // Check if file exists before marking for deletion
+        try {
+          const currentContent = await plugins.smartfs.file(change.path).encoding('utf8').read() as string;
+          diffs.push({
+            path: change.path,
+            type: 'delete',
+            before: currentContent,
+            after: undefined,
+          });
+        } catch {
+          // File doesn't exist, nothing to delete
+        }
+      }
+    }
+
+    return {
+      hasDiff: diffs.length > 0,
+      diffs,
+    };
+  }
+
+  /**
+   * Display a single diff using smartdiff
+   */
+  displayDiff(diff: ICheckResult['diffs'][0]): void {
+    console.log(`\n--- ${diff.path}`);
+    if (diff.before && diff.after) {
+      console.log(plugins.smartdiff.formatLineDiffForConsole(diff.before, diff.after));
+    } else if (diff.after && !diff.before) {
+      console.log('  (new file)');
+      // Show first few lines of new content
+      const lines = diff.after.split('\n').slice(0, 10);
+      lines.forEach(line => console.log(`  + ${line}`));
+      if (diff.after.split('\n').length > 10) {
+        console.log('  ... (truncated)');
+      }
+    } else if (diff.before && !diff.after) {
+      console.log('  (file will be deleted)');
+    }
+  }
+
+  /**
+   * Display all diffs from a check result
+   */
+  displayAllDiffs(result: ICheckResult): void {
+    if (!result.hasDiff) {
+      console.log('  No changes detected');
+      return;
+    }
+    for (const diff of result.diffs) {
+      this.displayDiff(diff);
+    }
+  }
 }

package/ts/mod_format/index.ts

@@ -2,6 +2,7 @@ import * as plugins from './mod.plugins.js';
 import { Project } from '../classes.project.js';
 import { FormatContext } from './classes.formatcontext.js';
 import { FormatPlanner } from './classes.formatplanner.js';
+import { BaseFormatter } from './classes.baseformatter.js';
 import { logger, setVerboseMode } from '../gitzone.logging.js';
 
 // Import wrapper classes for formatters
@@ -18,7 +19,8 @@ import { CopyFormatter } from './formatters/copy.formatter.js';
 
 export let run = async (
   options: {
-    dryRun?: boolean;
+    write?: boolean;      // Explicitly write changes (default: false, dry-mode)
+    dryRun?: boolean;     // Deprecated, kept for compatibility
     yes?: boolean;
     planOnly?: boolean;
     savePlan?: string;
@@ -34,7 +36,11 @@ export let run = async (
     setVerboseMode(true);
   }
 
-  const project = await Project.fromCwd();
+  // 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();
@@ -126,9 +132,9 @@ export let run = async (
       return;
     }
 
-    // Dry-run mode
-    if (options.dryRun) {
-      logger.log('info', 'Dry-run mode - no changes will be made');
+    // Dry-run mode (default behavior)
+    if (!shouldWrite) {
+      logger.log('info', 'Dry-run mode - use --write (-w) to apply changes');
       return;
     }
 
@@ -195,3 +201,68 @@ export const handleCleanBackups = async (): Promise<void> => {
     '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)
+ */
+export const runFormatter = async (
+  formatterName: string,
+  options: {
+    silent?: boolean;
+    checkOnly?: boolean;    // Only check for diffs, don't apply
+    showDiff?: boolean;     // Show the diff output
+  } = {}
+): 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}`);
+  }
+
+  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) {
+      formatter.displayAllDiffs(result);
+    }
+    return result;
+  }
+
+  // Normal mode: analyze and apply changes
+  const changes = await formatter.analyze();
+
+  for (const change of changes) {
+    await formatter.applyChange(change);
+  }
+
+  if (!options.silent) {
+    logger.log('success', `Formatter '${formatterName}' completed`);
+  }
+};

package/ts/mod_format/interfaces.format.ts

@@ -39,7 +39,18 @@ export type IPlannedChange = {
   path: string;
   module: string;
   description: string;
-  content?: string; // For create/modify operations
+  content?: string; // New content for create/modify operations
+  originalContent?: string; // Original content for comparison
   diff?: string;
   size?: number;
 };
+
+export interface ICheckResult {
+  hasDiff: boolean;
+  diffs: Array<{
+    path: string;
+    type: 'create' | 'modify' | 'delete';
+    before?: string;
+    after?: string;
+  }>;
+}

package/ts/mod_standard/index.ts

@@ -7,38 +7,85 @@ import * as paths from '../paths.js';
 import { logger } from '../gitzone.logging.js';
 
 export let run = async () => {
-  const done = plugins.smartpromise.defer();
-  logger.log('warn', 'no action specified');
+  console.log('');
+  console.log('╭─────────────────────────────────────────────────────────────╮');
+  console.log('│  gitzone - Development Workflow CLI                         │');
+  console.log('╰─────────────────────────────────────────────────────────────╯');
+  console.log('');
 
-  const dirEntries = await plugins.smartfs.directory(paths.templatesDir).list();
-  const templates: string[] = [];
-  for (const entry of dirEntries) {
-    try {
-      const stats = await plugins.smartfs
-        .file(plugins.path.join(paths.templatesDir, entry.path))
-        .stat();
-      if (stats.isDirectory) {
-        templates.push(entry.name);
-      }
-    } catch {
-      // Skip entries that can't be accessed
-    }
-  }
+  const interactInstance = new plugins.smartinteract.SmartInteract();
+  const response = await interactInstance.askQuestion({
+    type: 'list',
+    name: 'action',
+    message: 'What would you like to do?',
+    default: 'commit',
+    choices: [
+      { name: 'Commit changes (semantic versioning)', value: 'commit' },
+      { name: 'Format project files', value: 'format' },
+      { name: 'Configure release settings', value: 'config' },
+      { name: 'Create from template', value: 'template' },
+      { name: 'Manage dev services (MongoDB, S3)', value: 'services' },
+      { name: 'Open project assets', value: 'open' },
+      { name: 'Show help', value: 'help' },
+    ],
+  });
 
-  let projects = `\n`;
-  for (const template of templates) {
-    projects += `       - ${template}\n`;
-  }
+  const action = (response as any).value;
 
-  logger.log(
-    'info',
-    `
-    You can do one of the following things:
-    * create a new project with 'gitzone template [template]'
-      the following templates exist: ${projects}
-    * format a project with 'gitzone format'
-  `,
-  );
-  done.resolve();
-  return done.promise;
+  switch (action) {
+    case 'commit': {
+      const modCommit = await import('../mod_commit/index.js');
+      await modCommit.run({ _: ['commit'] });
+      break;
+    }
+    case 'format': {
+      const modFormat = await import('../mod_format/index.js');
+      await modFormat.run({ interactive: true });
+      break;
+    }
+    case 'config': {
+      const modConfig = await import('../mod_config/index.js');
+      await modConfig.run({ _: ['config'] });
+      break;
+    }
+    case 'template': {
+      const modTemplate = await import('../mod_template/index.js');
+      await modTemplate.run({ _: ['template'] });
+      break;
+    }
+    case 'services': {
+      const modServices = await import('../mod_services/index.js');
+      await modServices.run({ _: ['services'] });
+      break;
+    }
+    case 'open': {
+      const modOpen = await import('../mod_open/index.js');
+      await modOpen.run({ _: ['open'] });
+      break;
+    }
+    case 'help':
+      showHelp();
+      break;
+  }
 };
+
+function showHelp(): void {
+  console.log('');
+  console.log('Usage: gitzone <command> [options]');
+  console.log('');
+  console.log('Commands:');
+  console.log('  commit      Create a semantic commit with versioning');
+  console.log('  format      Format and standardize project files');
+  console.log('  config      Manage release registry configuration');
+  console.log('  template    Create a new project from template');
+  console.log('  services    Manage dev services (MongoDB, S3/MinIO)');
+  console.log('  open        Open project assets (GitLab, npm, etc.)');
+  console.log('  docker      Docker-related operations');
+  console.log('  deprecate   Deprecate a package on npm');
+  console.log('  meta        Run meta commands');
+  console.log('  start       Start working on a project');
+  console.log('  helpers     Run helper utilities');
+  console.log('');
+  console.log('Run gitzone <command> --help for more information on a command.');
+  console.log('');
+}