@visulima/jsdoc-open-api 3.0.0-alpha.8 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +440 -0
- package/LICENSE.md +34 -0
- package/README.md +44 -33
- package/bin/index.js +12 -9
- package/dist/cli/commander/index.d.ts +1000 -2
- package/dist/cli/commander/index.js +1 -0
- package/dist/cli/index.d.ts +9 -2
- package/dist/cli/index.js +1 -0
- package/dist/index.d.ts +266 -7
- package/dist/index.js +1 -0
- package/dist/packem_shared/DEFAULT_OPTIONS-C7o6qjwP.js +1 -0
- package/dist/packem_shared/SpecBuilder-Vbq42UbW.js +1 -0
- package/dist/packem_shared/SwaggerCompilerPlugin-PUOALp2i.js +1 -0
- package/dist/packem_shared/constants-CdEv9ZcD.js +1 -0
- package/dist/packem_shared/customizer-BXFVpImq.js +1 -0
- package/dist/packem_shared/generateCommand-C_XPsbS6.js +5 -0
- package/dist/packem_shared/generateCommand-ClL9Mnc3.js +1 -0
- package/dist/packem_shared/initCommand-Ca1hGdYS.js +35 -0
- package/dist/packem_shared/initCommand-TixxsVQU.js +1 -0
- package/dist/packem_shared/jsDocumentCommentsToOpenApi-TjPhUj5G.js +1 -0
- package/dist/packem_shared/loadDefinition-7r9qpfuE.js +1 -0
- package/dist/packem_shared/parseFile-RDlR4tEF.js +1 -0
- package/dist/packem_shared/swaggerJsDocumentCommentsToOpenApi-Bm9R1BnW.js +10 -0
- package/dist/packem_shared/validate-9Rwe2A3r.js +1 -0
- package/dist/packem_shared/yamlLoc-DPq-xUM4.js +1 -0
- package/package.json +23 -43
- package/dist/cli/command/generate-command.d.cts +0 -7
- package/dist/cli/command/generate-command.d.mts +0 -7
- package/dist/cli/command/generate-command.d.ts +0 -7
- package/dist/cli/command/init-command.d.cts +0 -2
- package/dist/cli/command/init-command.d.mts +0 -2
- package/dist/cli/command/init-command.d.ts +0 -2
- package/dist/cli/commander/command/generate-command.d.cts +0 -3
- package/dist/cli/commander/command/generate-command.d.mts +0 -3
- package/dist/cli/commander/command/generate-command.d.ts +0 -3
- package/dist/cli/commander/command/init-command.d.cts +0 -3
- package/dist/cli/commander/command/init-command.d.mts +0 -3
- package/dist/cli/commander/command/init-command.d.ts +0 -3
- package/dist/cli/commander/index.cjs +0 -11
- package/dist/cli/commander/index.d.cts +0 -2
- package/dist/cli/commander/index.d.mts +0 -2
- package/dist/cli/commander/index.mjs +0 -2
- package/dist/cli/index.cjs +0 -11
- package/dist/cli/index.d.cts +0 -2
- package/dist/cli/index.d.mts +0 -2
- package/dist/cli/index.mjs +0 -2
- package/dist/constants.d.cts +0 -1
- package/dist/constants.d.mts +0 -1
- package/dist/constants.d.ts +0 -1
- package/dist/exported.d.cts +0 -198
- package/dist/exported.d.mts +0 -198
- package/dist/exported.d.ts +0 -198
- package/dist/index.cjs +0 -19
- package/dist/index.d.cts +0 -7
- package/dist/index.d.mts +0 -7
- package/dist/index.mjs +0 -6
- package/dist/jsdoc/comments-to-open-api.d.cts +0 -6
- package/dist/jsdoc/comments-to-open-api.d.mts +0 -6
- package/dist/jsdoc/comments-to-open-api.d.ts +0 -6
- package/dist/packem_shared/SpecBuilder-B7YiF7zR.mjs +0 -61
- package/dist/packem_shared/SpecBuilder-CCESkmm5.cjs +0 -63
- package/dist/packem_shared/SwaggerCompilerPlugin-BkYJzU4f.cjs +0 -88
- package/dist/packem_shared/SwaggerCompilerPlugin-DZ7tIJ8x.mjs +0 -86
- package/dist/packem_shared/customizer-CoMXMU7a.mjs +0 -8
- package/dist/packem_shared/customizer-DDFwFqJl.cjs +0 -10
- package/dist/packem_shared/generateCommand-DRMkfIle.mjs +0 -15
- package/dist/packem_shared/generateCommand-MwnCNgEE.cjs +0 -82
- package/dist/packem_shared/generateCommand-RY4QFtm7.cjs +0 -17
- package/dist/packem_shared/generateCommand-a9_RAbug.mjs +0 -80
- package/dist/packem_shared/initCommand-B6Z9EXHP.mjs +0 -15
- package/dist/packem_shared/initCommand-Ch-72dKZ.cjs +0 -65
- package/dist/packem_shared/initCommand-D3yVEMwO.cjs +0 -17
- package/dist/packem_shared/initCommand-zE4VRDGW.mjs +0 -63
- package/dist/packem_shared/jsDocumentCommentsToOpenApi-C7yMeXJ5.cjs +0 -337
- package/dist/packem_shared/jsDocumentCommentsToOpenApi-DtrIZ2lK.mjs +0 -331
- package/dist/packem_shared/parseFile-BE-sKiRK.mjs +0 -35
- package/dist/packem_shared/parseFile-Dk7Bw7lt.cjs +0 -42
- package/dist/packem_shared/swaggerJsDocumentCommentsToOpenApi-B7g9rVr5.mjs +0 -131
- package/dist/packem_shared/swaggerJsDocumentCommentsToOpenApi-BuB7eE94.cjs +0 -138
- package/dist/packem_shared/validate-DZHaKH07.mjs +0 -30
- package/dist/packem_shared/validate-FKieC3ln.cjs +0 -37
- package/dist/packem_shared/yamlLoc-C7iHWvdq.mjs +0 -14
- package/dist/packem_shared/yamlLoc-CEvBiR4K.cjs +0 -16
- package/dist/parse-file.d.cts +0 -9
- package/dist/parse-file.d.mts +0 -9
- package/dist/parse-file.d.ts +0 -9
- package/dist/spec-builder.d.cts +0 -14
- package/dist/spec-builder.d.mts +0 -14
- package/dist/spec-builder.d.ts +0 -14
- package/dist/swagger-jsdoc/comments-to-open-api.d.cts +0 -6
- package/dist/swagger-jsdoc/comments-to-open-api.d.mts +0 -6
- package/dist/swagger-jsdoc/comments-to-open-api.d.ts +0 -6
- package/dist/swagger-jsdoc/organize-swagger-object.d.cts +0 -7
- package/dist/swagger-jsdoc/organize-swagger-object.d.mts +0 -7
- package/dist/swagger-jsdoc/organize-swagger-object.d.ts +0 -7
- package/dist/swagger-jsdoc/utils.d.cts +0 -22
- package/dist/swagger-jsdoc/utils.d.mts +0 -22
- package/dist/swagger-jsdoc/utils.d.ts +0 -22
- package/dist/util/customizer.d.cts +0 -2
- package/dist/util/customizer.d.mts +0 -2
- package/dist/util/customizer.d.ts +0 -2
- package/dist/util/object-merge.d.cts +0 -2
- package/dist/util/object-merge.d.mts +0 -2
- package/dist/util/object-merge.d.ts +0 -2
- package/dist/util/yaml-loc.d.cts +0 -2
- package/dist/util/yaml-loc.d.mts +0 -2
- package/dist/util/yaml-loc.d.ts +0 -2
- package/dist/validate.d.cts +0 -2
- package/dist/validate.d.mts +0 -2
- package/dist/validate.d.ts +0 -2
- package/dist/webpack/swagger-compiler-plugin.d.cts +0 -15
- package/dist/webpack/swagger-compiler-plugin.d.mts +0 -15
- package/dist/webpack/swagger-compiler-plugin.d.ts +0 -15
package/bin/index.js
CHANGED
|
@@ -1,24 +1,27 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
import { readFileSync } from "node:fs";
|
|
4
|
+
import { argv, exit } from "node:process";
|
|
5
|
+
import { fileURLToPath } from "node:url";
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
// eslint-disable-next-line import/no-extraneous-dependencies -- commander is an optional CLI dependency; the bin only runs when a consumer has installed it
|
|
8
|
+
import { Command } from "commander";
|
|
8
9
|
|
|
9
|
-
// eslint-disable-next-line no-
|
|
10
|
-
|
|
10
|
+
// eslint-disable-next-line antfu/no-import-dist -- bin entry point loads the built ESM dist after build
|
|
11
|
+
import { generateCommand, initCommand } from "../dist/cli/commander/index.js";
|
|
12
|
+
|
|
13
|
+
const { version } = JSON.parse(readFileSync(fileURLToPath(new URL("../package.json", import.meta.url)), "utf8"));
|
|
11
14
|
|
|
12
15
|
const program = new Command();
|
|
13
16
|
|
|
14
|
-
program.name("@visulima/jsdoc-open-api").description("CLI to generate OpenAPI (Swagger) documentation from JSDoc's").version(
|
|
17
|
+
program.name("@visulima/jsdoc-open-api").description("CLI to generate OpenAPI (Swagger) documentation from JSDoc's").version(version);
|
|
15
18
|
|
|
16
19
|
initCommand(program);
|
|
17
20
|
generateCommand(program);
|
|
18
21
|
|
|
19
|
-
program.parse(
|
|
22
|
+
program.parse(argv);
|
|
20
23
|
|
|
21
|
-
if (
|
|
24
|
+
if (argv.slice(2).length === 0) {
|
|
22
25
|
program.help();
|
|
23
26
|
exit(1);
|
|
24
27
|
}
|