ts-runtime-validation 1.0.2 → 1.0.3

package/README.md

@@ -6,7 +6,11 @@ Get bulletproof type validation based off typescript interfaces without any extr
 
 ## How?
 
-This is a code generator that is designed to run as a yarn / npm script. By default scans your source directory for files ending in the provided glob pattern. By default: `*.jsonschema.{ts,tsx}`.
+This is a code generator that is designed to run as a yarn / npm script. By default scans your source directory for files ending in the provided glob pattern. By default: `*.jsonschema.{ts,tsx}`. The output will create three files:
+
+1. `./src/ts-runtime-validation/validation.schema.json` - containing the [jsonschema](http://json-schema.org/) types
+1. `./src/SchemaDefinition.ts` - containing the typescript.
+1. `./src/isSchemaValid.ts` - containing a type guard type inferring helper method (intended for consumption in your code base - examples below)
 
 ## Footnote
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ts-runtime-validation",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "author": "Matthew Duong <thegalah@gmail.com>",
     "license": "MIT",
     "dependencies": {

package/src/SchemaGenerator.ts

@@ -40,11 +40,9 @@ export class SchemaGenerator {
     private tsSchemaDefinitionOutputFile = path.join(this.options.rootPath, this.options.output, schemaDefinitionFileName);
     private isValidSchemaOutputFile = path.join(this.options.rootPath, this.options.output, "isSchemaValid.ts");
 
-    public constructor(private options: ICommandOptions) {
-        this.generateOutput();
-    }
+    public constructor(private options: ICommandOptions) {}
 
-    private generateOutput = async () => {
+    public Generate = async () => {
         const { helpers } = this.options;
         const fileList = await this.getMatchingFiles();
         console.log(`Found ${fileList.length} schema file(s)`);

package/src/index.ts

@@ -32,4 +32,5 @@ program.parse();
 
 const options = program.opts<ICommandOptions>();
 
-new SchemaGenerator(options);
+const generator = new SchemaGenerator(options);
+generator.Generate();

package/.scripts/generate-validation-enum.js

@@ -1,39 +0,0 @@
-const fs = require("fs");
-const schema = require("../src/validation.schema.json");
-const OUTPUT_FILE = "./src/SchemaDefinition.ts";
-
-const reservedDefinitionNameFilterFn = (definition) => {
-    return definition !== "ISchema" && definition !== "Schemas";
-};
-
-const definitions = Object.keys(schema.definitions).filter(reservedDefinitionNameFilterFn);
-
-const lines = [];
-lines.push(`// THIS IS AN AUTOGENERATED FILE PLEASE DO NOT MODIFY MANUALLY`);
-
-lines.push(`import {${definitions.join(", ")}} from "./Types";`);
-lines.push("");
-
-lines.push(`export const schemas: Record<keyof ISchema, string> = {`);
-definitions.forEach((definition) => {
-    lines.push(`    ["#/definitions/${definition}"]: "${definition}",`);
-});
-lines.push(`}`);
-
-lines.push("");
-
-lines.push("export interface ISchema {");
-
-definitions.forEach((definition) => {
-    lines.push(`    ["#/definitions/${definition}"]: ${definition},`);
-});
-lines.push("}");
-lines.push("");
-
-const output = lines.join("\n");
-
-fs.writeFile(OUTPUT_FILE, output, { flag: "w" }, function (err) {
-    if (err) {
-        return console.log(err);
-    }
-});