@travetto/doc 3.0.0-rc.16 → 3.0.0-rc.18
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 +4 -3
- package/package.json +3 -3
- package/src/mod-mapping.ts +65 -65
package/README.md
CHANGED
|
@@ -155,12 +155,13 @@ Sample documentation for fictional module. This module fictitiously relies upon
|
|
|
155
155
|
Usage: <span class="token punctuation">[</span>options<span class="token punctuation">]</span> <span class="token punctuation">[</span>command<span class="token punctuation">]</span>
|
|
156
156
|
|
|
157
157
|
Options:
|
|
158
|
-
-V, <span class="token parameter variable">--version</span>
|
|
159
|
-
-h, <span class="token parameter variable">--help</span>
|
|
158
|
+
-V, <span class="token parameter variable">--version</span> output the version number
|
|
159
|
+
-h, <span class="token parameter variable">--help</span> display <span class="token builtin class-name">help</span> <span class="token keyword">for</span> <span class="token builtin class-name">command</span>
|
|
160
160
|
|
|
161
161
|
Commands:
|
|
162
162
|
doc <span class="token punctuation">[</span>options<span class="token punctuation">]</span>
|
|
163
|
-
|
|
163
|
+
main <span class="token operator"><</span>fileOrImport<span class="token operator">></span> <span class="token punctuation">[</span>args<span class="token punctuation">..</span>.<span class="token punctuation">]</span>
|
|
164
|
+
<span class="token builtin class-name">help</span> <span class="token punctuation">[</span>command<span class="token punctuation">]</span> display <span class="token builtin class-name">help</span> <span class="token keyword">for</span> <span class="token builtin class-name">command</span></code></pre>
|
|
164
165
|
</figure>
|
|
165
166
|
Wrote docs for DOC.ts
|
|
166
167
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@travetto/doc",
|
|
3
|
-
"version": "3.0.0-rc.
|
|
3
|
+
"version": "3.0.0-rc.18",
|
|
4
4
|
"description": "Documentation support for the travetto framework",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"docs",
|
|
@@ -24,12 +24,12 @@
|
|
|
24
24
|
"directory": "module/doc"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@travetto/base": "^3.0.0-rc.
|
|
27
|
+
"@travetto/base": "^3.0.0-rc.18",
|
|
28
28
|
"@types/prismjs": "^1.26.0",
|
|
29
29
|
"prismjs": "^1.29.0"
|
|
30
30
|
},
|
|
31
31
|
"peerDependencies": {
|
|
32
|
-
"@travetto/cli": "^3.0.0-rc.
|
|
32
|
+
"@travetto/cli": "^3.0.0-rc.21"
|
|
33
33
|
},
|
|
34
34
|
"peerDependenciesMeta": {
|
|
35
35
|
"@travetto/cli": {
|
package/src/mod-mapping.ts
CHANGED
|
@@ -1,258 +1,258 @@
|
|
|
1
1
|
export const MOD_MAPPING = {
|
|
2
2
|
App: {
|
|
3
|
-
name:
|
|
3
|
+
name:'@travetto/app', folder:'@travetto/app', displayName: 'Application',
|
|
4
4
|
description: 'Application registration/management and run support.'
|
|
5
5
|
},
|
|
6
6
|
Asset: {
|
|
7
|
-
name:
|
|
7
|
+
name:'@travetto/asset', folder:'@travetto/asset', displayName: 'Asset',
|
|
8
8
|
description: 'Modular library for storing and retrieving binary assets'
|
|
9
9
|
},
|
|
10
10
|
AssetRest: {
|
|
11
|
-
name:
|
|
11
|
+
name:'@travetto/asset-rest', folder:'@travetto/asset-rest', displayName: 'Asset Rest Support',
|
|
12
12
|
description: 'Provides integration between the travetto asset and rest module.'
|
|
13
13
|
},
|
|
14
14
|
Auth: {
|
|
15
|
-
name:
|
|
15
|
+
name:'@travetto/auth', folder:'@travetto/auth', displayName: 'Authentication',
|
|
16
16
|
description: 'Authentication scaffolding for the travetto framework'
|
|
17
17
|
},
|
|
18
18
|
AuthModel: {
|
|
19
|
-
name:
|
|
19
|
+
name:'@travetto/auth-model', folder:'@travetto/auth-model', displayName: 'Authentication Model',
|
|
20
20
|
description: 'Authentication model support for the travetto framework'
|
|
21
21
|
},
|
|
22
22
|
AuthRest: {
|
|
23
|
-
name:
|
|
23
|
+
name:'@travetto/auth-rest', folder:'@travetto/auth-rest', displayName: 'Rest Auth',
|
|
24
24
|
description: 'Rest authentication integration support for the travetto framework'
|
|
25
25
|
},
|
|
26
26
|
AuthRestContext: {
|
|
27
|
-
name:
|
|
27
|
+
name:'@travetto/auth-rest-context', folder:'@travetto/auth-rest-context', displayName: 'Rest Auth Context',
|
|
28
28
|
description: 'Rest authentication context integration support for the travetto framework'
|
|
29
29
|
},
|
|
30
30
|
AuthRestJwt: {
|
|
31
|
-
name:
|
|
31
|
+
name:'@travetto/auth-rest-jwt', folder:'@travetto/auth-rest-jwt', displayName: 'Rest Auth JWT',
|
|
32
32
|
description: 'Rest authentication JWT integration support for the travetto framework'
|
|
33
33
|
},
|
|
34
34
|
AuthRestPassport: {
|
|
35
|
-
name:
|
|
35
|
+
name:'@travetto/auth-rest-passport', folder:'@travetto/auth-rest-passport', displayName: 'Rest Auth Passport',
|
|
36
36
|
description: 'Rest authentication integration support for the travetto framework'
|
|
37
37
|
},
|
|
38
38
|
AuthRestSession: {
|
|
39
|
-
name:
|
|
39
|
+
name:'@travetto/auth-rest-session', folder:'@travetto/auth-rest-session', displayName: 'Rest Auth Session',
|
|
40
40
|
description: 'Rest authentication session integration support for the travetto framework'
|
|
41
41
|
},
|
|
42
42
|
Base: {
|
|
43
|
-
name:
|
|
43
|
+
name:'@travetto/base', folder:'@travetto/base', displayName: 'Base',
|
|
44
44
|
description: 'Environment config and common utilities for travetto applications.'
|
|
45
45
|
},
|
|
46
46
|
Cache: {
|
|
47
|
-
name:
|
|
47
|
+
name:'@travetto/cache', folder:'@travetto/cache', displayName: 'Caching',
|
|
48
48
|
description: 'Caching functionality with decorators for declarative use.'
|
|
49
49
|
},
|
|
50
50
|
Cli: {
|
|
51
|
-
name:
|
|
51
|
+
name:'@travetto/cli', folder:'@travetto/cli', displayName: 'Command Line Interface',
|
|
52
52
|
description: 'CLI infrastructure for travetto framework'
|
|
53
53
|
},
|
|
54
54
|
Command: {
|
|
55
|
-
name:
|
|
55
|
+
name:'@travetto/command', folder:'@travetto/command', displayName: 'Command',
|
|
56
56
|
description: 'Support for executing complex commands at runtime.'
|
|
57
57
|
},
|
|
58
58
|
Compiler: {
|
|
59
|
-
name:
|
|
59
|
+
name:'@travetto/compiler', folder:'@travetto/compiler', displayName: 'Compiler',
|
|
60
60
|
description: 'Compiler'
|
|
61
61
|
},
|
|
62
62
|
Config: {
|
|
63
|
-
name:
|
|
63
|
+
name:'@travetto/config', folder:'@travetto/config', displayName: 'Configuration',
|
|
64
64
|
description: 'Configuration support'
|
|
65
65
|
},
|
|
66
66
|
Context: {
|
|
67
|
-
name:
|
|
67
|
+
name:'@travetto/context', folder:'@travetto/context', displayName: 'Async Context',
|
|
68
68
|
description: 'Async-aware state management, maintaining context across asynchronous calls.'
|
|
69
69
|
},
|
|
70
70
|
Di: {
|
|
71
|
-
name:
|
|
71
|
+
name:'@travetto/di', folder:'@travetto/di', displayName: 'Dependency Injection',
|
|
72
72
|
description: 'Dependency registration/management and injection support.'
|
|
73
73
|
},
|
|
74
74
|
Doc: {
|
|
75
|
-
name:
|
|
75
|
+
name:'@travetto/doc', folder:'@travetto/doc', displayName: 'Documentation',
|
|
76
76
|
description: 'Documentation support for the travetto framework'
|
|
77
77
|
},
|
|
78
78
|
Email: {
|
|
79
|
-
name:
|
|
79
|
+
name:'@travetto/email', folder:'@travetto/email', displayName: 'Email',
|
|
80
80
|
description: 'Email transmission module.'
|
|
81
81
|
},
|
|
82
82
|
EmailNodemailer: {
|
|
83
|
-
name:
|
|
83
|
+
name:'@travetto/email-nodemailer', folder:'@travetto/email-nodemailer', displayName: 'Email Nodemailer Support',
|
|
84
84
|
description: 'Email transmission module.'
|
|
85
85
|
},
|
|
86
86
|
EmailTemplate: {
|
|
87
|
-
name:
|
|
87
|
+
name:'@travetto/email-template', folder:'@travetto/email-template', displayName: 'Email Templating',
|
|
88
88
|
description: 'Email templating module'
|
|
89
89
|
},
|
|
90
|
-
|
|
91
|
-
name:
|
|
90
|
+
Eslint: {
|
|
91
|
+
name:'@travetto/eslint', folder:'@travetto/eslint', displayName: 'ES Linting Rules',
|
|
92
92
|
description: 'ES Linting Rules'
|
|
93
93
|
},
|
|
94
94
|
Image: {
|
|
95
|
-
name:
|
|
95
|
+
name:'@travetto/image', folder:'@travetto/image', displayName: 'Image',
|
|
96
96
|
description: 'Image support, resizing, and optimization'
|
|
97
97
|
},
|
|
98
98
|
Jwt: {
|
|
99
|
-
name:
|
|
99
|
+
name:'@travetto/jwt', folder:'@travetto/jwt', displayName: 'JWT',
|
|
100
100
|
description: 'JSON Web Token implementation'
|
|
101
101
|
},
|
|
102
102
|
Log: {
|
|
103
|
-
name:
|
|
103
|
+
name:'@travetto/log', folder:'@travetto/log', displayName: 'Logging',
|
|
104
104
|
description: 'Logging framework that integrates at the console.log level.'
|
|
105
105
|
},
|
|
106
106
|
Manifest: {
|
|
107
|
-
name:
|
|
107
|
+
name:'@travetto/manifest', folder:'@travetto/manifest', displayName: 'Manifest',
|
|
108
108
|
description: 'Manifest support'
|
|
109
109
|
},
|
|
110
110
|
Model: {
|
|
111
|
-
name:
|
|
111
|
+
name:'@travetto/model', folder:'@travetto/model', displayName: 'Data Modeling Support',
|
|
112
112
|
description: 'Datastore abstraction for core operations.'
|
|
113
113
|
},
|
|
114
114
|
ModelDynamodb: {
|
|
115
|
-
name:
|
|
115
|
+
name:'@travetto/model-dynamodb', folder:'@travetto/model-dynamodb', displayName: 'DynamoDB Model Support',
|
|
116
116
|
description: 'DynamoDB backing for the travetto model module.'
|
|
117
117
|
},
|
|
118
118
|
ModelElasticsearch: {
|
|
119
|
-
name:
|
|
119
|
+
name:'@travetto/model-elasticsearch', folder:'@travetto/model-elasticsearch', displayName: 'Elasticsearch Model Source',
|
|
120
120
|
description: 'Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.'
|
|
121
121
|
},
|
|
122
122
|
ModelFirestore: {
|
|
123
|
-
name:
|
|
123
|
+
name:'@travetto/model-firestore', folder:'@travetto/model-firestore', displayName: 'Firestore Model Support',
|
|
124
124
|
description: 'Firestore backing for the travetto model module.'
|
|
125
125
|
},
|
|
126
126
|
ModelMongo: {
|
|
127
|
-
name:
|
|
127
|
+
name:'@travetto/model-mongo', folder:'@travetto/model-mongo', displayName: 'MongoDB Model Support',
|
|
128
128
|
description: 'Mongo backing for the travetto model module.'
|
|
129
129
|
},
|
|
130
130
|
ModelMysql: {
|
|
131
|
-
name:
|
|
131
|
+
name:'@travetto/model-mysql', folder:'@travetto/model-mysql', displayName: 'MySQL Model Service',
|
|
132
132
|
description: 'MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.'
|
|
133
133
|
},
|
|
134
134
|
ModelPostgres: {
|
|
135
|
-
name:
|
|
135
|
+
name:'@travetto/model-postgres', folder:'@travetto/model-postgres', displayName: 'PostgreSQL Model Service',
|
|
136
136
|
description: 'PostgreSQL backing for the travetto model module, with real-time modeling support for SQL schemas.'
|
|
137
137
|
},
|
|
138
138
|
ModelQuery: {
|
|
139
|
-
name:
|
|
139
|
+
name:'@travetto/model-query', folder:'@travetto/model-query', displayName: 'Data Model Querying',
|
|
140
140
|
description: 'Datastore abstraction for advanced query support.'
|
|
141
141
|
},
|
|
142
142
|
ModelRedis: {
|
|
143
|
-
name:
|
|
143
|
+
name:'@travetto/model-redis', folder:'@travetto/model-redis', displayName: 'Redis Model Support',
|
|
144
144
|
description: 'Redis backing for the travetto model module.'
|
|
145
145
|
},
|
|
146
146
|
ModelS3: {
|
|
147
|
-
name:
|
|
147
|
+
name:'@travetto/model-s3', folder:'@travetto/model-s3', displayName: 'S3 Model Support',
|
|
148
148
|
description: 'S3 backing for the travetto model module.'
|
|
149
149
|
},
|
|
150
150
|
ModelSql: {
|
|
151
|
-
name:
|
|
151
|
+
name:'@travetto/model-sql', folder:'@travetto/model-sql', displayName: 'SQL Model Service',
|
|
152
152
|
description: 'SQL backing for the travetto model module, with real-time modeling support for SQL schemas.'
|
|
153
153
|
},
|
|
154
154
|
ModelSqlite: {
|
|
155
|
-
name:
|
|
155
|
+
name:'@travetto/model-sqlite', folder:'@travetto/model-sqlite', displayName: 'SQLite Model Service',
|
|
156
156
|
description: 'SQLite backing for the travetto model module, with real-time modeling support for SQL schemas.'
|
|
157
157
|
},
|
|
158
158
|
Openapi: {
|
|
159
|
-
name:
|
|
159
|
+
name:'@travetto/openapi', folder:'@travetto/openapi', displayName: 'OpenAPI Specification',
|
|
160
160
|
description: 'OpenAPI integration support for the travetto framework'
|
|
161
161
|
},
|
|
162
162
|
Overview: {
|
|
163
|
-
name:
|
|
163
|
+
name:'@travetto/overview', folder:'@travetto/overview', displayName: 'Overview Docs',
|
|
164
164
|
description: 'Documentation overview'
|
|
165
165
|
},
|
|
166
166
|
Pack: {
|
|
167
|
-
name:
|
|
167
|
+
name:'@travetto/pack', folder:'@travetto/pack', displayName: 'Pack',
|
|
168
168
|
description: 'Code packing utilities'
|
|
169
169
|
},
|
|
170
170
|
Registry: {
|
|
171
|
-
name:
|
|
171
|
+
name:'@travetto/registry', folder:'@travetto/registry', displayName: 'Registry',
|
|
172
172
|
description: 'Patterns and utilities for handling registration of metadata and functionality for run-time use'
|
|
173
173
|
},
|
|
174
174
|
Repo: {
|
|
175
|
-
name:
|
|
175
|
+
name:'@travetto/repo', folder:'@travetto/repo', displayName: 'Repo',
|
|
176
176
|
description: 'Monorepo utilities'
|
|
177
177
|
},
|
|
178
178
|
Rest: {
|
|
179
|
-
name:
|
|
179
|
+
name:'@travetto/rest', folder:'@travetto/rest', displayName: 'RESTful API',
|
|
180
180
|
description: 'Declarative api for RESTful APIs with support for the dependency injection module.'
|
|
181
181
|
},
|
|
182
182
|
RestAwsLambda: {
|
|
183
|
-
name:
|
|
183
|
+
name:'@travetto/rest-aws-lambda', folder:'@travetto/rest-aws-lambda', displayName: 'RESTful AWS Lambda',
|
|
184
184
|
description: 'RESTful APIs entry point support for AWS Lambdas.'
|
|
185
185
|
},
|
|
186
186
|
RestExpress: {
|
|
187
|
-
name:
|
|
187
|
+
name:'@travetto/rest-express', folder:'@travetto/rest-express', displayName: 'Express REST Source',
|
|
188
188
|
description: 'Express provider for the travetto rest module.'
|
|
189
189
|
},
|
|
190
190
|
RestExpressLambda: {
|
|
191
|
-
name:
|
|
191
|
+
name:'@travetto/rest-express-lambda', folder:'@travetto/rest-express-lambda', displayName: 'Express REST AWS Lambda Source',
|
|
192
192
|
description: 'Express AWS Lambda provider for the travetto rest module.'
|
|
193
193
|
},
|
|
194
194
|
RestFastify: {
|
|
195
|
-
name:
|
|
195
|
+
name:'@travetto/rest-fastify', folder:'@travetto/rest-fastify', displayName: 'Fastify REST Source',
|
|
196
196
|
description: 'Fastify provider for the travetto rest module.'
|
|
197
197
|
},
|
|
198
198
|
RestFastifyLambda: {
|
|
199
|
-
name:
|
|
199
|
+
name:'@travetto/rest-fastify-lambda', folder:'@travetto/rest-fastify-lambda', displayName: 'Fastify REST AWS Lambda Source',
|
|
200
200
|
description: 'Fastify AWS Lambda provider for the travetto rest module.'
|
|
201
201
|
},
|
|
202
202
|
RestKoa: {
|
|
203
|
-
name:
|
|
203
|
+
name:'@travetto/rest-koa', folder:'@travetto/rest-koa', displayName: 'Koa REST Source',
|
|
204
204
|
description: 'Koa provider for the travetto rest module.'
|
|
205
205
|
},
|
|
206
206
|
RestKoaLambda: {
|
|
207
|
-
name:
|
|
207
|
+
name:'@travetto/rest-koa-lambda', folder:'@travetto/rest-koa-lambda', displayName: 'Koa REST AWS Lambda Source',
|
|
208
208
|
description: 'Koa provider for the travetto rest module.'
|
|
209
209
|
},
|
|
210
210
|
RestModel: {
|
|
211
|
-
name:
|
|
211
|
+
name:'@travetto/rest-model', folder:'@travetto/rest-model', displayName: 'RESTful Model Routes',
|
|
212
212
|
description: 'RESTful support for generating APIs from Model classes.'
|
|
213
213
|
},
|
|
214
214
|
RestModelQuery: {
|
|
215
|
-
name:
|
|
215
|
+
name:'@travetto/rest-model-query', folder:'@travetto/rest-model-query', displayName: 'RESTful Model Query Routes',
|
|
216
216
|
description: 'RESTful support for generating query APIs from Model classes.'
|
|
217
217
|
},
|
|
218
218
|
RestSession: {
|
|
219
|
-
name:
|
|
219
|
+
name:'@travetto/rest-session', folder:'@travetto/rest-session', displayName: 'REST Session',
|
|
220
220
|
description: 'Session provider for the travetto rest module.'
|
|
221
221
|
},
|
|
222
222
|
Scaffold: {
|
|
223
|
-
name:
|
|
223
|
+
name:'@travetto/scaffold', folder:'@travetto/scaffold', displayName: 'App Scaffold',
|
|
224
224
|
description: 'App Scaffold for the Travetto framework'
|
|
225
225
|
},
|
|
226
226
|
Schema: {
|
|
227
|
-
name:
|
|
227
|
+
name:'@travetto/schema', folder:'@travetto/schema', displayName: 'Schema',
|
|
228
228
|
description: 'Data type registry for runtime validation, reflection and binding.'
|
|
229
229
|
},
|
|
230
230
|
SchemaFaker: {
|
|
231
|
-
name:
|
|
231
|
+
name:'@travetto/schema-faker', folder:'@travetto/schema-faker', displayName: 'Schema Faker',
|
|
232
232
|
description: 'Data generation for schema-registered objects.'
|
|
233
233
|
},
|
|
234
234
|
Terminal: {
|
|
235
|
-
name:
|
|
235
|
+
name:'@travetto/terminal', folder:'@travetto/terminal', displayName: 'Terminal',
|
|
236
236
|
description: 'General terminal support'
|
|
237
237
|
},
|
|
238
238
|
Test: {
|
|
239
|
-
name:
|
|
239
|
+
name:'@travetto/test', folder:'@travetto/test', displayName: 'Testing',
|
|
240
240
|
description: 'Declarative test framework'
|
|
241
241
|
},
|
|
242
242
|
TodoApp: {
|
|
243
|
-
name:
|
|
243
|
+
name:'@travetto/todo-app', folder:'@travetto/todo-app', displayName: 'Todo Application',
|
|
244
244
|
description: ''
|
|
245
245
|
},
|
|
246
246
|
Transformer: {
|
|
247
|
-
name:
|
|
247
|
+
name:'@travetto/transformer', folder:'@travetto/transformer', displayName: 'Transformation',
|
|
248
248
|
description: 'Functionality for AST transformations, with transformer registration, and general utils'
|
|
249
249
|
},
|
|
250
250
|
Worker: {
|
|
251
|
-
name:
|
|
251
|
+
name:'@travetto/worker', folder:'@travetto/worker', displayName: 'Worker',
|
|
252
252
|
description: 'Process management utilities, with a focus on inter-process communication'
|
|
253
253
|
},
|
|
254
254
|
Yaml: {
|
|
255
|
-
name:
|
|
255
|
+
name:'@travetto/yaml', folder:'@travetto/yaml', displayName: 'YAML',
|
|
256
256
|
description: 'Simple YAML support, provides only clean subset of yaml'
|
|
257
257
|
}
|
|
258
258
|
};
|