docs: add changes to next release in CHANGELOG; refactor(internal): test scripts

Author: svolkov

CHANGELOG.md

@@ -1,8 +1,11 @@
 # next release  
 Features:  
-    - Api module description from schema info  
-      ![api description](./assets/changelog_assets/api-module-description.jpg)  
-    
+  - Api module description from schema info  
+    ![api description](./assets/changelog_assets/api-module-description.jpg)  
+  - Generate API types declarations (CLI flag `--route-types`)  
+  - Ability to not generate clint API class (CLI flag `--no-client`)  
+Internal:
+  - refactored generate and validate test scripts      
 
 # 1.2.6  
 Fixes: create api without `-o` option (use default `./` output)  

tests/generate.js

@@ -1,39 +1,26 @@
-const fs = require("fs");
 const path = require("path");
+const createSchemasInfos = require("./utils/createSchemaInfos")
 const { generateApi } = require('../src');
 
-const createSchemasInfos = (pathToSchemas) =>
-  (fs.readdirSync(pathToSchemas) || [])
-    .reduce((schemas, fileName) => ([
-      ...schemas,
-      {
-        absolutePath: path.resolve(pathToSchemas, fileName),
-        schemaFileName: fileName,
-        apiFileName: fileName.replace(/.(yaml|json|yml)/g, '.ts'),
-      }
-    ]), [])
+const schemas = [
+  ...createSchemasInfos({
+    absolutePathToSchemas: path.resolve(__dirname, "./schemas/v2.0"),
+    absoluteOutputPath: path.resolve(__dirname, "./generated/v2.0")
+  }),
+  ...createSchemasInfos({
+    absolutePathToSchemas: path.resolve(__dirname, "./schemas/v3.0"),
+    absoluteOutputPath: path.resolve(__dirname, "./generated/v3.0")
+  }),
+]
 
-const v2Schemas = createSchemasInfos(path.resolve(__dirname, "./schemas/v2.0"));
-const v3Schemas = createSchemasInfos(path.resolve(__dirname, "./schemas/v3.0"));
-
-v2Schemas.forEach(({
+schemas.forEach(({
   absolutePath,
   apiFileName,
+  outputPath,
 }) => {
   generateApi({
     name: apiFileName,
     input: absolutePath,
-    output: path.resolve(__dirname, "./generated/v2.0/")
+    output: outputPath,
   });
 })
-
-v3Schemas.forEach(({
-  absolutePath,
-  apiFileName,
-}) => {
-  generateApi({
-    name: apiFileName,
-    input: absolutePath,
-    output: path.resolve(__dirname, "./generated/v3.0/")
-  });
-})

tests/utils/createGeneratedApiInfos.js

@@ -0,0 +1,6 @@
+const fs = require("fs");
+const { resolve } = require("path");
+
+module.exports = (pathToApis) =>
+  (fs.readdirSync(pathToApis) || [])
+    .map(fileName => resolve(pathToApis, fileName))

tests/utils/createSchemaInfos.js

@@ -0,0 +1,18 @@
+const fs = require("fs");
+const path = require("path");
+
+module.exports = ({
+  absolutePathToSchemas,
+  absoluteOutputPath,
+}) => {
+  return (fs.readdirSync(absolutePathToSchemas) || [])
+    .reduce((schemas, fileName) => ([
+      ...schemas,
+      {
+        absolutePath: path.resolve(absolutePathToSchemas, fileName),
+        schemaFileName: fileName,
+        apiFileName: fileName.replace(/.(yaml|json|yml)/g, '.ts'),
+        outputPath: absoluteOutputPath
+      }
+    ]), [])
+}

tests/utils/validateGeneratedModule.js

@@ -0,0 +1,35 @@
+const { relative } = require("path");
+const tsc = require("typescript");
+
+const compilerOptions = {
+  noEmitOnError: true,
+  noImplicitAny: false,
+  target: tsc.ScriptTarget.ES5, module: tsc.ModuleKind.CommonJS
+}
+
+module.exports = (path) => {
+  process.stdout.write(`validating ${relative('', path)}: `)
+
+  var program = tsc.createProgram([path], compilerOptions);
+  var emitResult = program.emit(void 0, void 0, void 0, true)
+
+  var allDiagnostics = emitResult.diagnostics;
+
+  allDiagnostics.forEach(({
+    messageText,
+    file,
+    start,
+  }) => {
+      var message = tsc.flattenDiagnosticMessageText(messageText, '\n');
+      if (!file) {
+          console.error(message);
+          return;
+      }
+      var { line, character } = file.getLineAndCharacterOfPosition(start);
+      console.error(`${file.fileName} (${line + 1},${character + 1}): ${message}`);
+  });
+
+  process.stdout.write(`errors ${allDiagnostics.length}\r\n`)
+
+  return allDiagnostics
+}

tests/validate.js

@@ -1,10 +1,6 @@
-const fs = require("fs");
-const { resolve, relative } = require("path");
-const tsc = require("typescript");
-
-const createGeneratedApiInfos = (pathToApis) =>
-  (fs.readdirSync(pathToApis) || [])
-    .map(fileName => resolve(pathToApis, fileName))
+const { resolve } = require("path");
+const createGeneratedApiInfos = require("./utils/createGeneratedApiInfos");
+const validateGeneratedModule = require("./utils/validateGeneratedModule");
 
 const v2ApiPaths = createGeneratedApiInfos(resolve(__dirname, "./generated/v2.0"));
 const v3ApiPaths = createGeneratedApiInfos(resolve(__dirname, "./generated/v3.0"));
@@ -15,30 +11,10 @@ let hasErrors = false;
   ...v2ApiPaths,
   ...v3ApiPaths,
 ].forEach(path => {
-  process.stdout.write(`validating ${relative('', path)}: `)
-  var program = tsc.createProgram([path], {
-    noEmitOnError: true,
-    noImplicitAny: false,
-    target: tsc.ScriptTarget.ES5, module: tsc.ModuleKind.CommonJS
-  });
-  var emitResult = program.emit(void 0, void 0, void 0, true)
-
-  var allDiagnostics = emitResult.diagnostics;
-
-  allDiagnostics.forEach(diagnostic => {
-      var message = tsc.flattenDiagnosticMessageText(diagnostic.messageText, '\n');
-      if (!diagnostic.file) {
-          console.error(message);
-          return;
-      }
-      var { line, character } = diagnostic.file.getLineAndCharacterOfPosition(diagnostic.start);
-      console.error(`${diagnostic.file.fileName} (${line + 1},${character + 1}): ${message}`);
-  });
-
-  process.stdout.write(`errors ${emitResult.diagnostics.length}\r\n`)
+  const diagnostics = validateGeneratedModule(path)
 
   if (!hasErrors) {
-    hasErrors = !!emitResult.diagnostics.length
+    hasErrors = !!diagnostics.length
   }
 })