feat: enable cli flags to quicktype wrapper (#63)

* feat: enable cli flags to quicktype wrapper Signed-off-by: Grant Timmerman <timmerman+devrel@google.com> * fix: remove npm start edit Signed-off-by: Grant Timmerman <timmerman+devrel@google.com> * fix: change default to use flag override Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>
googleapis · Sep 3, 2020 · a2d1fc4 · a2d1fc4
1 parent 206f83b
commit a2d1fc4
Show file tree

Hide file tree

Showing 4 changed files with 121 additions and 38 deletions.
diff --git a/tools/quicktype-wrapper/README.md b/tools/quicktype-wrapper/README.md
@@ -27,17 +27,26 @@ npm run start
 
 ## Configure
 
-To configure the script, set required environment variables. (Command-line flags aren't supported yet.)
+To configure the script, use _environment variables_ or _command-line flags_:
 
-Here's an example:
+### Environment Variables
 
 ```sh
 IN=~/Documents/github/googleapis/google-cloudevents/proto
 OUT=~/Documents/out
 L=typescript
+
+qt
 ```
 
-Then run `qt`, which will pick up these environment variables.
+### Command-line Flags
+
+```sh
+qt \
+--in=~/Documents/github/googleapis/google-cloudevents/proto \
+--out=~/Documents/out \
+--l=typescript
+```
 
 ## Develop/Watch
 

diff --git a/tools/quicktype-wrapper/package-lock.json b/tools/quicktype-wrapper/package-lock.json
diff --git a/tools/quicktype-wrapper/package.json b/tools/quicktype-wrapper/package.json
@@ -26,6 +26,7 @@
   "dependencies": {
     "mkdirp": "^1.0.4",
     "quicktype-core": "^6.0.68",
-    "recursive-readdir": "^2.2.2"
+    "recursive-readdir": "^2.2.2",
+    "yargs": "^15.4.1"
   }
 }
diff --git a/tools/quicktype-wrapper/src/index.ts b/tools/quicktype-wrapper/src/index.ts
@@ -2,26 +2,29 @@
 
 import { readFileSync, writeFileSync } from "fs";
 import {jsonschema2language, LANGUAGE, LANGUAGE_EXT, TARGET_LANGUAGE} from './quickstype';
+const {argv} = require('yargs')
 const mkdirp = require('mkdirp');
 const HOMEDIR = process.env[(process.platform == 'win32') ? 'USERPROFILE' : 'HOME'];
 
 /**
  * A simple tool that generates code using quicktype.
+ * 
+ * Configuration (via environment variables or command-line flags):
  * @param {string} IN The directory for JSON Schema input. Must have trailing /.
  * @param {string} OUT The directory for generated output. Must have trailing /.
  * @param {string} L The target language
  */
-const IN = process.env.IN;
-const OUT = process.env.OUT;
-const L = (process.env.L || LANGUAGE.TYPESCRIPT).toUpperCase() as TARGET_LANGUAGE;
+const IN = argv.in || process.env.IN;
+const OUT = argv.out || process.env.OUT;
+const L = (argv.l || process.env.L || LANGUAGE.TYPESCRIPT).toUpperCase() as TARGET_LANGUAGE;
 
 console.log(
 `***********************
 ** Quicktype Wrapper **
 ***********************
 * Valid Languages (L): ${Object.values(LANGUAGE)}
 ***********************
-* Environment Variables:
+* Config:
 - IN=${IN}
 - OUT=${OUT}
 - L=${L}
@@ -46,8 +49,8 @@ async function getJSONSchemasPaths(directory: string) {
 (async () => {
   console.log('== START ==');
   // Validate configuration
-  if (!IN) console.error('Error: Environment variable `IN` not set');
-  if (!OUT) console.error('Error: Environment variable `OUT` not set');
+  if (!IN) console.error('Error in config: `IN` not set');
+  if (!OUT) console.error('Error in config: `OUT` not set');
   if (!IN || !OUT) return;
 
   // Get all paths for input.