@rsdk/cli.cmd.autodoc 6.0.0-next.1 → 6.0.0-next.11
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 +382 -0
- package/TODO.MD +24 -0
- package/dist/commands/autodoc.cmd.js +8 -10
- package/dist/commands/autodoc.cmd.js.map +1 -1
- package/dist/commands/openapi.variation.d.ts +2 -1
- package/dist/commands/openapi.variation.js +47 -25
- package/dist/commands/openapi.variation.js.map +1 -1
- package/dist/generators/file-generator.interface.d.ts +1 -1
- package/dist/generators/openapi-json/config.schema.d.ts +55 -0
- package/dist/generators/openapi-json/config.schema.js +36 -0
- package/dist/generators/openapi-json/config.schema.js.map +1 -0
- package/dist/generators/openapi-json/index.d.ts +1 -0
- package/dist/generators/openapi-json/index.js +1 -0
- package/dist/generators/openapi-json/index.js.map +1 -1
- package/dist/generators/openapi-json/openapi-json.generator.d.ts +9 -11
- package/dist/generators/openapi-json/openapi-json.generator.js +12 -89
- package/dist/generators/openapi-json/openapi-json.generator.js.map +1 -1
- package/dist/generators/openapi-json/schemas/config.schema.d.ts +55 -0
- package/dist/generators/openapi-json/schemas/config.schema.js +36 -0
- package/dist/generators/openapi-json/schemas/config.schema.js.map +1 -0
- package/dist/generators/openapi-json/schemas/index.d.ts +1 -0
- package/dist/generators/openapi-json/schemas/index.js +18 -0
- package/dist/generators/openapi-json/schemas/index.js.map +1 -0
- package/jest.config.e2e.js +1 -0
- package/jest.config.js +1 -0
- package/jest.config.unit.js +1 -0
- package/package.json +15 -27
- package/src/base/app.loader.ts +39 -0
- package/src/base/document.file.ts +33 -0
- package/src/base/index.ts +2 -0
- package/src/commands/autodoc.cmd.ts +93 -0
- package/src/commands/openapi.variation.ts +172 -0
- package/src/generators/autodoc-md/autodoc-md.generator.ts +56 -0
- package/src/generators/autodoc-md/formatters.ts +9 -0
- package/src/generators/autodoc-md/fragments/document-fragment.abstract.ts +6 -0
- package/src/generators/autodoc-md/fragments/extractor/document.extractor.ts +73 -0
- package/src/generators/autodoc-md/fragments/implementations/additional-sources.fragment.ts +41 -0
- package/src/generators/autodoc-md/fragments/implementations/app-metadata.fragment.ts +18 -0
- package/src/generators/autodoc-md/fragments/implementations/autodoc.fragment.ts +30 -0
- package/src/generators/autodoc-md/fragments/implementations/config-section.fragment.ts +148 -0
- package/src/generators/autodoc-md/fragments/implementations/header.fragment.ts +18 -0
- package/src/generators/autodoc-md/fragments/implementations/plugin.fragment.ts +21 -0
- package/src/generators/autodoc-md/fragments/implementations/transports.fragment.ts +36 -0
- package/src/generators/autodoc-md/fragments/index.ts +9 -0
- package/src/generators/autodoc-md/index.ts +1 -0
- package/src/generators/file-generator.interface.ts +22 -0
- package/src/generators/index.ts +4 -0
- package/src/generators/openapi-json/config.schema.spec.ts +265 -0
- package/src/generators/openapi-json/config.schema.ts +37 -0
- package/src/generators/openapi-json/index.ts +2 -0
- package/src/generators/openapi-json/openapi-json.generator.ts +53 -0
- package/src/generators/openapi-json/schemas/config.schema.spec.ts +265 -0
- package/src/generators/openapi-json/schemas/config.schema.ts +37 -0
- package/src/generators/openapi-json/schemas/index.ts +1 -0
- package/src/generators/rsdk-json/index.ts +1 -0
- package/src/generators/rsdk-json/rsdk-json.generator.ts +24 -0
- package/src/index.ts +1 -0
- package/tsconfig.build.json +12 -0
- package/tsconfig.json +7 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,382 @@
|
|
|
1
|
+
# Change Log
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
|
+
|
|
6
|
+
## [5.6.0](https://github.com/R-Vision/rsdk/compare/v5.6.0-next.7...v5.6.0) (2025-01-20)
|
|
7
|
+
|
|
8
|
+
## [5.4.0](https://github.com/R-Vision/rsdk/compare/v5.4.0-rc.1...v5.4.0) (2024-12-15)
|
|
9
|
+
|
|
10
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
11
|
+
|
|
12
|
+
## [5.4.0](https://github.com/R-Vision/rsdk/compare/v5.3.0...v5.4.0) (2024-12-15)
|
|
13
|
+
|
|
14
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
15
|
+
|
|
16
|
+
## [5.4.0-rc.0](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.11...v5.4.0-rc.0) (2024-12-12)
|
|
17
|
+
|
|
18
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
19
|
+
|
|
20
|
+
## [5.4.0-next.11](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.10...v5.4.0-next.11) (2024-12-04)
|
|
21
|
+
|
|
22
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
23
|
+
|
|
24
|
+
## [5.4.0-next.10](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.9...v5.4.0-next.10) (2024-12-03)
|
|
25
|
+
|
|
26
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
27
|
+
|
|
28
|
+
## [5.4.0-next.9](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.8...v5.4.0-next.9) (2024-12-02)
|
|
29
|
+
|
|
30
|
+
## [5.3.1-rc.1](https://github.com/R-Vision/rsdk/compare/v5.3.1-rc.0...v5.3.1-rc.1) (2024-11-28)
|
|
31
|
+
|
|
32
|
+
## [5.3.1-rc.0](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.6...v5.3.1-rc.0) (2024-11-28)
|
|
33
|
+
|
|
34
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
35
|
+
|
|
36
|
+
## [5.4.0-next.8](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.7...v5.4.0-next.8) (2024-11-28)
|
|
37
|
+
|
|
38
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
39
|
+
|
|
40
|
+
## [5.4.0-next.7](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.6...v5.4.0-next.7) (2024-11-28)
|
|
41
|
+
|
|
42
|
+
### Features
|
|
43
|
+
|
|
44
|
+
* eslint rule lines-around-comment ([65083bd](https://github.com/R-Vision/rsdk/commit/65083bd2e084344e08f2124e39afbbc23fdaa4f4))
|
|
45
|
+
|
|
46
|
+
## [5.4.0-next.6](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.5...v5.4.0-next.6) (2024-11-28)
|
|
47
|
+
|
|
48
|
+
### Bug Fixes
|
|
49
|
+
|
|
50
|
+
* bump versions ([079d251](https://github.com/R-Vision/rsdk/commit/079d251965bdcb6d280f9162d898f776618f9e69))
|
|
51
|
+
|
|
52
|
+
## [5.4.0-next.5](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.4...v5.4.0-next.5) (2024-11-28)
|
|
53
|
+
|
|
54
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
55
|
+
|
|
56
|
+
## [5.4.0-next.4](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.3...v5.4.0-next.4) (2024-11-27)
|
|
57
|
+
|
|
58
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
59
|
+
|
|
60
|
+
## [5.4.0-next.3](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.2...v5.4.0-next.3) (2024-11-25)
|
|
61
|
+
|
|
62
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
63
|
+
|
|
64
|
+
## [5.4.0-next.2](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.1...v5.4.0-next.2) (2024-11-25)
|
|
65
|
+
|
|
66
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
67
|
+
|
|
68
|
+
## [5.4.0-next.1](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.0...v5.4.0-next.1) (2024-11-08)
|
|
69
|
+
|
|
70
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
71
|
+
|
|
72
|
+
## [5.4.0-next.0](https://github.com/R-Vision/rsdk/compare/v5.3.0...v5.4.0-next.0) (2024-11-08)
|
|
73
|
+
|
|
74
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
75
|
+
|
|
76
|
+
## [5.3.1-rc.1](https://github.com/R-Vision/rsdk/compare/v5.3.1-rc.0...v5.3.1-rc.1) (2024-11-28)
|
|
77
|
+
|
|
78
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
79
|
+
|
|
80
|
+
## [5.3.1-rc.0](https://github.com/R-Vision/rsdk/compare/v5.3.0...v5.3.1-rc.0) (2024-11-28)
|
|
81
|
+
|
|
82
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
83
|
+
|
|
84
|
+
## [5.3.0](https://github.com/R-Vision/rsdk/compare/v5.3.0-next.4...v5.3.0) (2024-11-08)
|
|
85
|
+
|
|
86
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
87
|
+
|
|
88
|
+
## [5.3.0-next.4](https://github.com/R-Vision/rsdk/compare/v5.3.0-next.3...v5.3.0-next.4) (2024-11-05)
|
|
89
|
+
|
|
90
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
91
|
+
|
|
92
|
+
## [5.3.0-next.3](https://github.com/R-Vision/rsdk/compare/v5.3.0-next.2...v5.3.0-next.3) (2024-11-01)
|
|
93
|
+
|
|
94
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
95
|
+
|
|
96
|
+
## [5.3.0-next.2](https://github.com/R-Vision/rsdk/compare/v5.3.0-next.1...v5.3.0-next.2) (2024-10-31)
|
|
97
|
+
|
|
98
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
99
|
+
|
|
100
|
+
## [5.3.0-next.1](https://github.com/R-Vision/rsdk/compare/v5.3.0-next.0...v5.3.0-next.1) (2024-10-29)
|
|
101
|
+
|
|
102
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
103
|
+
|
|
104
|
+
## [5.3.0-next.0](https://github.com/R-Vision/rsdk/compare/v5.2.1-next.2...v5.3.0-next.0) (2024-10-23)
|
|
105
|
+
|
|
106
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
107
|
+
|
|
108
|
+
## [5.2.1-next.2](https://github.com/R-Vision/rsdk/compare/v5.2.1-next.1...v5.2.1-next.2) (2024-10-21)
|
|
109
|
+
|
|
110
|
+
### Bug Fixes
|
|
111
|
+
|
|
112
|
+
* logging + otel ([#297](https://github.com/R-Vision/rsdk/issues/297)) ([3b06993](https://github.com/R-Vision/rsdk/commit/3b069936c6aaa0eb5285b82f079ffe435a38bbdc))
|
|
113
|
+
|
|
114
|
+
## [5.2.1-next.1](https://github.com/R-Vision/rsdk/compare/v5.2.1-next.0...v5.2.1-next.1) (2024-10-18)
|
|
115
|
+
|
|
116
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
117
|
+
|
|
118
|
+
## [5.2.1-next.0](https://github.com/R-Vision/rsdk/compare/v5.2.0...v5.2.1-next.0) (2024-10-18)
|
|
119
|
+
|
|
120
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
121
|
+
|
|
122
|
+
## [5.2.0](https://github.com/R-Vision/rsdk/compare/v5.2.0-next.1...v5.2.0) (2024-10-17)
|
|
123
|
+
|
|
124
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
125
|
+
|
|
126
|
+
## [5.2.0-next.1](https://github.com/R-Vision/rsdk/compare/v5.2.0-next.0...v5.2.0-next.1) (2024-10-09)
|
|
127
|
+
|
|
128
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
129
|
+
|
|
130
|
+
## [5.2.0-next.0](https://github.com/R-Vision/rsdk/compare/v5.1.0...v5.2.0-next.0) (2024-10-09)
|
|
131
|
+
|
|
132
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
133
|
+
|
|
134
|
+
## [5.1.0](https://github.com/R-Vision/rsdk/compare/v5.1.0-next.0...v5.1.0) (2024-09-03)
|
|
135
|
+
|
|
136
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
137
|
+
|
|
138
|
+
## [5.1.0-next.0](https://github.com/R-Vision/rsdk/compare/v5.0.5-next.0...v5.1.0-next.0) (2024-09-02)
|
|
139
|
+
|
|
140
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
141
|
+
|
|
142
|
+
## [5.0.5-next.0](https://github.com/R-Vision/rsdk/compare/v5.0.4...v5.0.5-next.0) (2024-08-19)
|
|
143
|
+
|
|
144
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
145
|
+
|
|
146
|
+
## [5.0.4](https://github.com/R-Vision/rsdk/compare/v5.0.4-next.0...v5.0.4) (2024-07-24)
|
|
147
|
+
|
|
148
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
149
|
+
|
|
150
|
+
## [5.0.4-next.0](https://github.com/R-Vision/rsdk/compare/v5.0.3...v5.0.4-next.0) (2024-07-24)
|
|
151
|
+
|
|
152
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
153
|
+
|
|
154
|
+
## [5.0.3](https://github.com/R-Vision/rsdk/compare/v5.0.3-next.0...v5.0.3) (2024-07-24)
|
|
155
|
+
|
|
156
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
157
|
+
|
|
158
|
+
## [5.0.3-next.0](https://github.com/R-Vision/rsdk/compare/v5.0.2...v5.0.3-next.0) (2024-07-23)
|
|
159
|
+
|
|
160
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
161
|
+
|
|
162
|
+
## [5.0.2](https://github.com/R-Vision/rsdk/compare/v5.0.2-next.1...v5.0.2) (2024-07-19)
|
|
163
|
+
|
|
164
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
165
|
+
|
|
166
|
+
## [5.0.2-next.1](https://github.com/R-Vision/rsdk/compare/v5.0.2-next.0...v5.0.2-next.1) (2024-07-19)
|
|
167
|
+
|
|
168
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
169
|
+
|
|
170
|
+
## [5.0.2-next.0](https://github.com/R-Vision/rsdk/compare/v5.0.1...v5.0.2-next.0) (2024-07-19)
|
|
171
|
+
|
|
172
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
173
|
+
|
|
174
|
+
## [5.0.1](https://github.com/R-Vision/rsdk/compare/v5.0.1-next.0...v5.0.1) (2024-07-19)
|
|
175
|
+
|
|
176
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
177
|
+
|
|
178
|
+
## [5.0.1-next.0](https://github.com/R-Vision/rsdk/compare/v5.0.0...v5.0.1-next.0) (2024-07-18)
|
|
179
|
+
|
|
180
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
181
|
+
|
|
182
|
+
## [5.0.0](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.6...v5.0.0) (2024-07-16)
|
|
183
|
+
|
|
184
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
185
|
+
|
|
186
|
+
## [5.0.0-next.6](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.5...v5.0.0-next.6) (2024-07-16)
|
|
187
|
+
|
|
188
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
189
|
+
|
|
190
|
+
## [5.0.0-next.5](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.4...v5.0.0-next.5) (2024-07-16)
|
|
191
|
+
|
|
192
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
193
|
+
|
|
194
|
+
## [5.0.0-next.4](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.3...v5.0.0-next.4) (2024-07-11)
|
|
195
|
+
|
|
196
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
197
|
+
|
|
198
|
+
## [5.0.0-next.3](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.2...v5.0.0-next.3) (2024-07-11)
|
|
199
|
+
|
|
200
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
201
|
+
|
|
202
|
+
## [5.0.0-next.2](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.1...v5.0.0-next.2) (2024-07-10)
|
|
203
|
+
|
|
204
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
205
|
+
|
|
206
|
+
## [5.0.0-next.1](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.0...v5.0.0-next.1) (2024-07-10)
|
|
207
|
+
|
|
208
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
209
|
+
|
|
210
|
+
## [5.0.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.11.2-next.0...v5.0.0-next.0) (2024-07-10)
|
|
211
|
+
|
|
212
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
213
|
+
|
|
214
|
+
## [4.11.2-next.0](https://github.com/R-Vision/rsdk/compare/v4.11.1...v4.11.2-next.0) (2024-07-05)
|
|
215
|
+
|
|
216
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
217
|
+
|
|
218
|
+
## [4.11.1](https://github.com/R-Vision/rsdk/compare/v4.11.0...v4.11.1) (2024-07-04)
|
|
219
|
+
|
|
220
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
221
|
+
|
|
222
|
+
## [4.11.0](https://github.com/R-Vision/rsdk/compare/v4.11.0-next.0...v4.11.0) (2024-07-04)
|
|
223
|
+
|
|
224
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
225
|
+
|
|
226
|
+
## [4.11.0-next.1](https://github.com/R-Vision/rsdk/compare/v4.11.0-next.0...v4.11.0-next.1) (2024-07-04)
|
|
227
|
+
|
|
228
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
229
|
+
|
|
230
|
+
## [4.11.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.10.2...v4.11.0-next.0) (2024-07-04)
|
|
231
|
+
|
|
232
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
233
|
+
|
|
234
|
+
## [4.10.2](https://github.com/R-Vision/rsdk/compare/v4.10.2-next.0...v4.10.2) (2024-07-03)
|
|
235
|
+
|
|
236
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
237
|
+
|
|
238
|
+
## [4.10.2-next.0](https://github.com/R-Vision/rsdk/compare/v4.10.1...v4.10.2-next.0) (2024-07-03)
|
|
239
|
+
|
|
240
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
241
|
+
|
|
242
|
+
## [4.10.1](https://github.com/R-Vision/rsdk/compare/v4.10.1-next.0...v4.10.1) (2024-07-03)
|
|
243
|
+
|
|
244
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
245
|
+
|
|
246
|
+
## [4.10.1-next.0](https://github.com/R-Vision/rsdk/compare/v4.10.0...v4.10.1-next.0) (2024-07-03)
|
|
247
|
+
|
|
248
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
249
|
+
|
|
250
|
+
## [4.10.0](https://github.com/R-Vision/rsdk/compare/v4.10.0-next.4...v4.10.0) (2024-06-11)
|
|
251
|
+
|
|
252
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
253
|
+
|
|
254
|
+
## [4.10.0-next.4](https://github.com/R-Vision/rsdk/compare/v4.10.0-next.3...v4.10.0-next.4) (2024-06-11)
|
|
255
|
+
|
|
256
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
257
|
+
|
|
258
|
+
## [4.10.0-next.3](https://github.com/R-Vision/rsdk/compare/v4.10.0-next.2...v4.10.0-next.3) (2024-06-10)
|
|
259
|
+
|
|
260
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
261
|
+
|
|
262
|
+
## [4.10.0-next.2](https://github.com/R-Vision/rsdk/compare/v4.10.0-next.1...v4.10.0-next.2) (2024-05-30)
|
|
263
|
+
|
|
264
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
265
|
+
|
|
266
|
+
## [4.10.0-next.1](https://github.com/R-Vision/rsdk/compare/v4.10.0-next.0...v4.10.0-next.1) (2024-05-30)
|
|
267
|
+
|
|
268
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
269
|
+
|
|
270
|
+
## [4.10.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.9.0...v4.10.0-next.0) (2024-05-30)
|
|
271
|
+
|
|
272
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
273
|
+
|
|
274
|
+
## [4.9.0](https://github.com/R-Vision/rsdk/compare/v4.9.0-next.0...v4.9.0) (2024-05-27)
|
|
275
|
+
|
|
276
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
277
|
+
|
|
278
|
+
## [4.9.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.8.1-next.2...v4.9.0-next.0) (2024-05-27)
|
|
279
|
+
|
|
280
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
281
|
+
|
|
282
|
+
## [4.8.1-next.2](https://github.com/R-Vision/rsdk/compare/v4.8.1-next.1...v4.8.1-next.2) (2024-05-02)
|
|
283
|
+
|
|
284
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
285
|
+
|
|
286
|
+
## [4.8.1-next.1](https://github.com/R-Vision/rsdk/compare/v4.8.1-next.0...v4.8.1-next.1) (2024-04-24)
|
|
287
|
+
|
|
288
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
289
|
+
|
|
290
|
+
## [4.8.1-next.0](https://github.com/R-Vision/rsdk/compare/v4.8.0...v4.8.1-next.0) (2024-04-24)
|
|
291
|
+
|
|
292
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
293
|
+
|
|
294
|
+
## [4.8.0](https://github.com/R-Vision/rsdk/compare/v4.8.0-next.1...v4.8.0) (2024-04-23)
|
|
295
|
+
|
|
296
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
297
|
+
|
|
298
|
+
## [4.8.0-next.1](https://github.com/R-Vision/rsdk/compare/v4.8.0-next.0...v4.8.0-next.1) (2024-04-23)
|
|
299
|
+
|
|
300
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
301
|
+
|
|
302
|
+
## [4.8.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.7.0...v4.8.0-next.0) (2024-04-23)
|
|
303
|
+
|
|
304
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
305
|
+
|
|
306
|
+
## [4.7.0](https://github.com/R-Vision/rsdk/compare/v4.7.0-next.0...v4.7.0) (2024-04-22)
|
|
307
|
+
|
|
308
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
309
|
+
|
|
310
|
+
## [4.7.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.6.0...v4.7.0-next.0) (2024-04-22)
|
|
311
|
+
|
|
312
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
313
|
+
|
|
314
|
+
## [4.6.0](https://github.com/R-Vision/rsdk/compare/v4.6.0-next.0...v4.6.0) (2024-04-22)
|
|
315
|
+
|
|
316
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
317
|
+
|
|
318
|
+
## [4.6.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.5.0...v4.6.0-next.0) (2024-04-22)
|
|
319
|
+
|
|
320
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
321
|
+
|
|
322
|
+
## [4.5.0](https://github.com/R-Vision/rsdk/compare/v4.5.0-next.1...v4.5.0) (2024-04-15)
|
|
323
|
+
|
|
324
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
325
|
+
|
|
326
|
+
## [4.5.0-next.1](https://github.com/R-Vision/rsdk/compare/v4.5.0-next.0...v4.5.0-next.1) (2024-04-15)
|
|
327
|
+
|
|
328
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
329
|
+
|
|
330
|
+
## [4.5.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.4.0...v4.5.0-next.0) (2024-04-15)
|
|
331
|
+
|
|
332
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
333
|
+
|
|
334
|
+
## [4.4.0](https://github.com/R-Vision/rsdk/compare/v4.4.0-next.1...v4.4.0) (2024-04-08)
|
|
335
|
+
|
|
336
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
337
|
+
|
|
338
|
+
## [4.4.0-next.1](https://github.com/R-Vision/rsdk/compare/v4.4.0-next.0...v4.4.0-next.1) (2024-03-27)
|
|
339
|
+
|
|
340
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
341
|
+
|
|
342
|
+
## [4.4.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.3.3-next.0...v4.4.0-next.0) (2024-03-27)
|
|
343
|
+
|
|
344
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
345
|
+
|
|
346
|
+
## [4.3.3-next.0](https://github.com/R-Vision/rsdk/compare/v4.3.2...v4.3.3-next.0) (2024-03-27)
|
|
347
|
+
|
|
348
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
349
|
+
|
|
350
|
+
## [4.3.2](https://github.com/R-Vision/rsdk/compare/v4.3.2-next.0...v4.3.2) (2024-03-26)
|
|
351
|
+
|
|
352
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
353
|
+
|
|
354
|
+
## [4.3.2-next.0](https://github.com/R-Vision/rsdk/compare/v4.3.1...v4.3.2-next.0) (2024-03-26)
|
|
355
|
+
|
|
356
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
357
|
+
|
|
358
|
+
## [4.3.1](https://github.com/R-Vision/rsdk/compare/v4.3.1-next.0...v4.3.1) (2024-03-25)
|
|
359
|
+
|
|
360
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
361
|
+
|
|
362
|
+
## [4.3.1-next.1](https://github.com/R-Vision/rsdk/compare/v4.3.1-next.0...v4.3.1-next.1) (2024-03-25)
|
|
363
|
+
|
|
364
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
365
|
+
|
|
366
|
+
## [4.3.1-next.0](https://github.com/R-Vision/rsdk/compare/v4.3.0...v4.3.1-next.0) (2024-03-25)
|
|
367
|
+
|
|
368
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
369
|
+
|
|
370
|
+
## [4.3.0](https://github.com/R-Vision/rsdk/compare/v4.3.0-next.1...v4.3.0) (2024-03-21)
|
|
371
|
+
|
|
372
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
373
|
+
|
|
374
|
+
## [4.3.0-next.1](https://github.com/R-Vision/rsdk/compare/v4.3.0-next.0...v4.3.0-next.1) (2024-03-21)
|
|
375
|
+
|
|
376
|
+
**Note:** Version bump only for package @rsdk/cli.cmd.autodoc
|
|
377
|
+
|
|
378
|
+
## [4.3.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.2.5-next.0...v4.3.0-next.0) (2024-03-19)
|
|
379
|
+
|
|
380
|
+
### Features
|
|
381
|
+
|
|
382
|
+
* reworked cli system ([745ebf5](https://github.com/R-Vision/rsdk/commit/745ebf53635de135a4a9083f47ce833efe2d4411))
|
package/TODO.MD
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
- [x] OpenApi
|
|
2
|
+
- [x] Группировка конфигурации по kind (`app`, `transport`, etc)
|
|
3
|
+
- [x] Документация по grpc вызовам
|
|
4
|
+
- Список серверов и сервисов к которым обращается приложение (ну или по крайней мере он их инжектит)
|
|
5
|
+
- Название сервера | Поле в конфигурации для хоста | Имя gpc сервиса который вызываем
|
|
6
|
+
- [ ] Publisher
|
|
7
|
+
- Список ивентов которые эмитим, top
|
|
8
|
+
- [x] HealthIndicator'ы, которые используются внутри приложения
|
|
9
|
+
- [x] Метрики, которые отдаёт приложения (кастомные)
|
|
10
|
+
- [x] Description, version, commit_sha
|
|
11
|
+
- [x] Генерация файла `rsdk.json` с данными из документации в сериализованном виде
|
|
12
|
+
- [x] Выводить у секций описание и имя класса и название класса
|
|
13
|
+
- [x] Escape на символы внутри в таблицы
|
|
14
|
+
- [x] Нормальный логгер
|
|
15
|
+
- [ ] Создать пакет в котором будут только инструменты по объявлению разделов документации, без лишних зависимостей
|
|
16
|
+
вроде `markdown-table`
|
|
17
|
+
- [ ] Отключить логирование приложения
|
|
18
|
+
- [x] Генерация openapi без запуска приложений
|
|
19
|
+
- Предварительная идея
|
|
20
|
+
- собирать все контроллеры
|
|
21
|
+
- создавать идентичный контроллер, но без зависимостей
|
|
22
|
+
- делать `OpenApiModule` куда складывать все такие контроллеры
|
|
23
|
+
- NestFactory.create(OpenApiModule)
|
|
24
|
+
- [ ] Учитывать `PlatformAppOptions` при генерации OpenApiSpec, на данный момент эти опции прокидываются в HttpTransport
|
|
@@ -18,18 +18,16 @@ const cli_common_1 = require("@rsdk/cli.common");
|
|
|
18
18
|
const common_node_1 = require("@rsdk/common.node");
|
|
19
19
|
const logging_1 = require("@rsdk/logging");
|
|
20
20
|
const zones_1 = require("@rsdk/zones");
|
|
21
|
-
const
|
|
22
|
-
const
|
|
23
|
-
const
|
|
24
|
-
const openapi_json_generator_1 = require("../generators/openapi-json/openapi-json.generator");
|
|
25
|
-
const rsdk_json_generator_1 = require("../generators/rsdk-json/rsdk-json.generator");
|
|
21
|
+
const base_1 = require("../base");
|
|
22
|
+
const base_2 = require("../base");
|
|
23
|
+
const generators_1 = require("../generators");
|
|
26
24
|
const openapi_variation_1 = require("./openapi.variation");
|
|
27
25
|
let AutodocCommand = AutodocCommand_1 = class AutodocCommand {
|
|
28
26
|
logger;
|
|
29
27
|
loader;
|
|
30
28
|
constructor() {
|
|
31
29
|
this.logger = logging_1.LoggerFactory.create(AutodocCommand_1);
|
|
32
|
-
this.loader = new
|
|
30
|
+
this.loader = new base_2.AppLoader(this.logger);
|
|
33
31
|
}
|
|
34
32
|
async run(verbose, ifPresent, openApi, outPath, appPath) {
|
|
35
33
|
if (verbose) {
|
|
@@ -42,11 +40,11 @@ let AutodocCommand = AutodocCommand_1 = class AutodocCommand {
|
|
|
42
40
|
return;
|
|
43
41
|
}
|
|
44
42
|
const documents = [
|
|
45
|
-
await new
|
|
46
|
-
await new
|
|
43
|
+
await new generators_1.RsdkFileGenerator(app).createFile('rsdk.json'),
|
|
44
|
+
await new generators_1.MarkdownDocsGenerator(app).createFile('autodoc.md'),
|
|
47
45
|
];
|
|
48
46
|
if (openApi) {
|
|
49
|
-
const generator = new
|
|
47
|
+
const generator = new generators_1.OpenApiFileGenerator(app, {
|
|
50
48
|
excludeZones: [zones_1.API_ZONE_INTERNAL],
|
|
51
49
|
});
|
|
52
50
|
const openApiDocument = await generator.createFile('openapi.json');
|
|
@@ -55,7 +53,7 @@ let AutodocCommand = AutodocCommand_1 = class AutodocCommand {
|
|
|
55
53
|
}
|
|
56
54
|
}
|
|
57
55
|
const [absolutePath] = common_node_1.Path.absolutize(outPath);
|
|
58
|
-
const writer = new
|
|
56
|
+
const writer = new base_1.DocumentWriter(this.logger, absolutePath);
|
|
59
57
|
await Promise.all(documents.map(async (doc) => {
|
|
60
58
|
await writer.write(doc);
|
|
61
59
|
}));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"autodoc.cmd.js","sourceRoot":"","sources":["../../src/commands/autodoc.cmd.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA2E;AAC3E,mDAAuD;AACvD,2CAAuD;AACvD,uCAAgD;AAEhD,
|
|
1
|
+
{"version":3,"file":"autodoc.cmd.js","sourceRoot":"","sources":["../../src/commands/autodoc.cmd.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA2E;AAC3E,mDAAuD;AACvD,2CAAuD;AACvD,uCAAgD;AAEhD,kCAA4D;AAC5D,kCAAoC;AACpC,8CAIuB;AAEvB,2DAAqD;AAM9C,IAAM,cAAc,sBAApB,MAAM,cAAc;IACR,MAAM,CAAU;IAChB,MAAM,CAAY;IAEnC;QACE,IAAI,CAAC,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,gBAAc,CAAC,CAAC;QACnD,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEK,AAAN,KAAK,CAAC,GAAG,CAEP,OAAgB,EAGhB,SAAkB,EAKlB,OAAgB,EAOhB,OAAe,EAOf,OAAe;QAEf,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,OAAO,EAAE,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,0BAA0B,OAAO,EAAE,CAAC,CAAC;YACtD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,SAAS,EAAE,CAAC,CAAC;QACjD,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAmB;YAChC,MAAM,IAAI,8BAAiB,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC;YACxD,MAAM,IAAI,kCAAqB,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC;SAC9D,CAAC;QAEF,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,SAAS,GAAG,IAAI,iCAAoB,CAAC,GAAG,EAAE;gBAC9C,YAAY,EAAE,CAAC,yBAAiB,CAAC;aAClC,CAAC,CAAC;YAEH,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YAEnE,IAAI,eAAe,EAAE,CAAC;gBACpB,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;QAED,MAAM,CAAC,YAAY,CAAC,GAAG,kBAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhD,MAAM,MAAM,GAAG,IAAI,qBAAc,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAE7D,MAAM,OAAO,CAAC,GAAG,CACf,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC1B,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAA;AAzEY,wCAAc;AASnB;IACH,WAAA,IAAA,mBAAM,EAAC,SAAS,EAAE,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC,CAAA;IAGpD,WAAA,IAAA,mBAAM,EAAC,YAAY,EAAE,EAAE,WAAW,EAAE,mCAAmC,EAAE,CAAC,CAAA;IAG1E,WAAA,IAAA,mBAAM,EAAC,UAAU,EAAE;QAClB,WAAW,EAAE,kDAAkD;KAChE,CAAC,CAAA;IAGD,WAAA,IAAA,wBAAW,EAAC,KAAK,EAAE,IAAI,0BAAY,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE;QACjE,WAAW,EAAE,kBAAkB;QAC/B,YAAY,EAAE,SAAS;QACvB,KAAK,EAAE,GAAG;KACX,CAAC,CAAA;IAGD,WAAA,IAAA,wBAAW,EAAC,KAAK,EAAE,IAAI,0BAAY,CAAC,MAAM,CAAC,EAAE;QAC5C,WAAW,EAAE,qBAAqB;QAClC,YAAY,EAAE,eAAe;QAC7B,KAAK,EAAE,GAAG;KACX,CAAC,CAAA;;;;yCAwCH;yBAxEU,cAAc;IAJ1B,IAAA,oBAAO,EAAC,SAAS,EAAE;QAClB,WAAW,EAAE,kBAAkB;QAC/B,UAAU,EAAE,CAAC,kCAAc,CAAC;KAC7B,CAAC;;GACW,cAAc,CAyE1B"}
|
|
@@ -3,5 +3,6 @@ export declare class OpenApiCommand implements IRunnable {
|
|
|
3
3
|
private readonly logger;
|
|
4
4
|
private readonly loader;
|
|
5
5
|
constructor();
|
|
6
|
-
run(verbose: boolean, ifPresent: boolean, outPath
|
|
6
|
+
run(verbose: boolean, ifPresent: boolean, outPath?: string, appPath?: string, configPath?: string, includeZones?: string[], excludeZones?: string[], title?: string, version?: string, description?: string): Promise<void>;
|
|
7
|
+
private readConfig;
|
|
7
8
|
}
|
|
@@ -18,9 +18,10 @@ const cli_common_1 = require("@rsdk/cli.common");
|
|
|
18
18
|
const common_1 = require("@rsdk/common");
|
|
19
19
|
const common_node_1 = require("@rsdk/common.node");
|
|
20
20
|
const logging_1 = require("@rsdk/logging");
|
|
21
|
+
const value_1 = require("@sinclair/typebox/value");
|
|
21
22
|
const app_loader_1 = require("../base/app.loader");
|
|
22
23
|
const document_file_1 = require("../base/document.file");
|
|
23
|
-
const
|
|
24
|
+
const generators_1 = require("../generators");
|
|
24
25
|
let OpenApiCommand = OpenApiCommand_1 = class OpenApiCommand {
|
|
25
26
|
logger;
|
|
26
27
|
loader;
|
|
@@ -28,30 +29,55 @@ let OpenApiCommand = OpenApiCommand_1 = class OpenApiCommand {
|
|
|
28
29
|
this.logger = logging_1.LoggerFactory.create(OpenApiCommand_1);
|
|
29
30
|
this.loader = new app_loader_1.AppLoader(this.logger);
|
|
30
31
|
}
|
|
31
|
-
async run(verbose, ifPresent, outPath, appPath, includeZones, excludeZones, title, version, description) {
|
|
32
|
+
async run(verbose, ifPresent, outPath, appPath, configPath, includeZones, excludeZones, title, version, description) {
|
|
32
33
|
if (verbose) {
|
|
33
34
|
this.logger.info(`app path: ${appPath}`);
|
|
34
35
|
this.logger.info(`output file: ${outPath}`);
|
|
35
36
|
this.logger.info(`--if-present: ${ifPresent}`);
|
|
36
37
|
}
|
|
37
|
-
const
|
|
38
|
+
const config = await this.readConfig(configPath);
|
|
39
|
+
// Command line options take precedence over config file
|
|
40
|
+
const effectiveOutPath = outPath ?? config.out ?? 'openapi.json';
|
|
41
|
+
const effectiveAppPath = appPath ?? config.app ?? './dist/app.js';
|
|
42
|
+
if (verbose) {
|
|
43
|
+
this.logger.info(`effective out path: ${effectiveOutPath}`);
|
|
44
|
+
this.logger.info(`effective app path: ${effectiveAppPath}`);
|
|
45
|
+
}
|
|
46
|
+
const app = await this.loader.loadApp(effectiveAppPath, !ifPresent);
|
|
38
47
|
if (!app) {
|
|
39
48
|
return;
|
|
40
49
|
}
|
|
41
|
-
const [absolutePath] = common_node_1.Path.absolutize(
|
|
50
|
+
const [absolutePath] = common_node_1.Path.absolutize(effectiveOutPath);
|
|
42
51
|
const [dirname, filename] = common_node_1.Path.split(absolutePath);
|
|
43
52
|
const options = {
|
|
53
|
+
...config,
|
|
44
54
|
...(includeZones && { includeZones }),
|
|
45
55
|
...(excludeZones && { excludeZones }),
|
|
56
|
+
...(title && { title }),
|
|
46
57
|
...(description && { description }),
|
|
47
58
|
...(version && { version }),
|
|
48
|
-
...(title && { title }),
|
|
49
59
|
};
|
|
50
|
-
|
|
60
|
+
if (verbose) {
|
|
61
|
+
this.logger.info('override options', options);
|
|
62
|
+
}
|
|
63
|
+
const generator = new generators_1.OpenApiFileGenerator(app, options);
|
|
51
64
|
const writer = new document_file_1.DocumentWriter(this.logger, dirname);
|
|
52
65
|
const document = await generator.createFile(filename);
|
|
53
66
|
await writer.write(document);
|
|
54
67
|
}
|
|
68
|
+
async readConfig(configPath) {
|
|
69
|
+
if (!configPath) {
|
|
70
|
+
return {};
|
|
71
|
+
}
|
|
72
|
+
this.logger.info(`reading config file: ${configPath}`);
|
|
73
|
+
const [absolutePath] = common_node_1.Path.absolutize(configPath);
|
|
74
|
+
const config = await (0, common_node_1.readObj)(absolutePath);
|
|
75
|
+
if (!value_1.Value.Check(generators_1.OpenApiConfigSchema, config)) {
|
|
76
|
+
const errors = [...value_1.Value.Errors(generators_1.OpenApiConfigSchema, config)];
|
|
77
|
+
throw new Error(`Invalid config file: ${configPath}\n${JSON.stringify(errors, null, 2)}`);
|
|
78
|
+
}
|
|
79
|
+
return config;
|
|
80
|
+
}
|
|
55
81
|
};
|
|
56
82
|
exports.OpenApiCommand = OpenApiCommand;
|
|
57
83
|
__decorate([
|
|
@@ -62,51 +88,47 @@ __decorate([
|
|
|
62
88
|
})),
|
|
63
89
|
__param(2, (0, cli_common_1.ValueOption)('out', new common_node_1.FsPathParser('file', { check: 'dirname' }), {
|
|
64
90
|
description: 'output file',
|
|
65
|
-
defaultValue: 'openapi.json',
|
|
66
91
|
alias: 'o',
|
|
67
92
|
})),
|
|
68
93
|
__param(3, (0, cli_common_1.ValueOption)('app', new common_node_1.FsPathParser('file'), {
|
|
69
94
|
description: 'path to app.js file',
|
|
70
|
-
defaultValue: './dist/app.js',
|
|
71
95
|
alias: 'a',
|
|
72
96
|
})),
|
|
73
|
-
__param(4, (0, cli_common_1.ValueOption)('
|
|
97
|
+
__param(4, (0, cli_common_1.ValueOption)('conf', new common_node_1.FsPathParser('file'), {
|
|
98
|
+
description: (0, common_1.text) `
|
|
99
|
+
Path to configuration file (YAML or JSON) containing any of the command options.
|
|
100
|
+
Command line options take precedence over config file values.
|
|
101
|
+
`,
|
|
102
|
+
})),
|
|
103
|
+
__param(5, (0, cli_common_1.ValueOption)('include-zones', new common_1.ArrayParser(new common_1.StringParser()), {
|
|
74
104
|
description: (0, common_1.text) `
|
|
75
105
|
API zones to include. Only controllers with these zones will be included in the output.
|
|
76
106
|
Zones are specified as a comma-separated list.
|
|
77
107
|
`,
|
|
78
|
-
defaultValue: undefined,
|
|
79
108
|
})),
|
|
80
|
-
__param(
|
|
109
|
+
__param(6, (0, cli_common_1.ValueOption)('exclude-zones', new common_1.ArrayParser(new common_1.StringParser()), {
|
|
81
110
|
description: (0, common_1.text) `
|
|
82
111
|
API zones to exclude. Only controllers without these zones will be included in the output.
|
|
83
112
|
Zones are specified as a comma-separated list.
|
|
84
113
|
`,
|
|
85
|
-
defaultValue: undefined,
|
|
86
114
|
})),
|
|
87
|
-
__param(
|
|
115
|
+
__param(7, (0, cli_common_1.ValueOption)('title', new common_1.StringParser(), {
|
|
88
116
|
description: (0, common_1.text) `
|
|
89
|
-
The title of OpenAPI document.
|
|
90
|
-
the app metadata which is used by default.
|
|
117
|
+
The title of OpenAPI document. Takes precedence over config file and app metadata.
|
|
91
118
|
`,
|
|
92
|
-
defaultValue: undefined,
|
|
93
119
|
})),
|
|
94
|
-
__param(
|
|
120
|
+
__param(8, (0, cli_common_1.ValueOption)('version', new common_1.StringParser(), {
|
|
95
121
|
description: (0, common_1.text) `
|
|
96
|
-
The version of OpenAPI document.
|
|
97
|
-
the app metadata which is used by default.
|
|
122
|
+
The version of OpenAPI document. Takes precedence over config file and app metadata.
|
|
98
123
|
`,
|
|
99
|
-
defaultValue: undefined,
|
|
100
124
|
})),
|
|
101
|
-
__param(
|
|
125
|
+
__param(9, (0, cli_common_1.ValueOption)('description', new common_1.StringParser(), {
|
|
102
126
|
description: (0, common_1.text) `
|
|
103
|
-
The description of OpenAPI document.
|
|
104
|
-
the app metadata which is used by default.
|
|
127
|
+
The description of OpenAPI document. Takes precedence over config file and app metadata.
|
|
105
128
|
`,
|
|
106
|
-
defaultValue: undefined,
|
|
107
129
|
})),
|
|
108
130
|
__metadata("design:type", Function),
|
|
109
|
-
__metadata("design:paramtypes", [Boolean, Boolean, String, String, Array, Array, String, String, String]),
|
|
131
|
+
__metadata("design:paramtypes", [Boolean, Boolean, String, String, String, Array, Array, String, String, String]),
|
|
110
132
|
__metadata("design:returntype", Promise)
|
|
111
133
|
], OpenApiCommand.prototype, "run", null);
|
|
112
134
|
exports.OpenApiCommand = OpenApiCommand = OpenApiCommand_1 = __decorate([
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi.variation.js","sourceRoot":"","sources":["../../src/commands/openapi.variation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAK0B;AAC1B,yCAA+D;AAC/D,
|
|
1
|
+
{"version":3,"file":"openapi.variation.js","sourceRoot":"","sources":["../../src/commands/openapi.variation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAK0B;AAC1B,yCAA+D;AAC/D,mDAAgE;AAChE,2CAAuD;AACvD,mDAAgD;AAEhD,mDAA+C;AAC/C,yDAAuD;AACvD,8CAIuB;AAUhB,IAAM,cAAc,sBAApB,MAAM,cAAc;IACR,MAAM,CAAU;IAChB,MAAM,CAAY;IAEnC;QACE,IAAI,CAAC,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,gBAAc,CAAC,CAAC;QACnD,IAAI,CAAC,MAAM,GAAG,IAAI,sBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEK,AAAN,KAAK,CAAC,GAAG,CAEP,OAAgB,EAMhB,SAAkB,EAMlB,OAAgB,EAMhB,OAAgB,EAQhB,UAAmB,EAQnB,YAAuB,EAQvB,YAAuB,EAOvB,KAAc,EAOd,OAAgB,EAOhB,WAAoB;QAEpB,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,OAAO,EAAE,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,OAAO,EAAE,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,SAAS,EAAE,CAAC,CAAC;QACjD,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAEjD,wDAAwD;QACxD,MAAM,gBAAgB,GAAG,OAAO,IAAI,MAAM,CAAC,GAAG,IAAI,cAAc,CAAC;QACjE,MAAM,gBAAgB,GAAG,OAAO,IAAI,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC;QAElE,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,gBAAgB,EAAE,CAAC,CAAC;YAC5D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,gBAAgB,EAAE,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,SAAS,CAAC,CAAC;QACpE,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO;QACT,CAAC;QAED,MAAM,CAAC,YAAY,CAAC,GAAG,kBAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACzD,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,kBAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAErD,MAAM,OAAO,GAAqC;YAChD,GAAG,MAAM;YACT,GAAG,CAAC,YAAY,IAAI,EAAE,YAAY,EAAE,CAAC;YACrC,GAAG,CAAC,YAAY,IAAI,EAAE,YAAY,EAAE,CAAC;YACrC,GAAG,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,CAAC;YACvB,GAAG,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,CAAC;YACnC,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;SAC5B,CAAC;QAEF,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,iCAAoB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,8BAAc,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAExD,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAEtD,MAAM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAEO,KAAK,CAAC,UAAU,CACtB,UAA8B;QAE9B,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,UAAU,EAAE,CAAC,CAAC;QAEvD,MAAM,CAAC,YAAY,CAAC,GAAG,kBAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAO,EAAC,YAAY,CAAC,CAAC;QAE3C,IAAI,CAAC,aAAK,CAAC,KAAK,CAAC,gCAAmB,EAAE,MAAM,CAAC,EAAE,CAAC;YAC9C,MAAM,MAAM,GAAG,CAAC,GAAG,aAAK,CAAC,MAAM,CAAC,gCAAmB,EAAE,MAAM,CAAC,CAAC,CAAC;YAE9D,MAAM,IAAI,KAAK,CACb,wBAAwB,UAAU,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CACzE,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAA;AAhJY,wCAAc;AASnB;IACH,WAAA,IAAA,mBAAM,EAAC,SAAS,EAAE,EAAE,WAAW,EAAE,gBAAgB,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAA;IAGzE,WAAA,IAAA,mBAAM,EAAC,YAAY,EAAE;QACpB,WAAW,EAAE,mCAAmC;QAChD,YAAY,EAAE,KAAK;KACpB,CAAC,CAAA;IAGD,WAAA,IAAA,wBAAW,EAAC,KAAK,EAAE,IAAI,0BAAY,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE;QAClE,WAAW,EAAE,aAAa;QAC1B,KAAK,EAAE,GAAG;KACX,CAAC,CAAA;IAGD,WAAA,IAAA,wBAAW,EAAC,KAAK,EAAE,IAAI,0BAAY,CAAC,MAAM,CAAC,EAAE;QAC5C,WAAW,EAAE,qBAAqB;QAClC,KAAK,EAAE,GAAG;KACX,CAAC,CAAA;IAGD,WAAA,IAAA,wBAAW,EAAC,MAAM,EAAE,IAAI,0BAAY,CAAC,MAAM,CAAC,EAAE;QAC7C,WAAW,EAAE,IAAA,aAAI,EAAA;;;OAGhB;KACF,CAAC,CAAA;IAGD,WAAA,IAAA,wBAAW,EAAC,eAAe,EAAE,IAAI,oBAAW,CAAC,IAAI,qBAAY,EAAE,CAAC,EAAE;QACjE,WAAW,EAAE,IAAA,aAAI,EAAA;;;OAGhB;KACF,CAAC,CAAA;IAGD,WAAA,IAAA,wBAAW,EAAC,eAAe,EAAE,IAAI,oBAAW,CAAC,IAAI,qBAAY,EAAE,CAAC,EAAE;QACjE,WAAW,EAAE,IAAA,aAAI,EAAA;;;OAGhB;KACF,CAAC,CAAA;IAGD,WAAA,IAAA,wBAAW,EAAC,OAAO,EAAE,IAAI,qBAAY,EAAE,EAAE;QACxC,WAAW,EAAE,IAAA,aAAI,EAAA;;OAEhB;KACF,CAAC,CAAA;IAGD,WAAA,IAAA,wBAAW,EAAC,SAAS,EAAE,IAAI,qBAAY,EAAE,EAAE;QAC1C,WAAW,EAAE,IAAA,aAAI,EAAA;;OAEhB;KACF,CAAC,CAAA;IAGD,WAAA,IAAA,wBAAW,EAAC,aAAa,EAAE,IAAI,qBAAY,EAAE,EAAE;QAC9C,WAAW,EAAE,IAAA,aAAI,EAAA;;OAEhB;KACF,CAAC,CAAA;;;;yCA+CH;yBAxHU,cAAc;IAH1B,IAAA,6BAAgB,EAAC,iBAAiB,EAAE;QACnC,WAAW,EAAE,mBAAmB;KACjC,CAAC;;GACW,cAAc,CAgJ1B"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ILogger } from '@rsdk/logging';
|
|
2
|
-
import type { DocumentFile } from '../base
|
|
2
|
+
import type { DocumentFile } from '../base';
|
|
3
3
|
export declare abstract class FileGenerator {
|
|
4
4
|
protected readonly logger: ILogger;
|
|
5
5
|
constructor(logger: ILogger);
|