Renamed configBlockType to configClass. Refactored parser entities

kevinwang5658 · kevinwang5658 · commit b4be45ead330 · 2023-12-30T11:50:30.000-05:00
diff --git a/codify-core/src/config-compiler/index.ts b/codify-core/src/config-compiler/index.ts
@@ -1,13 +1,14 @@
 import { ResourceDefinitions } from '../entities/resource-definition';
 import { InternalError } from '../utils/errors';
-import { ConfigBlockType } from './language-definition';
+import { ConfigClass } from './language-definition';
 import { ConfigLoader } from './loader';
 import { ConfigSemanticAnalyzer } from './output/config-semantic-analyzer';
 import { DependencyBuilder } from './output/dependency-builder';
 import { FileParser } from './parser';
-import { ParsedModule, ParsedProject } from './parser/entities';
-import { ProjectConfig } from './parser/entities/project';
-import { ResourceConfig } from './parser/entities/resource';
+import { ProjectConfig } from './parser/entities/configs/project';
+import { ResourceConfig } from './parser/entities/configs/resource';
+import { ParsedModule } from './parser/entities/parsed-module';
+import { ParsedProject } from './parser/entities/parsed-project';
 import { JsonFileParser } from './parser/json/file-parser';
 
 export class ConfigCompiler {
@@ -29,15 +30,15 @@ export class ConfigCompiler {
     }));
     const configBlocks = configBlocksResult.flat(1);
 
-    const parsedProjectConfigs = configBlocks.filter((u) => u.configType === ConfigBlockType.PROJECT);
+    const parsedProjectConfigs = configBlocks.filter((u) => u.configClass === ConfigClass.PROJECT);
     if (parsedProjectConfigs.length !== 1) {
       throw new Error('One one project config can be specified');
     }
 
     const projectConfig = parsedProjectConfigs[0] as ProjectConfig;
     return new ParsedProject({
       coreModule: new ParsedModule({
-        configBlocks: configBlocks.filter((u) => u.configType !== ConfigBlockType.PROJECT),
+        configBlocks: configBlocks.filter((u) => u.configClass !== ConfigClass.PROJECT),
       }),
       projectConfig,
     })
