embedoc 0.11.2 → 0.12.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/cli-contract.yaml +49 -32
- package/dist/cli.js +306 -343
- package/dist/cli.js.map +1 -1
- package/dist/generated/commands.d.ts +2 -0
- package/dist/generated/commands.d.ts.map +1 -0
- package/dist/generated/commands.js +2 -0
- package/dist/generated/commands.js.map +1 -0
- package/dist/generated/index.d.ts +6 -0
- package/dist/generated/index.d.ts.map +1 -0
- package/dist/generated/index.js +6 -0
- package/dist/generated/index.js.map +1 -0
- package/dist/generated/program.d.ts +26 -0
- package/dist/generated/program.d.ts.map +1 -0
- package/dist/generated/program.js +49 -0
- package/dist/generated/program.js.map +1 -0
- package/dist/generated/schemas.d.ts +2 -0
- package/dist/generated/schemas.d.ts.map +1 -0
- package/dist/generated/schemas.js +3 -0
- package/dist/generated/schemas.js.map +1 -0
- package/dist/generated/types.d.ts +57 -0
- package/dist/generated/types.d.ts.map +1 -0
- package/dist/generated/types.js +3 -0
- package/dist/generated/types.js.map +1 -0
- package/docs/cli-reference.md +18 -18
- package/package.json +2 -2
package/cli-contract.yaml
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# yaml-language-server: $schema=./node_modules/cli-contracts/schemas/cli-contract.schema.json
|
|
2
|
-
|
|
2
|
+
cli_contracts: 0.1.0
|
|
3
3
|
|
|
4
4
|
info:
|
|
5
5
|
title: embedoc CLI
|
|
6
|
-
version: 0.
|
|
6
|
+
version: 0.12.0
|
|
7
7
|
description: >-
|
|
8
8
|
In-place document generator that auto-updates marker blocks in documents
|
|
9
9
|
and source code while preserving manually edited sections. Supports
|
|
@@ -16,12 +16,29 @@ info:
|
|
|
16
16
|
name: foo-ogawa
|
|
17
17
|
url: https://github.com/foo-ogawa/embedoc
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
artifact_slots:
|
|
20
|
+
config:
|
|
21
|
+
direction: read
|
|
22
|
+
description: embedoc.config.yaml configuration
|
|
23
|
+
documents:
|
|
24
|
+
direction: readwrite
|
|
25
|
+
description: Target documents with @embedoc marker blocks
|
|
26
|
+
templates:
|
|
27
|
+
direction: read
|
|
28
|
+
description: Handlebars templates for file generation
|
|
29
|
+
datasources:
|
|
30
|
+
direction: read
|
|
31
|
+
description: Datasource files (SQLite, CSV, JSON, YAML)
|
|
32
|
+
generated-files:
|
|
33
|
+
direction: write
|
|
34
|
+
description: Files generated by Handlebars templates
|
|
35
|
+
|
|
36
|
+
command_sets:
|
|
20
37
|
embedoc:
|
|
21
38
|
summary: In-place document generator with marker-based embedding.
|
|
22
39
|
executable: embedoc
|
|
23
40
|
|
|
24
|
-
|
|
41
|
+
global_options:
|
|
25
42
|
- name: version
|
|
26
43
|
aliases: [V]
|
|
27
44
|
description: Print version and exit.
|
|
@@ -64,17 +81,17 @@ commandSets:
|
|
|
64
81
|
files:
|
|
65
82
|
- path: embedoc.config.yaml
|
|
66
83
|
required: false
|
|
67
|
-
|
|
84
|
+
media_type: application/yaml
|
|
68
85
|
encoding: utf-8
|
|
69
86
|
description: Configuration file.
|
|
70
87
|
- path: .embedoc/renderers/index.ts
|
|
71
88
|
required: false
|
|
72
|
-
|
|
89
|
+
media_type: text/x-typescript
|
|
73
90
|
encoding: utf-8
|
|
74
91
|
description: Renderer registration file.
|
|
75
92
|
- path: .embedoc/datasources/index.ts
|
|
76
93
|
required: false
|
|
77
|
-
|
|
94
|
+
media_type: text/x-typescript
|
|
78
95
|
encoding: utf-8
|
|
79
96
|
description: Custom datasource registration file.
|
|
80
97
|
- path: .embedoc/templates/.gitkeep
|
|
@@ -87,10 +104,10 @@ commandSets:
|
|
|
87
104
|
format: text
|
|
88
105
|
|
|
89
106
|
x-agent:
|
|
90
|
-
|
|
91
|
-
|
|
107
|
+
risk_level: low
|
|
108
|
+
requires_confirmation: false
|
|
92
109
|
idempotent: true
|
|
93
|
-
|
|
110
|
+
side_effects:
|
|
94
111
|
- file_write
|
|
95
112
|
- directory_create
|
|
96
113
|
|
|
@@ -124,14 +141,14 @@ commandSets:
|
|
|
124
141
|
- name: config
|
|
125
142
|
aliases: [c]
|
|
126
143
|
description: Path to config file (YAML or JSON).
|
|
127
|
-
|
|
144
|
+
value_name: path
|
|
128
145
|
schema:
|
|
129
146
|
type: string
|
|
130
147
|
default: embedoc.config.yaml
|
|
131
148
|
file:
|
|
132
149
|
mode: read
|
|
133
150
|
exists: true
|
|
134
|
-
|
|
151
|
+
media_type: application/yaml
|
|
135
152
|
encoding: utf-8
|
|
136
153
|
|
|
137
154
|
- name: dry-run
|
|
@@ -160,13 +177,13 @@ commandSets:
|
|
|
160
177
|
format: text
|
|
161
178
|
|
|
162
179
|
x-agent:
|
|
163
|
-
|
|
164
|
-
|
|
180
|
+
risk_level: medium
|
|
181
|
+
requires_confirmation: false
|
|
165
182
|
idempotent: true
|
|
166
|
-
|
|
183
|
+
side_effects:
|
|
167
184
|
- file_write
|
|
168
|
-
|
|
169
|
-
|
|
185
|
+
safe_dry_run_option: --dry-run
|
|
186
|
+
recommended_before_use:
|
|
170
187
|
- Ensure embedoc.config.yaml exists (run init if needed).
|
|
171
188
|
- Verify datasource files are accessible.
|
|
172
189
|
|
|
@@ -189,27 +206,27 @@ commandSets:
|
|
|
189
206
|
- name: config
|
|
190
207
|
aliases: [c]
|
|
191
208
|
description: Path to config file (YAML or JSON).
|
|
192
|
-
|
|
209
|
+
value_name: path
|
|
193
210
|
schema:
|
|
194
211
|
type: string
|
|
195
212
|
default: embedoc.config.yaml
|
|
196
213
|
file:
|
|
197
214
|
mode: read
|
|
198
215
|
exists: true
|
|
199
|
-
|
|
216
|
+
media_type: application/yaml
|
|
200
217
|
encoding: utf-8
|
|
201
218
|
|
|
202
219
|
- name: datasource
|
|
203
220
|
aliases: [s]
|
|
204
221
|
description: Specific datasource to process.
|
|
205
|
-
|
|
222
|
+
value_name: name
|
|
206
223
|
schema:
|
|
207
224
|
type: string
|
|
208
225
|
|
|
209
226
|
- name: generator
|
|
210
227
|
aliases: [g]
|
|
211
228
|
description: Specific generator template to use.
|
|
212
|
-
|
|
229
|
+
value_name: name
|
|
213
230
|
schema:
|
|
214
231
|
type: string
|
|
215
232
|
|
|
@@ -248,13 +265,13 @@ commandSets:
|
|
|
248
265
|
format: text
|
|
249
266
|
|
|
250
267
|
x-agent:
|
|
251
|
-
|
|
252
|
-
|
|
268
|
+
risk_level: medium
|
|
269
|
+
requires_confirmation: false
|
|
253
270
|
idempotent: true
|
|
254
|
-
|
|
271
|
+
side_effects:
|
|
255
272
|
- file_write
|
|
256
|
-
|
|
257
|
-
|
|
273
|
+
safe_dry_run_option: --dry-run
|
|
274
|
+
recommended_before_use:
|
|
258
275
|
- Ensure embedoc.config.yaml exists with generators configured.
|
|
259
276
|
- Verify datasource files are accessible.
|
|
260
277
|
- Ensure Handlebars templates exist in templates_dir.
|
|
@@ -278,14 +295,14 @@ commandSets:
|
|
|
278
295
|
- name: config
|
|
279
296
|
aliases: [c]
|
|
280
297
|
description: Path to config file (YAML or JSON).
|
|
281
|
-
|
|
298
|
+
value_name: path
|
|
282
299
|
schema:
|
|
283
300
|
type: string
|
|
284
301
|
default: embedoc.config.yaml
|
|
285
302
|
file:
|
|
286
303
|
mode: read
|
|
287
304
|
exists: true
|
|
288
|
-
|
|
305
|
+
media_type: application/yaml
|
|
289
306
|
encoding: utf-8
|
|
290
307
|
|
|
291
308
|
- name: verbose
|
|
@@ -317,11 +334,11 @@ commandSets:
|
|
|
317
334
|
format: text
|
|
318
335
|
|
|
319
336
|
x-agent:
|
|
320
|
-
|
|
321
|
-
|
|
337
|
+
risk_level: medium
|
|
338
|
+
requires_confirmation: false
|
|
322
339
|
idempotent: true
|
|
323
|
-
|
|
340
|
+
side_effects:
|
|
324
341
|
- file_write
|
|
325
|
-
|
|
342
|
+
recommended_before_use:
|
|
326
343
|
- Ensure embedoc.config.yaml exists (run init if needed).
|
|
327
344
|
- Verify datasource files are accessible.
|