ts-runtime-validation 1.2.0 → 1.2.3

package/README.md

@@ -16,6 +16,15 @@ This is a code generator that is designed to run as a yarn / npm script. By defa
 
 The helper file assumes you have [ajv-validator](https://github.com/ajv-validator/ajv) peer dependency installed. Since this is only a code generation tool this package can be installed as a dev dependency.
 
+## Installation
+
+```bash
+# yarn
+yarn add --dev ts-runtime-validation
+# npm
+npm install --dev ts-runtime-validation
+```
+
 ## CLI usage
 
 Ensure your project files containing the schemas you want to validate end with the prefix `.jsonschema.ts`
@@ -32,6 +41,21 @@ Options:
   -h, --help              display help for command
 ```
 
+## npm script usage
+
+The intended use for ts-runtime-validation is as a npm script. Here it can also be tweaked to watch (eg. using nodemon)
+
+```json
+{
+    "scripts": {
+        "generate-types": "ts-runtime-validation"
+    },
+    "devDependencies": {
+        "ts-runtime-validation": "^1.2.0"
+    }
+}
+```
+
 ## Example usage of generated ts type validation
 
 ```typescript

package/dist/index.js

@@ -8,11 +8,12 @@ const defaultRootPath = "./src";
 const defaultOutputFolder = "./.ts-runtime-validation";
 commander_1.program.option("--glob", `Glob file path of typescript files to generate ts-interface -> json-schema validations - default: ${defaultGlobPattern}`, defaultGlobPattern);
 commander_1.program.option("--rootPath", `RootPath of source - default: ${defaultRootPath}`, defaultRootPath);
-commander_1.program.option("--output", `Validation schema + typescript interface output directory (relative to root path) - default: ${defaultOutputFolder}`, defaultOutputFolder);
+commander_1.program.option("--output <outputFolder>", `Validation schema + typescript interface output directory (relative to root path) - default: ${defaultOutputFolder}`, defaultOutputFolder);
 commander_1.program.option("--no-helpers", "Only generate JSON schema without typescript helper files", true);
 commander_1.program.option("--additionalProperties", "Allow additional properties to pass validation", false);
 commander_1.program.parse();
 const options = commander_1.program.opts();
+console.log(options);
 const generator = new SchemaGenerator_1.SchemaGenerator(options);
 generator.Generate();
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,uDAAoD;AACpD,yCAAoC;AAEpC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAEnD,MAAM,eAAe,GAAG,OAAO,CAAC;AAChC,MAAM,mBAAmB,GAAG,0BAA0B,CAAC;AAUvD,mBAAO,CAAC,MAAM,CACV,QAAQ,EACR,qGAAqG,kBAAkB,EAAE,EACzH,kBAAkB,CACrB,CAAC;AACF,mBAAO,CAAC,MAAM,CAAC,YAAY,EAAE,iCAAiC,eAAe,EAAE,EAAE,eAAe,CAAC,CAAC;AAClG,mBAAO,CAAC,MAAM,CACV,UAAU,EACV,gGAAgG,mBAAmB,EAAE,EACrH,mBAAmB,CACtB,CAAC;AACF,mBAAO,CAAC,MAAM,CAAC,cAAc,EAAE,2DAA2D,EAAE,IAAI,CAAC,CAAC;AAClG,mBAAO,CAAC,MAAM,CAAC,wBAAwB,EAAE,gDAAgD,EAAE,KAAK,CAAC,CAAC;AAElG,mBAAO,CAAC,KAAK,EAAE,CAAC;AAEhB,MAAM,OAAO,GAAG,mBAAO,CAAC,IAAI,EAAmB,CAAC;AAEhD,MAAM,SAAS,GAAG,IAAI,iCAAe,CAAC,OAAO,CAAC,CAAC;AAC/C,SAAS,CAAC,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,uDAAoD;AACpD,yCAAoC;AAEpC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAEnD,MAAM,eAAe,GAAG,OAAO,CAAC;AAChC,MAAM,mBAAmB,GAAG,0BAA0B,CAAC;AAUvD,mBAAO,CAAC,MAAM,CACV,QAAQ,EACR,qGAAqG,kBAAkB,EAAE,EACzH,kBAAkB,CACrB,CAAC;AACF,mBAAO,CAAC,MAAM,CAAC,YAAY,EAAE,iCAAiC,eAAe,EAAE,EAAE,eAAe,CAAC,CAAC;AAClG,mBAAO,CAAC,MAAM,CACV,yBAAyB,EACzB,gGAAgG,mBAAmB,EAAE,EACrH,mBAAmB,CACtB,CAAC;AACF,mBAAO,CAAC,MAAM,CAAC,cAAc,EAAE,2DAA2D,EAAE,IAAI,CAAC,CAAC;AAClG,mBAAO,CAAC,MAAM,CAAC,wBAAwB,EAAE,gDAAgD,EAAE,KAAK,CAAC,CAAC;AAElG,mBAAO,CAAC,KAAK,EAAE,CAAC;AAEhB,MAAM,OAAO,GAAG,mBAAO,CAAC,IAAI,EAAmB,CAAC;AAChD,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAErB,MAAM,SAAS,GAAG,IAAI,iCAAe,CAAC,OAAO,CAAC,CAAC;AAC/C,SAAS,CAAC,QAAQ,EAAE,CAAC"}

package/package.json

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

package/src/index.ts

@@ -23,7 +23,7 @@ program.option(
 );
 program.option("--rootPath", `RootPath of source - default: ${defaultRootPath}`, defaultRootPath);
 program.option(
-    "--output",
+    "--output <outputFolder>",
     `Validation schema + typescript interface output directory (relative to root path) - default: ${defaultOutputFolder}`,
     defaultOutputFolder
 );
@@ -33,6 +33,7 @@ program.option("--additionalProperties", "Allow additional properties to pass va
 program.parse();
 
 const options = program.opts<ICommandOptions>();
+console.log(options);
 
 const generator = new SchemaGenerator(options);
 generator.Generate();