fix: Fixed plain reporter for init

Author: kevinwang5658

src/commands/init.ts

@@ -1,30 +1,18 @@
 import fs from 'node:fs/promises';
 
 import { BaseCommand } from '../common/base-command.js';
-import { InitializeOrchestrator } from '../orchestrators/initialize.js';
+import { InitializeOrchestrator } from '../orchestrators/init.js';
 import { ShellUtils } from '../utils/shell.js';
 
 export default class Init extends BaseCommand {
   static strict = false;
   static override description =
-`Generate codify configs from already installed packages. Use a list of space separated arguments to specify the resource types to import. Leave blank to import all resource in an existing *.codify.json file.
+`Initialize codify.`
 
-Modes:
-1. No args: if no args are specified and an *.codify.json already exists. Then codify will update the existing file with any new changes to the resources specified in the file/files.
-
-Command: codify import
-
-2. With args: specify specific resources to import using arguments. Wild card matching is supported using '*' and ? (Note: in zsh * expands to the current dir and needs to be escaped using \\* or '*'). A prompt will be shown if more information is required to complete the import.
-
-Example: codify import nvm asdf\\*, codify import \\* (for importing all supported resources)
-
-The results can then be saved:
-  a. To an existing *.codify.json file
-  b. To a new file
-  c. Or only printed to console
-  
-Codify will try to smartly insert new configs by following existing spacing and formatting.
-`
+  static baseFlags= {
+    ...BaseCommand.baseFlags,
+    path: { hidden: true },
+  }
 
   static override examples = [
     '<%= config.bin %> <%= command.id %> homebrew nvm asdf\\*',
@@ -34,39 +22,6 @@ Codify will try to smartly insert new configs by following existing spacing and
   ]
 
   public async run(): Promise<void> {
-    const { raw, flags } = await this.parse(Init)
-
     await InitializeOrchestrator.run(this.reporter);
-
-    // if (flags.path) {
-    //   this.log(`Applying Codify from: ${flags.path}`);
-    // }
-    //
-    // const resolvedPath = path.resolve(flags.path ?? '.');
-    //
-    // const args = raw
-    //   .filter((r) => r.type === 'arg')
-    //   .map((r) => r.input);
-    //
-    // const cleanedArgs = await this.cleanupZshStarExpansion(args);
-    //
-    // await ImportOrchestrator.run({
-    //   typeIds: cleanedArgs,
-    //   path: resolvedPath,
-    //   secureMode: flags.secure,
-    // }, this.reporter)
-    //
-    // process.exit(0)
-  }
-
-  private async cleanupZshStarExpansion(args: string[]): Promise<string[]> {
-    const combinedArgs = args.join(' ');
-    const zshStarExpansion = (await ShellUtils.isZshShell())
-      ? (await fs.readdir(process.cwd())).filter((name) => !name.startsWith('.')).join(' ')
-      : ''
-
-    return combinedArgs
-      .replaceAll(zshStarExpansion, '*')
-      .split(' ')
   }
 }

src/common/base-command.ts

