docql - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

docql-node/docql.js

@@ -27,2 +27,6 @@ #!/usr/bin/env node
 
+    async readFile(path) {
+        return await fs.readFile(path, { encoding: 'utf8' })
+    }
+
     async prepareOutputDirectory(output) {
@@ -29,0 +33,0 @@ await fs.mkdir(output, { recursive: true })

docql-node/pkg/docql_node.js

@@ -202,3 +202,3 @@ let imports = {};
 
-function __wbg_adapter_58(arg0, arg1, arg2, arg3) {
+function __wbg_adapter_60(arg0, arg1, arg2, arg3) {
     wasm.wasm_bindgen__convert__closures__invoke2_mut__h531e099b33746cbb(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
@@ -240,15 +240,20 @@ }
 
-module.exports.__wbindgen_is_undefined = function(arg0) {
-    var ret = getObject(arg0) === undefined;
-    return ret;
-};
+module.exports.__wbg_writeFile_3b26d5a709504f5c = handleError(function(arg0, arg1, arg2, arg3, arg4, arg5, arg6) {
+    try {
+        var ret = getObject(arg0).writeFile(getStringFromWasm0(arg1, arg2), getStringFromWasm0(arg3, arg4), getStringFromWasm0(arg5, arg6));
+        return addHeapObject(ret);
+    } finally {
+        wasm.__wbindgen_free(arg1, arg2);
+        wasm.__wbindgen_free(arg3, arg4);
+        wasm.__wbindgen_free(arg5, arg6);
+    }
+});
 
-module.exports.__wbindgen_is_null = function(arg0) {
-    var ret = getObject(arg0) === null;
-    return ret;
-};
-
-module.exports.__wbg_getArgs_bdf2df5c64bb4d39 = handleError(function(arg0) {
-    var ret = getObject(arg0).getArgs();
-    return addHeapObject(ret);
+module.exports.__wbg_readFile_7a9291e0a39a1f15 = handleError(function(arg0, arg1, arg2) {
+    try {
+        var ret = getObject(arg0).readFile(getStringFromWasm0(arg1, arg2));
+        return addHeapObject(ret);
+    } finally {
+        wasm.__wbindgen_free(arg1, arg2);
+    }
 });
@@ -265,2 +270,7 @@
 
+module.exports.__wbg_getArgs_bdf2df5c64bb4d39 = handleError(function(arg0) {
+    var ret = getObject(arg0).getArgs();
+    return addHeapObject(ret);
+});
+
 module.exports.__wbg_date_fa50557d6c524b4e = handleError(function(arg0) {
@@ -271,13 +281,2 @@ var ret = getObject(arg0).date();
 
-module.exports.__wbg_writeFile_3b26d5a709504f5c = handleError(function(arg0, arg1, arg2, arg3, arg4, arg5, arg6) {
-    try {
-        var ret = getObject(arg0).writeFile(getStringFromWasm0(arg1, arg2), getStringFromWasm0(arg3, arg4), getStringFromWasm0(arg5, arg6));
-        return addHeapObject(ret);
-    } finally {
-        wasm.__wbindgen_free(arg1, arg2);
-        wasm.__wbindgen_free(arg3, arg4);
-        wasm.__wbindgen_free(arg5, arg6);
-    }
-});
-
 module.exports.__wbindgen_string_new = function(arg0, arg1) {
@@ -302,2 +301,12 @@ var ret = getStringFromWasm0(arg0, arg1);
 
+module.exports.__wbindgen_is_undefined = function(arg0) {
+    var ret = getObject(arg0) === undefined;
+    return ret;
+};
+
+module.exports.__wbindgen_is_null = function(arg0) {
+    var ret = getObject(arg0) === null;
+    return ret;
+};
+
 module.exports.__wbg_get_9ca243f6a0c3698a = function(arg0, arg1) {
@@ -350,3 +359,3 @@ var ret = getObject(arg0)[arg1 >>> 0];
             try {
-                return __wbg_adapter_58(a, state0.b, arg0, arg1);
+                return __wbg_adapter_60(a, state0.b, arg0, arg1);
             } finally {
@@ -417,4 +426,4 @@ state0.a = a;
 
-module.exports.__wbindgen_closure_wrapper353 = function(arg0, arg1, arg2) {
-    var ret = makeMutClosure(arg0, arg1, 181, __wbg_adapter_30);
+module.exports.__wbindgen_closure_wrapper420 = function(arg0, arg1, arg2) {
+    var ret = makeMutClosure(arg0, arg1, 182, __wbg_adapter_30);
     return addHeapObject(ret);
@@ -421,0 +430,0 @@ };

package.json

 {
   "name": "docql",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Generate static HTML documentation for GraphQL APIs.",
@@ -15,4 +15,4 @@ "main": "./docql-node/docql.js",
   "repository": {
-    "type" : "git",
-    "url" : "https://github.com/bryanburgers/docql.git"
+    "type": "git",
+    "url": "https://github.com/bryanburgers/docql.git"
   },
@@ -19,0 +19,0 @@ "dependencies": {

README.md

@@ -6,3 +6,4 @@ Generate static HTML documentation for GraphQL APIs.
 
-[GraphiQL] is great. So are tools like [Altair] and [Insomnia].
+[GraphiQL] is great. So are tools like [Altair] and [Insomnia]. But they aren't
+necessarily enough.
 
@@ -26,4 +27,4 @@ `docql` comes in when you want documentation for GraphQL APIs that lives in a
 [swapi]: https://swapi.graph.cool/
-[github v4 generated]:
-[swapi generated]:
+[github v4 generated]: https://bryanburgers.github.io/docql/github/
+[swapi generated]: https://bryanburgers.github.io/docql/swapi/
 
@@ -46,12 +47,6 @@
 
-If native binaries are more your style, each release comes with native binaries
-on the GitHub release page.
+If native binaries are more your style and you have access to [Rust]'s `cargo`,
+you can install with `cargo install`.
 
 ```
-docql -e $API -o ./doc
-```
-
-Or you can install your own from [crates.io] using [Rust]'s `cargo`.
-
-```
 cargo install docql
@@ -69,3 +64,3 @@ docql -e $API -o ./doc
 USAGE:
-    docql [OPTIONS] --endpoint <url> --output <path>
+    docql [OPTIONS] --output <path> <--endpoint <url>|--schema <path>>
 
@@ -82,2 +77,3 @@ FLAGS:
     -o, --output <path>         The directory to put the generated documentation
+    -s, --schema <path>         The output of a GraphQL introspection query already stored locally
 ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1626778

increased by4.23%

Lines of code

414

increased by2.73%

Worsened metrics

Number of lines in readme file

75

decreased by-5.06%

No dependency changes