Finished up Codify parser and resolver changes

Author: kevinwang5658

src/codify-files/parser/index.ts

@@ -10,20 +10,9 @@ import { JsonParser } from './json/json-parser.js';
 import { Json5Parser } from './json5/json-parser.js';
 import { JsoncParser } from './jsonc/json-parser.js';
 import { RemoteParser } from './remote/remote-parser.js';
-import { ResolverType } from './resolvers.js';
 import { SourceMapCache } from './source-maps.js';
 import { YamlParser } from './yaml/yaml-parser.js';
 
-
-export interface ParserArgs {
-  allowEmptyProject?: boolean;
-  allowTemplates?: boolean;
-  path?: string;
-  transformProject?: (project: Project) => Project | Promise<Project>;
-  rawConfigs?: Config[]; // Raw configs are provided directly
-  resolverType?: ResolverType;
-}
-
 interface ParseResult {
   configs: ParsedConfig[];
   file: InMemoryFile;
@@ -53,10 +42,10 @@ class Parser {
    * Error out and tell the user that the following file could not be found
    *
    *
-   * @param location
+   * @param file
    * @param args
    */
-  async parse(file: InMemoryFile, args?: ParserArgs): Promise<Project> {
+  async parse(file: InMemoryFile): Promise<Project> {
     const sourceMaps = new SourceMapCache()
 
     const { configs } = await Promise.resolve(this.parseContents(file, sourceMaps))
@@ -65,15 +54,15 @@ class Parser {
     return Project.create(configs, file.path, sourceMaps);
   }
 
-  async parseJson(configs: Config[]): Promise<Project> {
+  async parseJson(configs: Config[], path?: string): Promise<Project> {
     const sourceMaps = new SourceMapCache()
 
-    const configBlocks = this.createConfigBlocks(configs
-        .map((c) => ({ contents: c, sourceMapKey: '' })),
-      sourceMaps
-    )
+    const configBlocks = this.createConfigBlocks({
+      configs: configs.map((c) => ({ contents: c, sourceMapKey: '' })),
+      file: { contents: JSON.stringify(configs), path: path ?? '', fileType: FileType.JSON },
+    }, sourceMaps)
 
-    return Project.create(configBlocks.configs, undefined, sourceMaps);
+    return Project.create(configBlocks.configs, path, sourceMaps);
   }
 
   private parseContents(file: InMemoryFile, sourceMaps: SourceMapCache): ParseResult {

src/codify-files/parser/resolvers.ts

@@ -17,11 +17,7 @@ interface ResolverArgs {
   path?: string;
   allowTemplates?: boolean;
   reporter?: Reporter;
-
-  /**
-   * Narrow down the result to a single file
-   */
-  narrow?: boolean;
+  allowEmpty?: boolean;
 }
 
 /**
@@ -43,9 +39,9 @@ export class CodifyResolver {
    * @param location
    * @param args
    */
-  static async resolveFile(location: string, args?: ResolverArgs): Promise<InMemoryFile | InMemoryFile[]> {
-    return CodifyResolver.run(location, args)
-      .then((result) => (args?.narrow) ? this.narrow(result) : result.files);
+  static async resolveFile(location: string, args?: ResolverArgs): Promise<InMemoryFile | null> {
+    const resolvedFiles = await CodifyResolver.run(location, args)
+    return this.narrow(resolvedFiles, args);
   }
 
   private static async run(location: string, args?: ResolverArgs): Promise<ResolverResult> {
@@ -56,7 +52,7 @@ export class CodifyResolver {
     if (args?.path) {
       return CodifyResolverRunner.resolveLocal(args?.path)
     }
-    
+
     const isLoggedIn = LoginHelper.get()?.isLoggedIn;
 
     return CodifyResolverRunner.run(location, [
@@ -68,9 +64,13 @@ export class CodifyResolver {
     ]);
   }
 
-  private static async narrow(result: ResolverResult, args?: ResolverArgs): Promise<InMemoryFile> {
+  private static async narrow(result: ResolverResult, args?: ResolverArgs): Promise<InMemoryFile | null> {
     if (result.files.length === 0) {
-      throw new NoCodifyFileError(result);
+      if (!args?.allowEmpty) {
+        throw new NoCodifyFileError(result);
+      }
+
+      return null;
     }
 
     if (result.files.length > 1) {
@@ -89,5 +89,4 @@ export class CodifyResolver {
 
     return result.files[0];
   }
-
-}
+}

src/codify-files/resolver/index.ts

@@ -4,6 +4,8 @@ import { CodifyParser } from '../codify-files/parser/index.js';
 import { BaseCommand } from '../common/base-command.js';
 import { ValidateOrchestrator } from '../orchestrators/validate.js';
 import Apply from './apply.js';
+import { CodifyResolver } from '../codify-files/resolver/index.js';
+import { NoCodifyFileError } from '../codify-files/resolver/errors.js';
 
 export default class Validate extends BaseCommand {
   static description =
@@ -39,7 +41,10 @@ For more information, visit: https://docs.codifycli.com/commands/validate
       path: flags.path ?? args.pathArgs,
     }, this.reporter)
 
-    await CodifyParser.parse(flags.path ?? args.pathArgs ?? '.');
+    const codifyFile = await CodifyResolver.resolveFile(flags.path ?? args.pathArgs ?? '.', {
+      allowEmpty: false,
+    });
+    await CodifyParser.parse(codifyFile!);
 
     process.exit(0);
   }

src/commands/validate.ts

@@ -66,6 +66,7 @@ export class PluginInitOrchestrator {
 
     const codifyFile = await CodifyResolver.resolveFile(args.path ?? process.cwd(), {
       allowTemplates: args.allowTemplates,
+      allowEmpty: args.allowEmptyProject,
       reporter,
     });
 
@@ -84,68 +85,4 @@ export class PluginInitOrchestrator {
 
     return project;
   }
-
-  /** Resolve the root codify file to run.
-   * Order:
-   * 1. If path is specified, return that.
-   * 2. If path is a dir with only one *codify.json|*codify.jsonc|*codify.json5|*codify.yaml, return that.
-   * 3. If path is a UUID, return file from Codify remote.
-   * 4. If multiple exists in the path (dir), then prompt the user to select one.
-   * 5. If no path is provided, run steps 2 - 4 for the current dir.
-   * 6. If none exists, return default file from codify remote.
-   * 7. If user is not logged in, return an error.
-   *
-   * Order:
-   * 1. If the name ends in .json|.jsonc|.json5|.yaml then search the local folder
-   * 2. If it is a path (relative or absolute) then search for that directory or file
-   * 3. If the path is a uuid (try to match it with a UUID) on the user's account (if they are logged in)
-   * 4. Attempt to search for the name on the user's account (if they are logged in)
-   * 5. Attempt to resolve to a public template (if allowTemplate is enabled)
-   * Error out and tell the user that the following file could not be found
-   *
-   * @param args
-   * @private
-   */
-  private static async resolveCodify(args: InitializeArgs, reporter: Reporter): Promise<string | undefined> {
-    const inputPath = args.path ?? process.cwd();
-
-    // Cloud files will be fetched and processed later in the parser.
-    const isCloud = validate(inputPath);
-    if (isCloud) {
-      return inputPath;
-    }
-
-    // Direct files can have its path returned.
-    const isPathDir = await FileUtils.isDir(inputPath);
-    if (!isPathDir) {
-      return inputPath;
-    }
-
-    const filesInDir = await fs.readdir(inputPath);
-    const codifyFiles = filesInDir.filter((f) => config.fileRegex.test(f))
-
-    if (codifyFiles.length === 1) {
-      return codifyFiles[0];
-    }
-
-    if (codifyFiles.length > 0) {
-      const answer = await reporter.promptOptions(
-        'Multiple codify files found in dir. Please select one:',
-        codifyFiles,
-      );
-
-      return path.join(inputPath, codifyFiles[answer]);
-    }
-
-    if (LoginHelper.get()?.isLoggedIn) {
-      return (await DashboardApiClient.getDefaultDocumentId()) ?? undefined;
-    }
-
-    if (args.allowEmptyProject) {
-      return undefined;
-    }
-
-    throw new Error('No codify files found.');
-  }
-
 }