nestjs-docfy 0.2.0 → 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.
|
@@ -26,6 +26,16 @@ function sanitizeHttpPath(value) {
|
|
|
26
26
|
return '/' + value.replace(/[^a-zA-Z0-9/_:.-]/g, '');
|
|
27
27
|
}
|
|
28
28
|
// ---------------------------------------------------------------------------
|
|
29
|
+
// HTTP verb → default success status code
|
|
30
|
+
// ---------------------------------------------------------------------------
|
|
31
|
+
function defaultStatusCode(httpDecorator) {
|
|
32
|
+
switch (httpDecorator) {
|
|
33
|
+
case 'Post': return 201;
|
|
34
|
+
case 'Delete': return 204;
|
|
35
|
+
default: return 200; // Get, Put, Patch, Head, Options, All
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
// ---------------------------------------------------------------------------
|
|
29
39
|
// Import path resolution
|
|
30
40
|
// ---------------------------------------------------------------------------
|
|
31
41
|
/**
|
|
@@ -35,7 +45,6 @@ function sanitizeHttpPath(value) {
|
|
|
35
45
|
function relativeImport(docsFilePath, controllerFilePath) {
|
|
36
46
|
const rel = path_1.default.relative(path_1.default.dirname(docsFilePath), controllerFilePath);
|
|
37
47
|
const withoutExt = rel.replace(/\.ts$/, '');
|
|
38
|
-
// Ensure it starts with ./ for Node module resolution
|
|
39
48
|
return withoutExt.startsWith('.') ? withoutExt : `./${withoutExt}`;
|
|
40
49
|
}
|
|
41
50
|
// ---------------------------------------------------------------------------
|
|
@@ -62,14 +71,20 @@ function methodSignatureComment(m) {
|
|
|
62
71
|
function renderMethod(m, indent) {
|
|
63
72
|
const name = sanitizeIdentifier(m.name, '_method');
|
|
64
73
|
const sig = methodSignatureComment(m);
|
|
74
|
+
const status = defaultStatusCode(m.httpDecorator);
|
|
65
75
|
const lines = [];
|
|
66
76
|
lines.push(`${indent}// ${sig}`);
|
|
67
77
|
lines.push(`${indent}${name}: [`);
|
|
68
|
-
lines.push(`${indent}
|
|
69
|
-
lines.push(`${indent}
|
|
78
|
+
lines.push(`${indent} ApiOperation({ summary: '' }),`);
|
|
79
|
+
lines.push(`${indent} ApiResponse({ status: ${status} }),`);
|
|
70
80
|
lines.push(`${indent}],`);
|
|
71
81
|
return lines.join('\n');
|
|
72
82
|
}
|
|
83
|
+
function apiTagValue(ctrl) {
|
|
84
|
+
if (ctrl.controllerPath)
|
|
85
|
+
return sanitizeComment(ctrl.controllerPath);
|
|
86
|
+
return sanitizeComment(ctrl.className.replace(/Controller$/, '').toLowerCase());
|
|
87
|
+
}
|
|
73
88
|
/**
|
|
74
89
|
* Renders a complete .controller.docs.ts file for the given controller.
|
|
75
90
|
* All user-sourced values are sanitised before interpolation.
|
|
@@ -81,20 +96,22 @@ function renderDocsFile(ctrl, docsFilePath, format) {
|
|
|
81
96
|
? ` (route: "${sanitizeHttpPath(ctrl.controllerPath)}")`
|
|
82
97
|
: '';
|
|
83
98
|
const timestamp = new Date().toISOString();
|
|
99
|
+
const tag = apiTagValue(ctrl);
|
|
84
100
|
const methodsBlock = ctrl.methods.length === 0
|
|
85
101
|
? ' // No public HTTP methods found.'
|
|
86
102
|
: ctrl.methods.map((m) => renderMethod(m, ' ')).join('\n\n');
|
|
87
103
|
if (format === 'js') {
|
|
88
104
|
return [
|
|
89
|
-
`// Auto-generated by nestjs-docfy
|
|
105
|
+
`// Auto-generated by nestjs-docfy`,
|
|
90
106
|
`// Generated: ${timestamp}`,
|
|
91
107
|
``,
|
|
92
108
|
`const { docs } = require('nestjs-docfy');`,
|
|
109
|
+
`const { ApiTags, ApiOperation, ApiResponse } = require('@nestjs/swagger');`,
|
|
93
110
|
`const { ${className} } = require('${importPath}');`,
|
|
94
111
|
``,
|
|
95
112
|
`docs(${className}, {`,
|
|
96
113
|
` classDecorators: [`,
|
|
97
|
-
`
|
|
114
|
+
` ApiTags('${tag}'),`,
|
|
98
115
|
` ],`,
|
|
99
116
|
` methods: {`,
|
|
100
117
|
methodsBlock.split('\n').map((l) => (l ? ` ${l}` : l)).join('\n'),
|
|
@@ -105,7 +122,7 @@ function renderDocsFile(ctrl, docsFilePath, format) {
|
|
|
105
122
|
}
|
|
106
123
|
return [
|
|
107
124
|
`/**`,
|
|
108
|
-
` * Auto-generated by nestjs-docfy
|
|
125
|
+
` * Auto-generated by nestjs-docfy`,
|
|
109
126
|
` * Controller: ${className}${controllerRoute}`,
|
|
110
127
|
` * Generated: ${timestamp}`,
|
|
111
128
|
` */`,
|
|
@@ -115,7 +132,7 @@ function renderDocsFile(ctrl, docsFilePath, format) {
|
|
|
115
132
|
``,
|
|
116
133
|
`docs(${className}, {`,
|
|
117
134
|
` classDecorators: [`,
|
|
118
|
-
`
|
|
135
|
+
` ApiTags('${tag}'),`,
|
|
119
136
|
` ],`,
|
|
120
137
|
` methods: {`,
|
|
121
138
|
methodsBlock,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate-file.js","sourceRoot":"","sources":["../../src/cli/generate-file.ts"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"generate-file.js","sourceRoot":"","sources":["../../src/cli/generate-file.ts"],"names":[],"mappings":";;;;;AA8CA,wCAIC;AAkDD,wCA0DC;AA9JD,gDAAwB;AAGxB,8EAA8E;AAC9E,qEAAqE;AACrE,iEAAiE;AACjE,8EAA8E;AAE9E,8DAA8D;AAC9D,MAAM,aAAa,GAAG,4BAA4B,CAAC;AAEnD,SAAS,kBAAkB,CAAC,KAAa,EAAE,QAAgB;IACzD,OAAO,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AACtD,CAAC;AAED,oFAAoF;AACpF,SAAS,eAAe,CAAC,KAAa;IACpC,OAAO,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AACtD,CAAC;AAED,6DAA6D;AAC7D,SAAS,gBAAgB,CAAC,KAAoB;IAC5C,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,OAAO,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;AACvD,CAAC;AAED,8EAA8E;AAC9E,0CAA0C;AAC1C,8EAA8E;AAE9E,SAAS,iBAAiB,CAAC,aAA4B;IACrD,QAAQ,aAAa,EAAE,CAAC;QACtB,KAAK,MAAM,CAAC,CAAG,OAAO,GAAG,CAAC;QAC1B,KAAK,QAAQ,CAAC,CAAC,OAAO,GAAG,CAAC;QAC1B,OAAO,CAAC,CAAO,OAAO,GAAG,CAAC,CAAC,sCAAsC;IACnE,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,yBAAyB;AACzB,8EAA8E;AAE9E;;;GAGG;AACH,SAAgB,cAAc,CAAC,YAAoB,EAAE,kBAA0B;IAC7E,MAAM,GAAG,GAAG,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC1E,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC5C,OAAO,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;AACrE,CAAC;AAED,8EAA8E;AAC9E,2BAA2B;AAC3B,8EAA8E;AAE9E,SAAS,sBAAsB,CAAC,CAAa;IAC3C,MAAM,IAAI,GAAG,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,MAAM,QAAQ,GAAG,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,MAAM,KAAK,GAAG,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,QAAQ,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM;SACvB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;SAC5E,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,MAAM,UAAU,GAAG,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IACjD,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9C,MAAM,UAAU,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,aAAa;QAChD,CAAC,CAAC,oBAAoB,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG;QACzD,CAAC,CAAC,EAAE,CAAC;IACP,OAAO,GAAG,KAAK,GAAG,WAAW,GAAG,UAAU,IAAI,SAAS,MAAM,UAAU,GAAG,SAAS,EAAE,CAAC;AACxF,CAAC;AAED,8EAA8E;AAC9E,WAAW;AACX,8EAA8E;AAE9E,SAAS,YAAY,CAAC,CAAa,EAAE,MAAc;IACjD,MAAM,IAAI,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACnD,MAAM,GAAG,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;IAClD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC;IACjC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,KAAK,CAAC,CAAC;IAClC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,kCAAkC,CAAC,CAAC;IACxD,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,2BAA2B,MAAM,MAAM,CAAC,CAAC;IAC7D,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,CAAC,CAAC;IAC1B,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,WAAW,CAAC,IAAoB;IACvC,IAAI,IAAI,CAAC,cAAc;QAAE,OAAO,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACrE,OAAO,eAAe,CACpB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CACxD,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,cAAc,CAC5B,IAAoB,EACpB,YAAoB,EACpB,MAAmB;IAEnB,MAAM,UAAU,GAAG,cAAc,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/D,MAAM,SAAS,GAAG,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACnE,MAAM,eAAe,GAAG,IAAI,CAAC,cAAc,KAAK,IAAI;QAClD,CAAC,CAAC,aAAa,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI;QACxD,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC3C,MAAM,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAE9B,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;QAC5C,CAAC,CAAC,oCAAoC;QACtC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEhE,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO;YACL,mCAAmC;YACnC,iBAAiB,SAAS,EAAE;YAC5B,EAAE;YACF,2CAA2C;YAC3C,4EAA4E;YAC5E,WAAW,SAAS,iBAAiB,UAAU,KAAK;YACpD,EAAE;YACF,QAAQ,SAAS,KAAK;YACtB,sBAAsB;YACtB,gBAAgB,GAAG,KAAK;YACxB,MAAM;YACN,cAAc;YACd,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAClE,MAAM;YACN,KAAK;YACL,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;IAED,OAAO;QACL,KAAK;QACL,mCAAmC;QACnC,kBAAkB,SAAS,GAAG,eAAe,EAAE;QAC/C,iBAAiB,SAAS,EAAE;QAC5B,KAAK;QACL,sCAAsC;QACtC,uEAAuE;QACvE,YAAY,SAAS,YAAY,UAAU,IAAI;QAC/C,EAAE;QACF,QAAQ,SAAS,KAAK;QACtB,sBAAsB;QACtB,gBAAgB,GAAG,KAAK;QACxB,MAAM;QACN,cAAc;QACd,YAAY;QACZ,MAAM;QACN,KAAK;QACL,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC"}
|
package/package.json
CHANGED