nestjs-docfy 0.1.3 → 0.2.1
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/README.md +112 -32
- package/dist/cli/detect-project.d.ts +13 -0
- package/dist/cli/detect-project.js +318 -0
- package/dist/cli/detect-project.js.map +1 -0
- package/dist/cli/errors.d.ts +15 -0
- package/dist/cli/errors.js +26 -0
- package/dist/cli/errors.js.map +1 -0
- package/dist/cli/extract-methods.d.ts +34 -0
- package/dist/cli/extract-methods.js +171 -0
- package/dist/cli/extract-methods.js.map +1 -0
- package/dist/cli/generate-file.d.ts +11 -0
- package/dist/cli/generate-file.js +144 -0
- package/dist/cli/generate-file.js.map +1 -0
- package/dist/cli/index.d.ts +2 -0
- package/dist/cli/index.js +130 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/cli/logger.d.ts +5 -0
- package/dist/cli/logger.js +48 -0
- package/dist/cli/logger.js.map +1 -0
- package/dist/cli/merge-docs.d.ts +19 -0
- package/dist/cli/merge-docs.js +87 -0
- package/dist/cli/merge-docs.js.map +1 -0
- package/dist/cli/parse-args.d.ts +42 -0
- package/dist/cli/parse-args.js +85 -0
- package/dist/cli/parse-args.js.map +1 -0
- package/dist/cli/project-types.d.ts +18 -0
- package/dist/cli/project-types.js +3 -0
- package/dist/cli/project-types.js.map +1 -0
- package/dist/cli/resolve-tsconfig.d.ts +5 -0
- package/dist/cli/resolve-tsconfig.js +39 -0
- package/dist/cli/resolve-tsconfig.js.map +1 -0
- package/dist/cli/scan-controllers.d.ts +24 -0
- package/dist/cli/scan-controllers.js +157 -0
- package/dist/cli/scan-controllers.js.map +1 -0
- package/dist/cli/writer.d.ts +25 -0
- package/dist/cli/writer.js +115 -0
- package/dist/cli/writer.js.map +1 -0
- package/dist/docs.d.ts +4 -4
- package/dist/docs.js.map +1 -1
- package/package.json +11 -2
package/dist/docs.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
type Constructor = new (...args: any[]) =>
|
|
2
|
-
export interface DocsConfig {
|
|
1
|
+
type Constructor<T = any> = new (...args: any[]) => T;
|
|
2
|
+
export interface DocsConfig<T = any> {
|
|
3
3
|
/** Class-level decorators (e.g. ApiTags). Applied to the constructor. */
|
|
4
4
|
classDecorators?: ClassDecorator[];
|
|
5
5
|
/** Method-level decorators keyed by method name. */
|
|
6
|
-
methods?: Record<
|
|
6
|
+
methods?: Partial<Record<keyof T, MethodDecorator[]>>;
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
9
|
* Applies Swagger decorators to a controller class from outside the class file.
|
|
@@ -21,5 +21,5 @@ export interface DocsConfig {
|
|
|
21
21
|
* },
|
|
22
22
|
* });
|
|
23
23
|
*/
|
|
24
|
-
export declare function docs(controllerClass: Constructor
|
|
24
|
+
export declare function docs<T>(controllerClass: Constructor<T>, config: DocsConfig<T>): void;
|
|
25
25
|
export {};
|
package/dist/docs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";;AAyBA,oBA2BC;AA3CD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,IAAI,
|
|
1
|
+
{"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";;AAyBA,oBA2BC;AA3CD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,IAAI,CAAI,eAA+B,EAAE,MAAqB;IAC5E,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3B,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;YAC/C,SAAS,CAAC,eAAe,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO;IAE5B,KAAK,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAkC,EAAE,CAAC;QACvG,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAChD,eAAe,CAAC,SAAS,EACzB,UAAU,CACX,CAAC;QAEF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,CAAC,IAAI,CACV,0BAA0B,UAAU,kBAAkB,eAAe,CAAC,IAAI,IAAI;gBAC5E,uCAAuC,CAC1C,CAAC;YACF,SAAS;QACX,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "nestjs-docfy",
|
|
3
|
-
"version": "0.1
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "Keep your NestJS controllers clean — Swagger docs live in a separate companion file by naming convention",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -14,8 +14,12 @@
|
|
|
14
14
|
"types": "./dist/testing.d.ts"
|
|
15
15
|
}
|
|
16
16
|
},
|
|
17
|
+
"bin": {
|
|
18
|
+
"nestjs-docfy": "dist/cli/index.js"
|
|
19
|
+
},
|
|
17
20
|
"files": [
|
|
18
|
-
"dist"
|
|
21
|
+
"dist",
|
|
22
|
+
"package.json"
|
|
19
23
|
],
|
|
20
24
|
"engines": {
|
|
21
25
|
"node": ">=16.0.0"
|
|
@@ -77,5 +81,10 @@
|
|
|
77
81
|
"ts-jest": "^29.2.5",
|
|
78
82
|
"ts-node": "^10.9.2",
|
|
79
83
|
"typescript": "^5.7.3"
|
|
84
|
+
},
|
|
85
|
+
"dependencies": {
|
|
86
|
+
"commander": "^15.0.0",
|
|
87
|
+
"picocolors": "^1.1.1",
|
|
88
|
+
"ts-morph": "^28.0.0"
|
|
80
89
|
}
|
|
81
90
|
}
|