Modified file reader to only read codify.json files for now (this removes multi-file support for now)

Author: kevinwang5658

README.md

@@ -48,14 +48,15 @@ describe the command here
 
 ```
 USAGE
-  $ codify apply [FILE] [-f] [-n <value>]
+  $ codify apply [FILE] [-f] [-n <value>] [-p <value>]
 
 ARGUMENTS
   FILE  file to read
 
 FLAGS
   -f, --force
   -n, --name=<value>  name to print
+  -p, --path=<value>  path to project
 
 DESCRIPTION
   describe the command here
@@ -64,7 +65,8 @@ EXAMPLES
   $ codify apply
 ```
 
-_See code: [src/commands/apply.ts](https://github.com/kevinwang5658/codify/blob/v0.0.0/src/commands/apply.ts)_
+_See
+code: [src/commands/apply/index.ts](https://github.com/kevinwang5658/codify/blob/v0.0.0/src/commands/apply/index.ts)_
 
 ## `codify hello PERSON`
 
@@ -114,10 +116,10 @@ Display help for codify.
 
 ```
 USAGE
-  $ codify help [COMMANDS] [-n]
+  $ codify help [COMMANDS...] [-n]
 
 ARGUMENTS
-  COMMANDS  Command to show help for.
+  COMMANDS...  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -182,10 +184,10 @@ Installs a plugin into the CLI.
 
 ```
 USAGE
-  $ codify plugins:install PLUGIN...
+  $ codify plugins add plugins:install PLUGIN...
 
 ARGUMENTS
-  PLUGIN  Plugin to install.
+  PLUGIN...  Plugin to install.
 
 FLAGS
   -f, --force    Run yarn install with force flag.
@@ -220,10 +222,10 @@ Displays installation properties of a plugin.
 
 ```
 USAGE
-  $ codify plugins:inspect PLUGIN...
+  $ codify plugins inspect PLUGIN...
 
 ARGUMENTS
-  PLUGIN  [default: .] Plugin to inspect.
+  PLUGIN...  [default: .] Plugin to inspect.
 
 FLAGS
   -h, --help     Show CLI help.
@@ -247,10 +249,10 @@ Installs a plugin into the CLI.
 
 ```
 USAGE
-  $ codify plugins:install PLUGIN...
+  $ codify plugins install PLUGIN...
 
 ARGUMENTS
-  PLUGIN  Plugin to install.
+  PLUGIN...  Plugin to install.
 
 FLAGS
   -f, --force    Run yarn install with force flag.
@@ -287,15 +289,15 @@ Links a plugin into the CLI for development.
 
 ```
 USAGE
-  $ codify plugins:link PLUGIN
+  $ codify plugins link PLUGIN
 
 ARGUMENTS
   PATH  [default: .] path to plugin
 
 FLAGS
-  -h, --help      Show CLI help.
+  -h, --help          Show CLI help.
   -v, --verbose
-  --[no-]install  Install dependencies after linking the plugin.
+      --[no-]install  Install dependencies after linking the plugin.
 
 DESCRIPTION
   Links a plugin into the CLI for development.
@@ -317,7 +319,7 @@ Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ codify plugins:uninstall PLUGIN...
+  $ codify plugins remove plugins:uninstall PLUGIN...
 
 ARGUMENTS
   PLUGIN  plugin to uninstall
@@ -340,7 +342,7 @@ Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ codify plugins:uninstall PLUGIN...
+  $ codify plugins uninstall PLUGIN...
 
 ARGUMENTS
   PLUGIN  plugin to uninstall
@@ -366,7 +368,7 @@ Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ codify plugins:uninstall PLUGIN...
+  $ codify plugins unlink plugins:uninstall PLUGIN...
 
 ARGUMENTS
   PLUGIN  plugin to uninstall

src/orchestrators/plan.ts

@@ -11,8 +11,8 @@ interface PlanOchestratorResponse {
 }
 
 export const PlanOrchestrator = {
-  async run(rootDirectory: string, destroyPlugins = true): Promise<PlanOchestratorResponse> {
-    const project = await Parser.parseProject(rootDirectory);
+  async run(path: string, destroyPlugins = true): Promise<PlanOchestratorResponse> {
+    const project = await Parser.parseProject(path);
 
     const pluginCollection = new PluginCollection();
     const dependencyMap = await pluginCollection.initialize(project);

src/parser/index.ts

@@ -1,33 +1,29 @@
+import { ConfigBlock } from '../entities/index.js';
 import { Project } from '../entities/project.js';
 import { ProjectConfig } from '../entities/project-config.js';
 import { ResourceConfig } from '../entities/resource-config.js';
 import { InternalError } from '../utils/errors.js';
 import { ConfigClass } from './language-definition.js';
 import { FileParser } from './parser/index.js';
 import { JsonFileParser } from './parser/json/file-parser.js';
-import { ProjectReader } from './reader/index.js';
-import { ConfigBlock } from '../entities/index.js';
+import { FileReader } from './reader/index.js';
 
 export class Parser {
 
   static readonly supportedParsers: Record<string, FileParser> = {
     'json': new JsonFileParser(),
   }
 
-  static async parseProject(directory: string): Promise<Project> {
-    const configReader = new ProjectReader();
-    const loadedProject = await configReader.readProject(directory);
+  static async parseProject(path: string): Promise<Project> {
+    const fileReader = new FileReader();
+    const configFile = await fileReader.readConfigOrThrow(path);
 
-    const configBlocksResult = await Promise.all(loadedProject.files.map((file) => {
-      const parser = Parser.supportedParsers[file.fileType];
-      if (!parser) {
-        throw new InternalError(`Unsupported file format loaded into parser: ${file.fileName}`);
-      }
-
-      return parser.parse(file);
-    }));
+    const parser = Parser.supportedParsers[configFile.fileType];
+    if (!parser) {
+      throw new InternalError(`Unsupported file format loaded into parser: ${configFile.fileName}`);
+    }
 
-    const configBlocks = configBlocksResult.flat(1);
+    const configBlocks = await parser.parse(configFile);
     const projectConfig = Parser.findProjectConfig(configBlocks);
 
     return new Project(

src/parser/reader/index.test.ts

@@ -1,43 +1,67 @@
 import mock from 'mock-fs';
-import { beforeEach, describe, it } from 'vitest';
-import { deepEqual, equal } from 'node:assert';
+import { beforeEach, describe, expect, it } from 'vitest';
 
-import { File } from './entities/file.js';
-import { ProjectReader } from './index.js';
+import { FileReader } from './index.js';
 
 describe('Config loader tests', () => {
-  let parser: ProjectReader;
+  let fileReader: FileReader;
 
   beforeEach(() => {
-    parser = new ProjectReader();
+    fileReader = new FileReader();
   })
 
-  it('it loads config files correctly', async () => {
+  it('it loads codify.json files', async () => {
     const dir = 'path/to/fake/dir';
     mock({
       [dir]: {
-        'homebrew.json': '[]',
-        'nvm.json': '[]',
-        'providers.json': '[]'
+        'codify.json': '[]',
       }
     });
 
-    const project = await parser.readProject(dir);
-
-    equal(project.files.length, 3);
-    equal(project.rootDirectory, dir);
-    deepEqual(project.files[0], new File({
-      contents: '[]',
-      fileName: 'homebrew.json',
-      fileType: 'json'
-    }));
-    deepEqual(project.files[1], new File({ contents: '[]', fileName: 'nvm.json', fileType: 'json' }));
-    deepEqual(project.files[2], new File({
-      contents: '[]',
-      fileName: 'providers.json',
-      fileType: 'json'
-    }));
+    const file = await fileReader.readConfigOrThrow(dir + '/codify.json');
+    expect(file.fileName).eq('codify.json');
+    expect(file.fileType).eq('json');
+    expect(file.contents).eq('[]');
+    mock.restore();
+  })
+
+  it('it doesn\'t load other .json files', async () => {
+    const dir = 'path/to/fake/dir';
+    mock({
+      [dir]: {
+        'other.json': '[]',
+      }
+    });
+
+    expect(async () => await fileReader.readConfigOrThrow(dir + 'other.json')).to.throw;
+    mock.restore();
+  })
+
+  it('it loads directories with codify.json', async () => {
+    const dir = 'path/to/fake/dir';
+    mock({
+      [dir]: {
+        'codify.json': '[]',
+      }
+    });
+
+    const file = await fileReader.readConfigOrThrow(dir + '/codify.json');
+
+    expect(file.fileName).eq('codify.json');
+    expect(file.fileType).eq('json');
+    expect(file.contents).eq('[]');
+    mock.restore();
+  })
+
+  it('it doesn\'t load directories without codify.json', async () => {
+    const dir = 'path/to/fake/dir';
+    mock({
+      [dir]: {
+        'other.json': '[]',
+      }
+    });
 
+    expect(async () => await fileReader.readConfigOrThrow(dir)).to.throw;
     mock.restore();
   })
 })

src/parser/reader/index.ts

@@ -1,53 +1,48 @@
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
-
-import { Parser } from '../index.js';
 import { File } from './entities/file.js';
-import { LoadedProject } from './entities/project.js';
+
+const CODIFY_FILE_NAME = 'codify.json';
+const NO_CONFIG_FOUND_ERROR_MESSAGE = 'No configuration found. Codify configuration files must be named codify.json'
 
 /**
  * This class loads relevant files in the project directory into memory so that they can be compiled
  * TODO: Rename this to reader. A loader has a different meaning for compilers
  */
-export class ProjectReader {
+export class FileReader {
 
-  async readProject(directory: string): Promise<LoadedProject> {
+  async readConfigOrThrow(directory: string): Promise<File> {
     try {
-      const project: LoadedProject = {
-        files: [],
-        rootDirectory: directory,
+      const stat = await fs.stat(directory);
+      if (stat.isFile() && path.basename(directory) === CODIFY_FILE_NAME) {
+        return await this.readFile(directory);
+      } else if (stat.isDirectory()) {
+        return await this.readDirectory(directory, CODIFY_FILE_NAME)
+      } else {
+        throw new Error(NO_CONFIG_FOUND_ERROR_MESSAGE);
       }
 
-      const dir = await fs.readdir(directory);
-      await Promise.all(dir
-        .map(async (fileName) => {
-          if (!this.isFileTypeSupported(fileName)) {
-            return;
-          }
-
-          const parsedFile = await this.readFile(fileName, directory);
-          project.files.push(parsedFile);
-        })
-      );
-
-      return project;
-
     } catch (error) {
       console.log(error);
       throw error;
     }
   }
 
-  private async readFile(fileName: string, directory: string): Promise<File> {
-    const fileLocation = path.join(directory, fileName);
-    const fileType = fileName.lastIndexOf('.') === -1 ? '' : fileName.split('.').pop()!;
+  private async readDirectory(directory: string, fileName: string): Promise<File> {
+    const dir = await fs.readdir(directory);
 
-    return new File({ contents: await fs.readFile(fileLocation, 'utf8'), fileName, fileType });
+    if (!dir.includes(CODIFY_FILE_NAME)) {
+      throw new Error(NO_CONFIG_FOUND_ERROR_MESSAGE);
+    }
+
+    const fileLocation = path.join(directory, fileName);
+    return this.readFile(fileLocation);
   }
 
-  private isFileTypeSupported(fileName: string): boolean {
-    const parser = Object.entries(Parser.supportedParsers).find(([k]) => fileName.endsWith(k));
+  private async readFile(fileLocation: string): Promise<File> {
+    const fileName = path.basename(fileLocation);
+    const fileType = fileName.lastIndexOf('.') === -1 ? '' : fileName.split('.').pop()!;
 
-    return parser !== null && parser !== undefined;
+    return new File({ contents: await fs.readFile(fileLocation, 'utf8'), fileName, fileType });
   }
 }