feat: classify code generator (#31)

Himenon · Apr 5, 2021 · 09f8509 · 09f8509
1 parent 881625c
commit 09f8509
Show file tree

Hide file tree

Showing 57 changed files with 287 additions and 273 deletions.
diff --git a/README.md b/README.md
@@ -58,7 +58,7 @@ const main = () => {
   const params: CodeGenerator.Params = {
     entryPoint: "your/openapi/spec.yml", // support .yml, .yaml, .json
     option: {
-      rewriteCodeAfterTypeDeclaration: (context: ts.TransformationContext, codeGeneratorParamsList: CodeGenerator.Converter.v3.CodeGeneratorParams[]): ts.Statement[] => {
+      rewriteCodeAfterTypeDeclaration: (context: Pick<ts.TransformationContext, "factory">, codeGeneratorParamsList: CodeGenerator.Converter.v3.CodeGeneratorParams[]): ts.Statement[] => {
         const factory = context.factory; // https://ts-ast-viewer.com/ is very very very useful !
         return []; // generate no api client
       },

diff --git a/docs/ja/README-ja.md b/docs/ja/README-ja.md
@@ -54,7 +54,7 @@ const main = () => {
   const params: CodeGenerator.Params = {
     entryPoint: "your/openapi/spec.yml", // support .yml, .yaml, .json
     option: {
-      rewriteCodeAfterTypeDeclaration: (context: ts.TransformationContext, codeGeneratorParamsList: CodeGenerator.Converter.v3.CodeGeneratorParams[]): ts.Statement[] => {
+      rewriteCodeAfterTypeDeclaration: (context: Pick<ts.TransformationContext, "factory">, codeGeneratorParamsList: CodeGenerator.Converter.v3.CodeGeneratorParams[]): ts.Statement[] => {
         const factory = context.factory; // https://ts-ast-viewer.com/ is very very very useful !
         return []; // generate no api client
       },

diff --git a/scripts/testCodeGen.ts b/scripts/testCodeGen.ts
@@ -1,59 +1,41 @@
 import * as fs from "fs";
 
-import * as CodeGenerator from "../lib";
+import { CodeGenerator, DefaultCodeTemplate } from "../lib";
 
 const gen = (name: string, enableValidate = true): void => {
-  const params: CodeGenerator.OpenApiTsCodeGen.Configuration = {
-    entryPoint: `test/${name}/index.yml`,
-    codeGenerator: {
-      templates: {
-        Default: CodeGenerator.DefaultCodeTemplate.makeApiClient,
-      },
-    },
-    typeDefinitionGenerator: {
-      additional: {
-        template: "Default",
-      },
-    },
-    validator: {
-      openapiSchema: enableValidate,
-      logger: {
-        displayLogLines: 1,
-      },
-    },
-  };
   fs.mkdirSync("test/code", { recursive: true });
-  const output = CodeGenerator.make(params);
-  fs.writeFileSync(`test/code/${name}.ts`, output.typeDefinition.value, { encoding: "utf-8" });
+  const codeGenerator = new CodeGenerator(`test/${name}/index.yml`);
+  // codeGenerator.validate();
+  const code = codeGenerator.generateTypeDefinition<DefaultCodeTemplate.Option>({
+    generator: DefaultCodeTemplate.makeApiClient,
+    option: {
+      sync: false,
+    },
+  });
+  if (enableValidate) {
+    codeGenerator.validate({
+      logger: { displayLogLines: 1 },
+    });
+  }
+  fs.writeFileSync(`test/code/${name}.ts`, code, { encoding: "utf-8" });
   console.log(`Generate Code : test/code/${name}.ts`);
 };
 
 const genSyncMode = (name: string, enableValidate = true): void => {
-  const params: CodeGenerator.OpenApiTsCodeGen.Configuration = {
-    entryPoint: `test/${name}/index.yml`,
-    codeGenerator: {
-      templates: {
-        Default: CodeGenerator.DefaultCodeTemplate.makeApiClient,
-      },
-    },
-    typeDefinitionGenerator: {
-      additional: {
-        template: "Default",
-        option: {
-          sync: true,
-        },
-      },
-    },
-    validator: {
-      openapiSchema: enableValidate,
-      logger: {
-        displayLogLines: 1,
-      },
-    },
-  };
+  const codeGenerator = new CodeGenerator(`test/${name}/index.yml`);
   fs.mkdirSync("test/code", { recursive: true });
-  const code = CodeGenerator.make(params);
-  fs.writeFileSync(`test/code/sync-${name}.ts`, code.typeDefinition.value, { encoding: "utf-8" });
+  if (enableValidate) {
+    codeGenerator.validate({
+      logger: { displayLogLines: 1 },
+    });
+  }
+  const code = codeGenerator.generateTypeDefinition<DefaultCodeTemplate.Option>({
+    generator: DefaultCodeTemplate.makeApiClient,
+    option: {
+      sync: true,
+    },
+  });
+  fs.writeFileSync(`test/code/sync-${name}.ts`, code, { encoding: "utf-8" });
   console.log(`Generate Code : test/code/sync-${name}.ts`);
 };
 

diff --git a/scripts/validate.ts b/scripts/validate.ts
@@ -15,6 +15,6 @@ const validator = new OpenAPISchemaValidator({
   },
 });
 
-const message = validator.validate(yaml.safeLoad(data) as any);
+const message = validator.validate(yaml.load(data) as any);
 
 fs.writeFileSync(path.join(__dirname, "../debug/validate.json"), JSON.stringify(message, null, 2), { encoding: "utf-8" });
diff --git a/src/CodeGenerator/factory/BinaryExpression.ts b/src/CodeGenerator/factory/BinaryExpression.ts
@@ -14,12 +14,12 @@ export interface Factory {
   create: (params: Params) => ts.BinaryExpression;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params): ts.BinaryExpression => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params): ts.BinaryExpression => {
   const node = factory.createBinaryExpression(params.left, operators[params.operator], params.right);
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/Block.ts b/src/CodeGenerator/factory/Block.ts
@@ -9,12 +9,12 @@ export interface Factory {
   create: (params: Params$Create) => ts.Block;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params$Create): ts.Block => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params$Create): ts.Block => {
   const node = factory.createBlock(params.statements, params.multiLine);
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/CallExpression.ts b/src/CodeGenerator/factory/CallExpression.ts
@@ -10,12 +10,12 @@ export interface Factory {
   create: (params: Params$Create) => ts.CallExpression;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params$Create): ts.CallExpression => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params$Create): ts.CallExpression => {
   const node = factory.createCallExpression(params.expression, params.typeArguments, params.argumentsArray);
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/ClassDeclaration.ts b/src/CodeGenerator/factory/ClassDeclaration.ts
@@ -11,7 +11,7 @@ export interface Factory {
   create: (params: Params$Create) => ts.ClassDeclaration;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params$Create): ts.ClassDeclaration => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params$Create): ts.ClassDeclaration => {
   const node = factory.createClassDeclaration(
     undefined,
     params.export && [factory.createModifier(ts.SyntaxKind.ExportKeyword)],
@@ -23,7 +23,7 @@ export const create = ({ factory }: ts.TransformationContext): Factory["create"]
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/ConstructorDeclaration.ts b/src/CodeGenerator/factory/ConstructorDeclaration.ts
@@ -9,12 +9,12 @@ export interface Factory {
   create: (params: Params$Create) => ts.ConstructorDeclaration;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params$Create): ts.ConstructorDeclaration => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params$Create): ts.ConstructorDeclaration => {
   const node = factory.createConstructorDeclaration(undefined, undefined, params.parameters || [], params.body);
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/ElementAccessExpression.ts b/src/CodeGenerator/factory/ElementAccessExpression.ts
@@ -9,13 +9,13 @@ export interface Factory {
   create: (params: Params$Create) => ts.ElementAccessExpression;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params$Create): ts.ElementAccessExpression => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params$Create): ts.ElementAccessExpression => {
   const index = typeof params.index === "string" ? factory.createStringLiteral(params.index) : params.index;
   const node = factory.createElementAccessExpression(params.expression, index);
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/FunctionTypeNode.ts b/src/CodeGenerator/factory/FunctionTypeNode.ts
@@ -10,12 +10,12 @@ export interface Factory {
   create: (params: Params$Create) => ts.FunctionTypeNode;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params$Create): ts.FunctionTypeNode => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params$Create): ts.FunctionTypeNode => {
   const node = factory.createFunctionTypeNode(params.typeParameters, params.parameters, params.type);
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/Identifier.ts b/src/CodeGenerator/factory/Identifier.ts
@@ -8,12 +8,12 @@ export interface Factory {
   create: (params: Params) => ts.Identifier;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params): ts.Identifier => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params): ts.Identifier => {
   const node = factory.createIdentifier(params.name);
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/IndexSignatureDeclaration.ts b/src/CodeGenerator/factory/IndexSignatureDeclaration.ts
@@ -9,7 +9,7 @@ export interface Factory {
   create: (params: Params$Create) => ts.IndexSignatureDeclaration;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params$Create): ts.IndexSignatureDeclaration => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params$Create): ts.IndexSignatureDeclaration => {
   const node = factory.createIndexSignature(
     undefined,
     undefined,
@@ -30,7 +30,7 @@ export const create = ({ factory }: ts.TransformationContext): Factory["create"]
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/IndexedAccessTypeNode.ts b/src/CodeGenerator/factory/IndexedAccessTypeNode.ts
@@ -9,12 +9,12 @@ export interface Factory {
   create: (params: Params$Create) => ts.IndexedAccessTypeNode;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params$Create): ts.IndexedAccessTypeNode => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params$Create): ts.IndexedAccessTypeNode => {
   const node = factory.createIndexedAccessTypeNode(params.objectType, params.indexType);
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/InterfaceDeclaration.ts b/src/CodeGenerator/factory/InterfaceDeclaration.ts
@@ -15,7 +15,7 @@ export interface Factory {
   create: (params: Params$Create) => ts.InterfaceDeclaration;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params$Create): ts.InterfaceDeclaration => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params$Create): ts.InterfaceDeclaration => {
   const node = factory.createInterfaceDeclaration(
     undefined,
     params.export && [factory.createModifier(ts.SyntaxKind.ExportKeyword)],
@@ -31,7 +31,7 @@ export const create = ({ factory }: ts.TransformationContext): Factory["create"]
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/IntersectionTypeNode.ts b/src/CodeGenerator/factory/IntersectionTypeNode.ts
@@ -8,12 +8,12 @@ export interface Factory {
   create: (params: Params) => ts.IntersectionTypeNode;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params): ts.IntersectionTypeNode => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params): ts.IntersectionTypeNode => {
   const node = factory.createIntersectionTypeNode(params.typeNodes);
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/LiteralTypeNode.ts b/src/CodeGenerator/factory/LiteralTypeNode.ts
@@ -11,7 +11,7 @@ export interface Factory {
   create: (params: Params) => ts.LiteralTypeNode;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params): ts.LiteralTypeNode => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params): ts.LiteralTypeNode => {
   const createNode = () => {
     if (typeof params.value === "string") {
       const literal = ts.setEmitFlags(factory.createStringLiteral(params.value), ts.EmitFlags.NoAsciiEscaping);
@@ -31,7 +31,7 @@ export const create = ({ factory }: ts.TransformationContext): Factory["create"]
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/MethodDeclaration.ts b/src/CodeGenerator/factory/MethodDeclaration.ts
@@ -18,7 +18,7 @@ export interface Factory {
   create: (params: Params$Create) => ts.MethodDeclaration;
 }
 
-export const create = ({ factory }: ts.TransformationContext): Factory["create"] => (params: Params$Create): ts.MethodDeclaration => {
+export const create = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] => (params: Params$Create): ts.MethodDeclaration => {
   const modifiers: ts.Modifier[] = [];
   if (params.private) {
     modifiers.push(factory.createModifier(ts.SyntaxKind.PrivateKeyword));
@@ -46,7 +46,7 @@ export const create = ({ factory }: ts.TransformationContext): Factory["create"]
   return node;
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     create: create(context),
   };

diff --git a/src/CodeGenerator/factory/ModuleBlock.ts b/src/CodeGenerator/factory/ModuleBlock.ts
@@ -9,12 +9,12 @@ export interface Factory {
   update: (params: UpdateParams) => ts.ModuleBlock;
 }
 
-export const update = ({ factory }: ts.TransformationContext): Factory["update"] => (params: UpdateParams): ts.ModuleBlock => {
+export const update = ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["update"] => (params: UpdateParams): ts.ModuleBlock => {
   const { node, statements } = params;
   return factory.updateModuleBlock(node, statements);
 };
 
-export const make = (context: ts.TransformationContext): Factory => {
+export const make = (context: Pick<ts.TransformationContext, "factory">): Factory => {
   return {
     update: update(context),
   };