apidoc2ts - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

dist/cli/index.js

@@ -19,3 +19,3 @@ "use strict";
         return __awaiter(this, void 0, void 0, function* () {
-            const { args, flags: passedFlags } = this.parse(Convert);
+            const { args, flags: passedFlags } = this.parse(undefined, Convert);
             return this.parseInput(passedFlags)
@@ -140,2 +140,2 @@ .then(({ builderOptions, runParameters }) => __awaiter(this, void 0, void 0, function* () {
 module.exports = Convert;
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

dist/core/ApiDoc2InterfaceBuilder.test.js

@@ -9,3 +9,3 @@ "use strict";
 jest.mock("./generator/InterfaceGenerator");
-jest.mock("./parser/ApiDocEndpointParser");
+jest.mock("./parser/ApiDocFieldsParser");
 jest.mock("./converter/ApiDocToInterfaceConverter");
@@ -54,2 +54,2 @@ jest.mock("./ApiDoc2Interface");
 });
-//# sourceMappingURL=ApiDoc2InterfaceBuilder.test.js.map
+//# sourceMappingURL=ApiDoc2InterfaceBuilder.test.js.map

dist/core/converter/ApiDocToInterfaceConverter.test.js

@@ -68,3 +68,3 @@ "use strict";
 };
-jest.mock("../parser/ApiDocEndpointParser");
+jest.mock("../parser/ApiDocFieldsParser");
 jest.mock("../generator/InterfaceGenerator");
@@ -112,3 +112,3 @@ const apiDocDataFull = [requestVersion1, requestVersion2, requestVersion3];
     }));
-    it("should call parseEndpoint with apiDoc data", () => __awaiter(this, void 0, void 0, function* () {
+    it("should call parse with apiDoc data", () => __awaiter(this, void 0, void 0, function* () {
         yield converter.convert([requestVersion1]);
@@ -136,3 +136,3 @@ expect(parseEndpointSpy).toBeCalledWith(requestVersion1);
     }));
-    it("should call parseEndpoint and createInterface for every endpoint", () => __awaiter(this, void 0, void 0, function* () {
+    it("should call parse and createInterface for every endpoint", () => __awaiter(this, void 0, void 0, function* () {
         yield converter.convert(apiDocDataFull);
@@ -172,2 +172,2 @@ expect(parseEndpointSpy).toBeCalledTimes(apiDocDataFull.length);
 });
-//# sourceMappingURL=ApiDocToInterfaceConverter.test.js.map
+//# sourceMappingURL=ApiDocToInterfaceConverter.test.js.map

dist/core/parser/ApiDocEndpointParser.js

@@ -101,2 +101,2 @@ "use strict";
 exports.ApiDocEndpointParser = ApiDocEndpointParser;
-//# sourceMappingURL=ApiDocEndpointParser.js.map
+//# sourceMappingURL=ApiDocFieldsParser.js.map

dist/core/parser/ApiDocEndpointParser.test.js

@@ -236,2 +236,2 @@ "use strict";
 });
-//# sourceMappingURL=ApiDocEndpointParser.test.js.map
+//# sourceMappingURL=ApiDocFieldsParser.test.js.map

package.json

 {
   "name": "apidoc2ts",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Typescript interface generator based on ApiDoc",
@@ -44,5 +44,6 @@ "bin": {
     "@oclif/plugin-help": "^2.2.0",
+    "chalk": "^2.4.2",
+    "lodash": "^4.17.14",
+    "make-dir": "^3.0.0",
     "quicktype-core": "^6.0.44",
-    "lodash": "^4.17.14",
-    "chalk": "^2.4.2",
     "tslib": "^1.10.0"
@@ -49,0 +50,0 @@ },

README.md

@@ -34,3 +34,3 @@ # apiDoc to Interfaces
 * `-s --source` - path to the `api_data.json` file from apiDoc
-* `-o --output` - path to the output folder
+* `-o --output` - path to the output folder (default `./`)
 * `-n --name` - name for the file with generated interfaces 
@@ -47,2 +47,4 @@
 * `-t --custom-types` - list of custom types that should not be replaced with strings
+* `-w --whitelist` - list of endpoints names which should be processed, the rest of endpoints will be ignored
+* `-e --parse-examples` - if example requests/responses should be parsed if no parameters are specified
 
@@ -49,0 +51,0 @@ Prefixes/postfixes for top-level interfaces names:

src/cli/index.ts

@@ -52,2 +52,14 @@ import {Command, flags} from "@oclif/command";
         }),
+        whitelist: flags.string({
+            char: "w",
+            multiple: true,
+            description: "Specify list of endpoints names which should be processed",
+            exclusive: ["config"],
+        }),
+        ["parse-examples"]: flags.boolean({
+            char: "e",
+            default: false,
+            description: "Parse endpoint examples if it has no parameters",
+            exclusive: ["config"],
+        }),
         ["custom-types"]: flags.string({
@@ -54,0 +66,0 @@ char: "t",

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

160529

increased by0.43%

Lines of code

2108

increased by0.81%

Number of lines in readme file

84

increased by2.44%

Worsened metrics

Dependency count

8

increased by14.29%

Dependency changes

• + Addedmake-dir@^3.0.0

• + Addedmake-dir@3.1.0(transitive)

• + Addedsemver@6.3.1(transitive)