added --return-errors flag

README.md

@@ -77,14 +77,18 @@ Annotate interfaces in your project or pass. ts-auto-guard will generate guards
 // my-project/Person.ts
 
 /** @see {isPerson} ts-auto-guard:type-guard */
-export interface Person { // !do not forget to export - only exported types are processed
+export interface Person {
+  // !do not forget to export - only exported types are processed
   name: string
   age?: number
   children: Person[]
 }
 ```
+
 ### Process all types
+
 Use `--export-all` parameter to process all exported types:
+
 ```
 $ ts-auto-guard --export-all
 ```
@@ -130,3 +134,23 @@ export function isPerson(obj: any): obj is Person {
 ```
 
 Using the `shortcircuit` option in combination with [uglify-js's `dead_code` and `global_defs` options](https://github.com/mishoo/UglifyJS2#compress-options) will let you omit the long and complicated checks from your production code.
+
+## Return errors
+
+Use --return-errors flag to create an extra function that will not acts as typesafe guards, but output an array of appropriate errors (the same errors as given in the debug mode).
+Intended use is for example integrity testing non typesafe database outputs, that can then be printed to the screen.
+
+```
+$ ts-auto-guard --return-errors
+```
+
+```ts
+// Generic usage
+isObjErrorOut(obj): errors: Error[]
+
+const returnVar = isPersonErrorOut({ name: "John", age: 20 })
+// returnVar.length: 0
+
+const returnVar = isPersonErrorOut({ name: 20, age: 20 })
+// returnVar[0].message: "person.name type mismatch, expected: string, found: 20"
+```

package.json

@@ -1,13 +1,14 @@
 {
   "name": "ts-auto-guard",
-  "version": "1.0.0-alpha.12",
+  "version": "1.0.0-alpha.13",
   "description": "Generate type guard functions from TypeScript interfaces",
   "homepage": "https://github.com/rhys-vdw/ts-auto-guard",
   "repository": "github:rhys-vdw/ts-auto-guard",
   "main": "lib/index.js",
   "scripts": {
     "test": "cross-env NODE_ENV=test && npm run lint && npm run format:check && tape -r ts-node/register tests/**/*.ts | tap-diff",
     "build": "tsc",
+    "watch": "tsc --watch",
     "prepare": "npm run build",
     "lint": "eslint .",
     "format": "eslint --fix --ext ts && prettier --write *.json *.js *.yml src/**/*.ts .github/**/*.yml",

src/cli.ts

@@ -13,6 +13,7 @@ interface ICliOptions {
   project: string | undefined
   help: boolean
   debug: boolean
+  'return-errors': boolean
   'export-all': boolean
 }
 
@@ -57,6 +58,13 @@ const optionList = [
     name: 'debug',
     type: Boolean,
   },
+  {
+    alias: 'r',
+    description:
+      'Return errors in the form of object { isType: boolean, errors: Error[] }',
+    name: 'return-errors',
+    type: Boolean,
+  },
 ]
 
 const options: ICliOptions = defaults(
@@ -76,6 +84,7 @@ async function run() {
       processOptions: {
         debug: options.debug,
         exportAll: options['export-all'],
+        returnErrors: options['return-errors'],
         shortCircuitCondition: options.shortcircuit,
       },
       project,