@@ -12,7 +12,7 @@ import { prettyPrintError } from './errors.js';
 export abstract class BaseCommand extends Command {
   static baseFlags = {
     'debug': Flags.boolean({
-      description: 'Add additional debug logs.'
+      description: 'Print additional debug logs.'
     }),
     'output': Flags.option({
       char: 'o',

src/orchestrators/initialize-plugins.ts src/common/initialize-plugins.tssrc/orchestrators/initialize-plugins.ts renamed to src/common/initialize-plugins.ts

@@ -1,11 +1,11 @@
 import { InternalError } from '../common/errors.js';
+import { PluginInitOrchestrator } from '../common/initialize-plugins.js';
 import { Project } from '../entities/project.js';
 import { ResourceConfig } from '../entities/resource-config.js';
 import { ProcessName, SubProcessName, ctx } from '../events/context.js';
 import { DependencyMap, PluginManager } from '../plugins/plugin-manager.js';
 import { Reporter } from '../ui/reporters/reporter.js';
 import { getTypeAndNameFromId } from '../utils/index.js';
-import { PluginInitOrchestrator } from './initialize-plugins.js';
 
 export interface DestroyArgs {
   ids: string[];

src/orchestrators/destroy.ts

@@ -1,5 +1,6 @@
 import path from 'node:path';
 
+import { InitializationResult, PluginInitOrchestrator } from '../common/initialize-plugins.js';
 import { Project } from '../entities/project.js';
 import { ResourceConfig } from '../entities/resource-config.js';
 import { ResourceInfo } from '../entities/resource-info.js';
@@ -12,7 +13,6 @@ import { FileUtils } from '../utils/file.js';
 import { FileModificationCalculator, ModificationType } from '../utils/file-modification-calculator.js';
 import { groupBy, sleep } from '../utils/index.js';
 import { wildCardMatch } from '../utils/wild-card-match.js';
-import { InitializationResult, PluginInitOrchestrator } from './initialize-plugins.js';
 
 export type ImportResult = { result: ResourceConfig[], errors: string[] }
 
@@ -57,11 +57,7 @@ export class ImportOrchestrator {
       throw new Error('At least one resource [type] must be specified. Ex: "codify import homebrew". Or the import command must be run in a directory with a valid codify file')
     }
 
-    if (!typeIds || typeIds.length === 0) {
-      await ImportOrchestrator.runExistingProject(reporter, initializationResult);
-    } else {
-      await ImportOrchestrator.runNewImport(typeIds, reporter, initializationResult)
-    }
+    await (!typeIds || typeIds.length === 0 ? ImportOrchestrator.runExistingProject(reporter, initializationResult) : ImportOrchestrator.runNewImport(typeIds, reporter, initializationResult));
   }
 
   /** Import new resources. Type ids supplied. This will ask for any required parameters */

src/orchestrators/import.ts

@@ -1,12 +1,12 @@
 import chalk from 'chalk';
 import path from 'node:path';
 
+import { PluginInitOrchestrator } from '../common/initialize-plugins.js';
 import { ResourceConfig } from '../entities/resource-config.js';
 import { ProcessName, SubProcessName, ctx } from '../events/context.js';
 import { Reporter } from '../ui/reporters/reporter.js';
 import { FileUtils } from '../utils/file.js';
 import { resolvePathWithVariables, untildify } from '../utils/index.js';
-import { PluginInitOrchestrator } from './initialize-plugins.js';
 
 export const InitializeOrchestrator = {
 

src/orchestrators/initialize.ts src/orchestrators/init.tssrc/orchestrators/initialize.ts renamed to src/orchestrators/init.ts

@@ -1,10 +1,10 @@
+import { PluginInitOrchestrator } from '../common/initialize-plugins.js';
 import { Plan } from '../entities/plan.js';
 import { Project } from '../entities/project.js';
 import { ProcessName, SubProcessName, ctx } from '../events/context.js';
 import { PluginManager } from '../plugins/plugin-manager.js';
 import { Reporter } from '../ui/reporters/reporter.js';
 import { createStartupShellScriptsIfNotExists } from '../utils/file.js';
-import { PluginInitOrchestrator } from './initialize-plugins.js';
 import { ValidateOrchestrator } from './validate.js';
 
 export interface PlanArgs {

src/orchestrators/plan.ts

@@ -1,6 +1,6 @@
 import { SubProcessName, ctx } from '../events/context.js';
 import { Reporter } from '../ui/reporters/reporter.js';
-import { InitializationResult, PluginInitOrchestrator } from './initialize-plugins.js';
+import { InitializationResult, PluginInitOrchestrator } from '../common/initialize-plugins.js';
 
 export interface ValidateArgs {
   existing?: InitializationResult;

src/orchestrators/validate.ts

@@ -25,6 +25,8 @@ export class PlainReporter implements Reporter {
     }
   }
 
+  async hide(): Promise<void> {}
+
   async displayImportWarning(requiresParameters: string[], noParametersRequired: string[]): Promise<void> {
     console.log(chalk.bold('Additional information is required to continue import'))
     console.log('Some of the resources specified in the import support multiple instances. Additional information is required to identify the specific instance to import. If importing multiple instances is desired (for ex: multiple git clones) additional imports can be added in the prompt.')
@@ -92,6 +94,18 @@ export class PlainReporter implements Reporter {
     return result;
   }
 
+  async displayProgress(): Promise<void> {}
+
+  async promptInput(prompt: string, error?: string, validation?: () => Promise<boolean>, autoComplete?: (input: string) => string[]): Promise<string> {
+    return new Promise((resolve) => {
+      this.rl.question(prompt + (error ? chalk.red(`\n${error} `) : ''), (answer) => resolve(answer));
+    });
+  }
+
+  async promptInitResultSelection(availableTypes: string[]): Promise<string[]> {
+    return availableTypes;
+  }
+
   displayImportResult(importResult: ImportResult) {
     console.log();
     console.log(JSON.stringify(importResult.result.map((r) => r.raw), null, 2));
@@ -107,6 +121,14 @@ export class PlainReporter implements Reporter {
     return undefined;
   }
 
+  async displayInitBanner(): Promise<void> {
+    console.log(`Codify is a configuration-as-code tool that helps you setup and manage your system.
+Use this init flow to get started quickly with Codify.
+    `);
+
+    await this.promptConfirmation('Codify will scan your system for any supported programs or settings and automatically generate configs for you.')
+  }
+
   async promptConfirmation(message: string): Promise<boolean> {
     const response = await new Promise((resolve) => {
       this.rl.question(`${message} (only 'yes' is accepted)`, (answer) => resolve(answer));
@@ -125,5 +147,4 @@ export class PlainReporter implements Reporter {
     console.log('🎉 Finished applying 🎉');
     console.log('Open a new terminal or source \'.zshrc\' for the new changes to be reflected')
   }
-
 }

src/ui/reporters/plain-reporter.ts

@@ -3,7 +3,7 @@ import * as fs from 'node:fs';
 import os from 'node:os';
 
 import { MockOs } from '../mocks/system';
-import { PluginInitOrchestrator } from '../../../src/orchestrators/initialize-plugins';
+import { PluginInitOrchestrator } from '../../../src/common/initialize-plugins';
 import path from 'node:path';
 import { MockReporter } from '../mocks/reporter';
 import { MockResource, MockResourceConfig } from '../mocks/resource';