Add command line argument to set introspection url (#25)

* Add ability to feed url into command line argument and override value in spec

* Change command line variable to be more specific

* "Pin dep to 6.2 since 7.0 has breaking changes"

* update package.lock

* Update yarn.lock

Co-authored-by: Oshin Karamian <[email protected]>

README.md

@@ -110,6 +110,8 @@ $ dociql -h
     -f, --target-file <file>     the target build HTML file (default: index.html)
     -a, --app-dir <dir>          the application source directory (default: app)
     -l, --logo-file <file>       specify a custom logo file (default: null)
+    -1, --one-file               embed all resources (CSS and JS) into the same file (default: false)
+    -u, --introspection-url <url>              specify a custom url to use for introspection (default: none)
     -c, --config-file <file>     specify a custom configuration file (default: app/lib/config.js)
 ```
 

app/dociql/index.js

@@ -5,13 +5,14 @@ const fs = require("fs")
 const fetchSchema = require("./fetch-schema")
 const composePaths = require("./compose-paths")
 
-module.exports = function(specPath, headers) {
+module.exports = function(specPath, headers, introspectionUrl) {
     // read spec file content
     const fileContent = fs.readFileSync(specPath, "utf8")
     // deserialise
     const spec = yaml.safeLoad(fileContent)
-    // fetch graphQL Schema
-    const graphUrl = spec.introspection
+    // fetch graphQL Schema, if given an introspection url use that over the value in
+    // the spec
+    const graphUrl = introspectionUrl ? introspectionUrl : spec.introspection
     const {graphQLSchema, jsonSchema} = fetchSchema(graphUrl, headers)
 
     // parse URL

bin/dociql.js

@@ -25,6 +25,7 @@ program.version(package.version)
     .option('-l, --logo-file <file>', 'specify a custom logo file (default: null)', String, null)
     .option('-c, --config-file <file>', 'specify a custom configuration file (default: app/lib/config.js)')
     .option('-H, --header <header>', 'specify a custom auth token for the header (default: none)')
+    .option('-u, --introspection-url <url>', 'specify a custom url to use for introspection (default: none)')
     .option('-q, --quiet', 'Silence the output from the generator (default: false)')
     // .option('-f, --spec-file <file>', 'the input OpenAPI/Swagger spec file (default: test/fixtures/petstore.json)', String, 'test/fixtures/petstore.json')
     .parse(process.argv)

index.js

@@ -54,7 +54,7 @@ module.exports = function (options) {
 
     function loadData() {
         var specPath = path.resolve(opts.specFile)
-        var specData = require(path.resolve(opts.appDir + '/dociql/index'))(specPath, opts.header)
+        var specData = require(path.resolve(opts.appDir + '/dociql/index'))(specPath, opts.header, opts.introspectionUrl)
         return require(path.resolve(opts.appDir + '/lib/preprocessor'))(options, specData)
     }