@@ -49,7 +50,7 @@ export class ConfigCompiler {
 
   static async buildDependencyList(parsedProject: ParsedProject): Promise<ResourceConfig[]> {
     const dependencyGraph = DependencyBuilder.buildDependencyGraph(parsedProject.coreModule.configBlocks
-      .filter((u) => u.configType === ConfigBlockType.RESOURCE) as ResourceConfig[]
+      .filter((u) => u.configClass === ConfigClass.RESOURCE) as ResourceConfig[]
     )
     return DependencyBuilder.generateDependencyList(dependencyGraph);
   }
diff --git a/codify-core/src/config-compiler/language-definition.ts b/codify-core/src/config-compiler/language-definition.ts
@@ -1,4 +1,4 @@
-export enum ConfigBlockType {
+export enum ConfigClass {
   PLUGIN = 'plugin',
   PROJECT = 'project',
   RESOURCE = 'resource',
diff --git a/codify-core/src/config-compiler/output/config-semantic-analyzer.test.ts b/codify-core/src/config-compiler/output/config-semantic-analyzer.test.ts
@@ -1,4 +1,4 @@
-import { ResourceConfig } from '../parser/entities/resource';
+import { ResourceConfig } from '../parser/entities/configs/resource';
 import { ResourceDefinition } from '../../entities/resource-definition';
 import { ResourceParameterDefinition } from '../../entities/resource-parameter';
 import { ResourceParameterType } from '../language-definition';
diff --git a/codify-core/src/config-compiler/output/config-semantic-analyzer.ts b/codify-core/src/config-compiler/output/config-semantic-analyzer.ts
@@ -1,16 +1,16 @@
 import { ResourceDefinitions } from '../../entities/resource-definition';
 import { validateResourceParameterType } from '../../utils/validator';
-import { ConfigBlockType } from '../language-definition';
-import { ParsedProject } from '../parser/entities';
-import { ResourceConfig } from '../parser/entities/resource';
+import { ConfigClass } from '../language-definition';
+import { ResourceConfig } from '../parser/entities/configs/resource';
+import { ParsedProject } from '../parser/entities/parsed-project';
 
 export const ConfigSemanticAnalyzer = {
 
   validate(project: ParsedProject, resourceDefinitions: ResourceDefinitions): void {
     const resourceConfigs = project
       .coreModule
       .configBlocks
-      .filter((u) => u.configType === ConfigBlockType.RESOURCE) as ResourceConfig[];
+      .filter((u) => u.configClass === ConfigClass.RESOURCE) as ResourceConfig[];
 
     this.validateResourceConfigs(resourceConfigs, resourceDefinitions);
   },
diff --git a/codify-core/src/config-compiler/output/dependency-builder.ts b/codify-core/src/config-compiler/output/dependency-builder.ts
@@ -1,4 +1,4 @@
-import { ResourceConfig } from '../parser/entities/resource';
+import { ResourceConfig } from '../parser/entities/configs/resource';
 import { ResourceNode } from './entities/resource-node';
 
 export const DependencyBuilder = {
diff --git a/codify-core/src/config-compiler/output/dependency-tree-builder.test.ts b/codify-core/src/config-compiler/output/dependency-tree-builder.test.ts
@@ -1,4 +1,4 @@
-import { ResourceConfig } from '../parser/entities/resource';
+import { ResourceConfig } from '../parser/entities/configs/resource';
 import { ResourceNode } from './entities/resource-node';
 import { DependencyBuilder } from './dependency-builder';
 import { expect } from '@oclif/test';
diff --git a/codify-core/src/config-compiler/output/entities/resource-node.ts b/codify-core/src/config-compiler/output/entities/resource-node.ts
@@ -1,5 +1,5 @@
 import { RemoveMethods } from '../../../utils/types';
-import { ResourceConfig } from '../../parser/entities/resource';
+import { ResourceConfig } from '../../parser/entities/configs/resource';
 
 export class ResourceNode {
   dependencies!: ResourceNode[];
diff --git a/codify-core/src/config-compiler/parser/entities/configs/plugin.ts b/codify-core/src/config-compiler/parser/entities/configs/plugin.ts
@@ -0,0 +1,18 @@
+import { RemoveMethods } from '../../../../utils/types'
+import { ConfigClass } from '../../../language-definition';
+import { ConfigBlock } from '../index';
+
+export class PluginConfig implements ConfigBlock {
+  configClass = ConfigClass.PLUGIN;
+
+  parameters!: Record<string, unknown>;
+
+  constructor(props: Omit<RemoveMethods<PluginConfig>, 'configClass'>) {
+    Object.assign(this, props)
+  }
+
+  validateConfig(config: unknown): void {
+    console.log(config);
+  }
+
+}
diff --git a/codify-core/src/config-compiler/parser/entities/configs/project.test.ts b/codify-core/src/config-compiler/parser/entities/configs/project.test.ts
diff --git a/codify-core/src/config-compiler/parser/entities/configs/project.ts b/codify-core/src/config-compiler/parser/entities/configs/project.ts
@@ -1,4 +1,4 @@
-import { RemoveMethods } from '../../../utils/types';
+import { RemoveMethods } from '../../../../utils/types';
 import {
   validateAllowedObjectKeys,
   validateNameString,
@@ -8,9 +8,9 @@ import {
   validateTypeRecordStringUnknown,
   validateTypeString,
   validateUrl
-} from '../../../utils/validator';
-import { ConfigBlockType } from '../../language-definition';
-import { ConfigBlock } from './index';
+} from '../../../../utils/validator';
+import { ConfigClass } from '../../../language-definition';
+import { ConfigBlock } from '../index';
 
 /** Project JSON supported format
  * {
@@ -30,13 +30,13 @@ const ALLOWED_KEYS = [
 ]
 
 export class ProjectConfig implements ConfigBlock {
-  configType = ConfigBlockType.PROJECT;
+  configClass = ConfigClass.PROJECT;
 
   name?: string;
   plugins?: Record<string, string>;
 
   constructor(config: unknown) {
-    if (this.validate(config)) {
+    if (this.validateConfig(config)) {
       this.name = config.name;
       this.plugins = config.plugins;
 
@@ -46,7 +46,7 @@ export class ProjectConfig implements ConfigBlock {
     throw new Error('Unable to parse project');
   }
 
-  validate(config: unknown): config is RemoveMethods<ProjectConfig> {
+  validateConfig(config: unknown): config is RemoveMethods<ProjectConfig> {
     if (!validateTypeRecordStringUnknown(config)) {
       throw new Error('Config is not an object');
     }
diff --git a/codify-core/src/config-compiler/parser/entities/configs/resource.ts b/codify-core/src/config-compiler/parser/entities/configs/resource.ts
@@ -1,7 +1,7 @@
-import { RemoveMethods } from '../../../utils/types';
-import { validateNameString, validateTypeRecordStringUnknown, validateTypeString, } from '../../../utils/validator';
-import { ConfigBlockType } from '../../language-definition';
-import { ConfigBlock } from './index';
+import { RemoveMethods } from '../../../../utils/types';
+import { validateNameString, validateTypeRecordStringUnknown, validateTypeString, } from '../../../../utils/validator';
+import { ConfigClass } from '../../../language-definition';
+import { ConfigBlock } from '../index';
 
 /** Resource JSON supported format
  * {
@@ -19,15 +19,15 @@ import { ConfigBlock } from './index';
  */
 
 export class ResourceConfig implements ConfigBlock {
-  readonly configType = ConfigBlockType.RESOURCE;
+  readonly configClass = ConfigClass.RESOURCE;
 
   type: string;
   name?: string;
   pluginName?: string;
   parameters: Record<string, unknown>;
 
   constructor(config: unknown) {
-    if (this.validate(config)) {
+    if (this.validateConfig(config)) {
       const { name, type, ...parameters } = config;
       this.type = type;
       this.name = name;
@@ -39,7 +39,7 @@ export class ResourceConfig implements ConfigBlock {
     throw new Error('Unable to parse resource config');
   }
 
-  validate(config: unknown): config is RemoveMethods<ResourceConfig> {
+  validateConfig(config: unknown): config is RemoveMethods<ResourceConfig> {
     if (!validateTypeRecordStringUnknown(config)) {
       throw new Error('Config is not an object');
     }
diff --git a/codify-core/src/config-compiler/parser/entities/index.ts b/codify-core/src/config-compiler/parser/entities/index.ts
@@ -1,26 +1,7 @@
-import { RemoveMethods } from '../../../utils/types';
-import { ConfigBlockType } from '../../language-definition';
-import { ProjectConfig } from './project';
+import { ConfigClass } from '../../language-definition';
 
 export interface ConfigBlock {
-  configType: ConfigBlockType;
+  configClass: ConfigClass;
 
-  validate(config: unknown): never | void;
-}
-
-export class ParsedProject {
-  coreModule!: ParsedModule;
-  projectConfig!: ProjectConfig;
-
-  constructor(props: RemoveMethods<ParsedProject>) {
-    Object.assign(this, props)
-  }
-}
-
-export class ParsedModule {
-  configBlocks!: ConfigBlock[];
-
-  constructor(props: RemoveMethods<ParsedModule>) {
-    Object.assign(this, props);
-  }
+  validateConfig(config: unknown): never | void;
 }
diff --git a/codify-core/src/config-compiler/parser/entities/parsed-module.ts b/codify-core/src/config-compiler/parser/entities/parsed-module.ts
@@ -0,0 +1,10 @@
+import { RemoveMethods } from '../../../utils/types';
+import { ConfigBlock } from './index';
+
+export class ParsedModule {
+  configBlocks!: ConfigBlock[];
+
+  constructor(props: RemoveMethods<ParsedModule>) {
+    Object.assign(this, props);
+  }
+}
diff --git a/codify-core/src/config-compiler/parser/entities/parsed-project.ts b/codify-core/src/config-compiler/parser/entities/parsed-project.ts
@@ -0,0 +1,12 @@
+import { RemoveMethods } from '../../../utils/types';
+import { ProjectConfig } from './configs/project';
+import { ParsedModule } from './parsed-module';
+
+export class ParsedProject {
+  coreModule!: ParsedModule;
+  projectConfig!: ProjectConfig;
+
+  constructor(props: RemoveMethods<ParsedProject>) {
+    Object.assign(this, props)
+  }
+}
diff --git a/codify-core/src/config-compiler/parser/entities/plugin.ts b/codify-core/src/config-compiler/parser/entities/plugin.ts
diff --git a/codify-core/src/config-compiler/parser/json/config-block-factory.ts b/codify-core/src/config-compiler/parser/json/config-block-factory.ts
@@ -1,9 +1,9 @@
 import { SyntaxError } from '../../../utils/errors';
-import { ConfigBlockType } from '../../language-definition';
+import { ConfigClass } from '../../language-definition';
 import { ConfigBlock } from '../entities';
-import { PluginConfig } from '../entities/plugin';
-import { ProjectConfig } from '../entities/project';
-import { ResourceConfig } from '../entities/resource';
+import { PluginConfig } from '../entities/configs/plugin';
+import { ProjectConfig } from '../entities/configs/project';
+import { ResourceConfig } from '../entities/configs/resource';
 
 export const JsonConfigBlockFactory = {
 
@@ -19,13 +19,13 @@ export const JsonConfigBlockFactory = {
     }
 
     switch (unknownNode.type) {
-      case ConfigBlockType.PLUGIN: {
+      case ConfigClass.PLUGIN: {
         return new PluginConfig({
           parameters: unknownNode,
         });
       }
 
-      case ConfigBlockType.PROJECT: {
+      case ConfigClass.PROJECT: {
         return new ProjectConfig(unknownNode);
       }
 
diff --git a/codify-core/src/plugins/entities/plugin.ts b/codify-core/src/plugins/entities/plugin.ts
@@ -1,4 +1,4 @@
-import { ResourceConfig } from '../../config-compiler/parser/entities/resource';
+import { ResourceConfig } from '../../config-compiler/parser/entities/configs/resource';
 import { PluginIpcBridge } from '../ipc-bridge';
 import { PluginData } from './plugin-data';
 
diff --git a/codify-core/src/plugins/plugin-collection.ts b/codify-core/src/plugins/plugin-collection.ts
@@ -1,6 +1,6 @@
-import { ConfigBlockType } from '../config-compiler/language-definition';
-import { ParsedProject } from '../config-compiler/parser/entities';
-import { ResourceConfig } from '../config-compiler/parser/entities/resource';
+import { ConfigClass } from '../config-compiler/language-definition';
+import { ResourceConfig } from '../config-compiler/parser/entities/configs/resource';
+import { ParsedProject } from '../config-compiler/parser/entities/parsed-project';
 import { ResourceDefinition } from '../entities/resource-definition';
 import { Plugin } from './entities/plugin';
 import { PluginResolver } from './resolver';
@@ -59,7 +59,7 @@ export class PluginCollection {
   async getPlan(project: ParsedProject): Promise<Array<string>> {
     const result = new Array<string>();
     for (const config of project.coreModule.configBlocks) {
-      if (config.configType !== ConfigBlockType.RESOURCE) {
+      if (config.configClass !== ConfigClass.RESOURCE) {
         continue;
       }
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-export enum ConfigBlockType {`
	`1`	`+export enum ConfigClass {`
`2`	`2`	`PLUGIN = 'plugin',`
`3`	`3`	`PROJECT = 'project',`
`4`	`4`	`RESOURCE = 'resource',`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { ResourceConfig } from '../parser/entities/resource';`
	`1`	`+import { ResourceConfig } from '../parser/entities/configs/resource';`
`2`	`2`	`import { ResourceDefinition } from '../../entities/resource-definition';`
`3`	`3`	`import { ResourceParameterDefinition } from '../../entities/resource-parameter';`
`4`	`4`	`import { ResourceParameterType } from '../language-definition';`