@baiyibai-antora/extensions 1.0.0

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.
Files changed (28) hide show
  1. package/CHANGELOG.adoc +130 -0
  2. package/LICENSE +21 -0
  3. package/README.adoc +645 -0
  4. package/dist/extensions/asciidoctorconfig/index.d.ts +71 -0
  5. package/dist/extensions/asciidoctorconfig/index.d.ts.map +1 -0
  6. package/dist/extensions/asciidoctorconfig/index.js +207 -0
  7. package/dist/extensions/asciidoctorconfig/index.js.map +1 -0
  8. package/dist/extensions/assembler-rename-pdf/index.d.ts +79 -0
  9. package/dist/extensions/assembler-rename-pdf/index.d.ts.map +1 -0
  10. package/dist/extensions/assembler-rename-pdf/index.js +267 -0
  11. package/dist/extensions/assembler-rename-pdf/index.js.map +1 -0
  12. package/dist/extensions/assembler-ruby-preflight/index.d.ts +76 -0
  13. package/dist/extensions/assembler-ruby-preflight/index.d.ts.map +1 -0
  14. package/dist/extensions/assembler-ruby-preflight/index.js +458 -0
  15. package/dist/extensions/assembler-ruby-preflight/index.js.map +1 -0
  16. package/dist/extensions/collector-writer/index.d.ts +79 -0
  17. package/dist/extensions/collector-writer/index.d.ts.map +1 -0
  18. package/dist/extensions/collector-writer/index.js +248 -0
  19. package/dist/extensions/collector-writer/index.js.map +1 -0
  20. package/dist/extensions/external-asset-downloader/index.d.ts +73 -0
  21. package/dist/extensions/external-asset-downloader/index.d.ts.map +1 -0
  22. package/dist/extensions/external-asset-downloader/index.js +387 -0
  23. package/dist/extensions/external-asset-downloader/index.js.map +1 -0
  24. package/dist/extensions/vale-integration/index.d.ts +76 -0
  25. package/dist/extensions/vale-integration/index.d.ts.map +1 -0
  26. package/dist/extensions/vale-integration/index.js +409 -0
  27. package/dist/extensions/vale-integration/index.js.map +1 -0
  28. package/package.json +72 -0
@@ -0,0 +1,248 @@
1
+ "use strict";
2
+ /**
3
+ * @baiyibai-antora/docs-extensions - collector-writer
4
+ *
5
+ * Copies assets discovered by @antora/collector-extension from the Antora
6
+ * content catalog into local folders for downstream use (themes, vale rules, etc.).
7
+ *
8
+ * Configuration in antora-playbook.yml:
9
+ *
10
+ * antora:
11
+ * extensions:
12
+ * - require: '@antora/collector-extension'
13
+ * - require: '@baiyibai-antora/docs-extensions/extensions/collector-writer'
14
+ * collectorWriter:
15
+ * enabled: true
16
+ * quiet: false
17
+ * targets:
18
+ * - component: vale-styles
19
+ * write_dir: ./vale-rules
20
+ * ephemeral: true
21
+ * - component: pdf-themes
22
+ * write_dir: ./assembler-themes
23
+ * ephemeral: false
24
+ */
25
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
26
+ if (k2 === undefined) k2 = k;
27
+ var desc = Object.getOwnPropertyDescriptor(m, k);
28
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
29
+ desc = { enumerable: true, get: function() { return m[k]; } };
30
+ }
31
+ Object.defineProperty(o, k2, desc);
32
+ }) : (function(o, m, k, k2) {
33
+ if (k2 === undefined) k2 = k;
34
+ o[k2] = m[k];
35
+ }));
36
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
37
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
38
+ }) : function(o, v) {
39
+ o["default"] = v;
40
+ });
41
+ var __importStar = (this && this.__importStar) || (function () {
42
+ var ownKeys = function(o) {
43
+ ownKeys = Object.getOwnPropertyNames || function (o) {
44
+ var ar = [];
45
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
46
+ return ar;
47
+ };
48
+ return ownKeys(o);
49
+ };
50
+ return function (mod) {
51
+ if (mod && mod.__esModule) return mod;
52
+ var result = {};
53
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
54
+ __setModuleDefault(result, mod);
55
+ return result;
56
+ };
57
+ })();
58
+ Object.defineProperty(exports, "__esModule", { value: true });
59
+ exports.register = register;
60
+ const fsp = __importStar(require("node:fs/promises"));
61
+ const path = __importStar(require("path"));
62
+ function timestamp() {
63
+ return new Date().toISOString().split('T')[1].replace('Z', '');
64
+ }
65
+ function logEvent(message) {
66
+ console.log(`[${timestamp()}] \x1b[94mEVENT\x1b[0m (antora-collector-writer): \x1b[94m${message}\x1b[0m`);
67
+ }
68
+ let quietMode = true;
69
+ function makeLogger(hostLogger) {
70
+ const log = hostLogger || console;
71
+ return {
72
+ debug: (m) => {
73
+ if (!quietMode)
74
+ (log.debug ? log.debug(m) : console.debug(m));
75
+ },
76
+ info: (m) => {
77
+ if (!quietMode)
78
+ (log.info ? log.info(m) : console.log(m));
79
+ },
80
+ warn: (m) => {
81
+ (log.warn ? log.warn(m) : console.warn(m));
82
+ },
83
+ error: (m) => {
84
+ (log.error ? log.error(m) : console.error(m));
85
+ },
86
+ };
87
+ }
88
+ function toBool(v) {
89
+ if (v === true)
90
+ return true;
91
+ if (v === false)
92
+ return false;
93
+ if (typeof v === 'string') {
94
+ const s = v.trim().toLowerCase();
95
+ if (['true', '1', 'yes', 'on'].includes(s))
96
+ return true;
97
+ if (['false', '0', 'no', 'off'].includes(s))
98
+ return false;
99
+ }
100
+ return Boolean(v);
101
+ }
102
+ function pick(obj, keys, def) {
103
+ for (const k of keys) {
104
+ if (obj && obj[k] !== undefined)
105
+ return obj[k];
106
+ }
107
+ return def;
108
+ }
109
+ function ensureArray(v) {
110
+ return Array.isArray(v) ? v : v ? [v] : [];
111
+ }
112
+ function register(context) {
113
+ const logger = makeLogger(context.getLogger ? context.getLogger('antora-collector-writer') : undefined);
114
+ let cfg = {
115
+ enabled: true,
116
+ quiet: true,
117
+ output_dir: 'vale-output',
118
+ targets: [],
119
+ required: [],
120
+ };
121
+ context.once('playbookBuilt', async ({ playbook }) => {
122
+ try {
123
+ const extArray = Array.isArray(playbook?.antora?.extensions) ? playbook.antora.extensions : [];
124
+ const selected = extArray.find((ext) => String(ext.require || '').includes('collector-writer')) || {};
125
+ const extConf = selected.collectorWriter || selected.collectorwriter || {};
126
+ cfg = {
127
+ enabled: toBool(pick(extConf, ['enabled'], cfg.enabled)),
128
+ quiet: toBool(pick(extConf, ['quiet'], cfg.quiet)),
129
+ output_dir: String(pick(extConf, ['output_dir', 'outputdir'], cfg.output_dir)) || 'vale-output',
130
+ targets: ensureArray(pick(extConf, ['targets'], cfg.targets)),
131
+ required: ensureArray(pick(extConf, ['required'], cfg.required)),
132
+ };
133
+ quietMode = !!cfg.quiet;
134
+ logger.debug('=== collector-writer configuration ===');
135
+ logger.debug(JSON.stringify(cfg, null, 2));
136
+ }
137
+ catch (err) {
138
+ logger.error(`Config discovery failed: ${err.message}`);
139
+ }
140
+ });
141
+ context.once('contentClassified', async ({ playbook, contentCatalog }) => {
142
+ try {
143
+ if (!cfg.enabled) {
144
+ logger.debug('Collector Writer Disabled (skipped)');
145
+ return;
146
+ }
147
+ if (!contentCatalog) {
148
+ logger.error('contentCatalog is missing');
149
+ return;
150
+ }
151
+ const allFiles = contentCatalog.getFiles();
152
+ logger.debug(`=== CATALOG INSPECTION ===`);
153
+ logger.debug(`Total files in catalog: ${allFiles.length}`);
154
+ const byComponent = {};
155
+ allFiles.forEach((f) => {
156
+ const comp = f.src?.component || 'unknown';
157
+ if (!byComponent[comp])
158
+ byComponent[comp] = [];
159
+ byComponent[comp].push(f);
160
+ });
161
+ Object.keys(byComponent)
162
+ .sort()
163
+ .forEach((comp) => {
164
+ logger.debug(`Component '${comp}': ${byComponent[comp].length} files`);
165
+ byComponent[comp].slice(0, 10).forEach((f) => {
166
+ logger.debug(` - ${f.src?.relative || f.path} (ext: '${f.src?.extname || 'none'}', basename: '${f.src?.basename || 'none'}')`);
167
+ });
168
+ if (byComponent[comp].length > 10) {
169
+ logger.debug(` ... and ${byComponent[comp].length - 10} more files`);
170
+ }
171
+ });
172
+ const projectRoot = path.resolve(playbook?.dir || process.cwd());
173
+ const cleanupPaths = new Set();
174
+ const effectiveTargets = [];
175
+ for (const t of cfg.targets) {
176
+ const tObj = t;
177
+ const writeDir = pick(tObj, ['write_dir', 'writeDir', 'writedir'], 'target');
178
+ effectiveTargets.push({
179
+ component: String(t.component || '').trim(),
180
+ write_dir: path.resolve(projectRoot, String(writeDir)),
181
+ ephemeral: toBool(pick(tObj, ['ephemeral'], true)),
182
+ });
183
+ }
184
+ for (const r of cfg.required) {
185
+ const component = String(r.component || '').trim();
186
+ const target = String(r.target || '').trim();
187
+ if (!component || !target)
188
+ continue;
189
+ effectiveTargets.push({
190
+ component,
191
+ write_dir: path.resolve(projectRoot, target),
192
+ ephemeral: toBool(pick(r, ['ephemeral'], true)),
193
+ });
194
+ }
195
+ logger.debug('=== Effective targets ===');
196
+ logger.debug(JSON.stringify(effectiveTargets, null, 2));
197
+ let totalWrites = 0;
198
+ for (const t of effectiveTargets) {
199
+ const { component, write_dir, ephemeral } = t;
200
+ if (!component) {
201
+ logger.warn(`Target '${component || write_dir}': component not specified — skipping`);
202
+ continue;
203
+ }
204
+ await fsp.rm(write_dir, { recursive: true, force: true });
205
+ await fsp.mkdir(write_dir, { recursive: true });
206
+ logger.debug(`Cleared and recreated: ${write_dir}`);
207
+ if (ephemeral)
208
+ cleanupPaths.add(write_dir);
209
+ const files = contentCatalog.getFiles().filter((f) => f.src?.component === component);
210
+ logger.debug(`=== ALL FILES in catalog for component '${component}' ===`);
211
+ files.forEach((f) => {
212
+ logger.debug(` - ${f.path || f.src?.relative || 'unknown'}`);
213
+ logger.debug(` basename: '${f.src?.basename}', stem: '${f.src?.stem}', extname: '${f.src?.extname}'`);
214
+ });
215
+ const noExtFiles = files.filter((f) => !f.src?.extname || f.src.extname === '');
216
+ logger.debug(`=== FILES WITHOUT EXTENSION (${noExtFiles.length}) ===`);
217
+ noExtFiles.forEach((f) => {
218
+ logger.debug(` - ${f.path || f.src?.relative}`);
219
+ });
220
+ logger.debug(`Target '${component}' matched ${files.length} file(s)`);
221
+ for (const f of files) {
222
+ let rel = String(f.src?.relative || '').replace(/\\/g, '/');
223
+ const targetPath = path.join(write_dir, rel);
224
+ await fsp.mkdir(path.dirname(targetPath), { recursive: true });
225
+ await fsp.writeFile(targetPath, Buffer.from(f.contents));
226
+ totalWrites++;
227
+ logger.debug(`wrote: ${targetPath}`);
228
+ }
229
+ }
230
+ logEvent(`Collector wrote ${totalWrites} temporary file(s) to disk`);
231
+ context.once('sitePublished', async () => {
232
+ for (const p of cleanupPaths) {
233
+ try {
234
+ await fsp.rm(p, { recursive: true, force: true });
235
+ logger.debug(`Cleaned up ephemeral target: ${p}`);
236
+ }
237
+ catch (err) {
238
+ logger.warn(`Could not clean up '${p}': ${err.message}`);
239
+ }
240
+ }
241
+ });
242
+ }
243
+ catch (e) {
244
+ logger.error(`Collector Writer failed: ${e.message}`);
245
+ }
246
+ });
247
+ }
248
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/extensions/collector-writer/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8HH,4BAgKC;AA5RD,sDAAwC;AACxC,2CAA6B;AAyE7B,SAAS,SAAS;IAChB,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,QAAQ,CAAC,OAAe;IAC/B,OAAO,CAAC,GAAG,CAAC,IAAI,SAAS,EAAE,6DAA6D,OAAO,SAAS,CAAC,CAAC;AAC5G,CAAC;AAED,IAAI,SAAS,GAAG,IAAI,CAAC;AAErB,SAAS,UAAU,CAAC,UAAyB;IAC3C,MAAM,GAAG,GAAG,UAAU,IAAI,OAAO,CAAC;IAClC,OAAO;QACL,KAAK,EAAE,CAAC,CAAS,EAAQ,EAAE;YACzB,IAAI,CAAC,SAAS;gBAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,EAAE,CAAC,CAAS,EAAQ,EAAE;YACxB,IAAI,CAAC,SAAS;gBAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,EAAE,CAAC,CAAS,EAAQ,EAAE;YACxB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC;QACD,KAAK,EAAE,CAAC,CAAS,EAAQ,EAAE;YACzB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,CAAU;IACxB,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC5B,IAAI,CAAC,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IAC9B,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC1B,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACxD,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;IAC5D,CAAC;IACD,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC;AAED,SAAS,IAAI,CAAI,GAAwC,EAAE,IAAc,EAAE,GAAM;IAC/E,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QACrB,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS;YAAE,OAAO,GAAG,CAAC,CAAC,CAAM,CAAC;IACtD,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,WAAW,CAAI,CAAsB;IAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC7C,CAAC;AAED,SAAgB,QAAQ,CAAC,OAAiB;IACxC,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAExG,IAAI,GAAG,GAA0B;QAC/B,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,IAAI;QACX,UAAU,EAAE,aAAa;QACzB,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,EAAE;KACb,CAAC;IAEF,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;QACnD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/F,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACrC,MAAM,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CACvD,IAAI,EAAE,CAAC;YACR,MAAM,OAAO,GAAG,QAAQ,CAAC,eAAe,IAAI,QAAQ,CAAC,eAAe,IAAI,EAAE,CAAC;YAE3E,GAAG,GAAG;gBACJ,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAkC,EAAE,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;gBACnF,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,OAAkC,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;gBAC7E,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,OAAkC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,aAAa;gBAC1H,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,OAAkC,EAAE,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;gBACxF,QAAQ,EAAE,WAAW,CAAC,IAAI,CAAC,OAAkC,EAAE,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;aAC5F,CAAC;YAEF,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC;YACxB,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;YACvD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,KAAK,CAAC,4BAA6B,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;QACrE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,cAAc,EAAE,EAAE,EAAE;QACvE,IAAI,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;gBACpD,OAAO;YACT,CAAC;YAED,IAAI,CAAC,cAAc,EAAE,CAAC;gBACpB,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;gBAC1C,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC;YAC3C,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAC3C,MAAM,CAAC,KAAK,CAAC,2BAA2B,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAE3D,MAAM,WAAW,GAAkC,EAAE,CAAC;YACtD,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBACrB,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,SAAS,CAAC;gBAC3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;oBAAE,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/C,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5B,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;iBACrB,IAAI,EAAE;iBACN,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChB,MAAM,CAAC,KAAK,CAAC,cAAc,IAAI,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,QAAQ,CAAC,CAAC;gBACvE,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBAC3C,MAAM,CAAC,KAAK,CACV,OAAO,CAAC,CAAC,GAAG,EAAE,QAAQ,IAAI,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,GAAG,EAAE,OAAO,IAAI,MAAM,iBAAiB,CAAC,CAAC,GAAG,EAAE,QAAQ,IAAI,MAAM,IAAI,CAClH,CAAC;gBACJ,CAAC,CAAC,CAAC;gBACH,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;oBAClC,MAAM,CAAC,KAAK,CAAC,aAAa,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,EAAE,aAAa,CAAC,CAAC;gBACxE,CAAC;YACH,CAAC,CAAC,CAAC;YAEL,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YACjE,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;YAEvC,MAAM,gBAAgB,GAAa,EAAE,CAAC;YAEtC,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;gBAC5B,MAAM,IAAI,GAAG,CAAuC,CAAC;gBACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC7E,gBAAgB,CAAC,IAAI,CAAC;oBACpB,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;oBAC3C,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;oBACtD,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC;iBACnD,CAAC,CAAC;YACL,CAAC;YAED,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBAC7B,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;gBACnD,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;gBAC7C,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM;oBAAE,SAAS;gBACpC,gBAAgB,CAAC,IAAI,CAAC;oBACpB,SAAS;oBACT,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC;oBAC5C,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,CAAuC,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC;iBACtF,CAAC,CAAC;YACL,CAAC;YAED,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAC1C,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAExD,IAAI,WAAW,GAAG,CAAC,CAAC;YAEpB,KAAK,MAAM,CAAC,IAAI,gBAAgB,EAAE,CAAC;gBACjC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;gBAE9C,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,MAAM,CAAC,IAAI,CAAC,WAAW,SAAS,IAAI,SAAS,uCAAuC,CAAC,CAAC;oBACtF,SAAS;gBACX,CAAC;gBAED,MAAM,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC1D,MAAM,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAChD,MAAM,CAAC,KAAK,CAAC,0BAA0B,SAAS,EAAE,CAAC,CAAC;gBAEpD,IAAI,SAAS;oBAAE,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBAE3C,MAAM,KAAK,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,KAAK,SAAS,CAAC,CAAC;gBAEtF,MAAM,CAAC,KAAK,CAAC,2CAA2C,SAAS,OAAO,CAAC,CAAC;gBAC1E,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBAClB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,EAAE,QAAQ,IAAI,SAAS,EAAE,CAAC,CAAC;oBAC9D,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,QAAQ,aAAa,CAAC,CAAC,GAAG,EAAE,IAAI,gBAAgB,CAAC,CAAC,GAAG,EAAE,OAAO,GAAG,CAAC,CAAC;gBAC3G,CAAC,CAAC,CAAC;gBAEH,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,KAAK,EAAE,CAAC,CAAC;gBAChF,MAAM,CAAC,KAAK,CAAC,gCAAgC,UAAU,CAAC,MAAM,OAAO,CAAC,CAAC;gBACvE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBACvB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACnD,CAAC,CAAC,CAAC;gBAEH,MAAM,CAAC,KAAK,CAAC,WAAW,SAAS,aAAa,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC;gBAEtE,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;oBACtB,IAAI,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;oBAE5D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;oBAC7C,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC/D,MAAM,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;oBACzD,WAAW,EAAE,CAAC;oBACd,MAAM,CAAC,KAAK,CAAC,UAAU,UAAU,EAAE,CAAC,CAAC;gBACvC,CAAC;YACH,CAAC;YAED,QAAQ,CAAC,mBAAmB,WAAW,4BAA4B,CAAC,CAAC;YAErE,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE;gBACvC,KAAK,MAAM,CAAC,IAAI,YAAY,EAAE,CAAC;oBAC7B,IAAI,CAAC;wBACH,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;wBAClD,MAAM,CAAC,KAAK,CAAC,gCAAgC,CAAC,EAAE,CAAC,CAAC;oBACpD,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAO,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;oBACtE,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,KAAK,CAAC,4BAA6B,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
@@ -0,0 +1,73 @@
1
+ /**
2
+ * @baiyibai-antora/docs-extensions - external-asset-downloader
3
+ *
4
+ * Downloads external assets (images) from HTTP/HTTPS URLs into component directories.
5
+ * Supports both individual file URLs and HTTP directory listings (Apache autoindex style).
6
+ *
7
+ * Configuration in antora-playbook.yml:
8
+ *
9
+ * antora:
10
+ * extensions:
11
+ * - require: '@baiyibai-antora/docs-extensions/extensions/external-asset-downloader'
12
+ * assetDownloader:
13
+ * enabled: true
14
+ * quiet: false
15
+ * attribute_prefix: 'image'
16
+ * include_commented: true
17
+ * target_dir: 'modules/ROOT/images'
18
+ * overwrite: 'never'
19
+ * concurrency: 5
20
+ * directory_listing: true
21
+ * url_replace:
22
+ * - pattern: '/artifactory/'
23
+ * replacement: '/artifactory/api/storage/'
24
+ */
25
+ interface UrlReplaceRule {
26
+ pattern: string;
27
+ replacement: string;
28
+ }
29
+ interface AssetDownloaderConfig {
30
+ enabled: boolean;
31
+ quiet: boolean;
32
+ attribute_prefix: string;
33
+ include_commented: boolean;
34
+ target_dir: string;
35
+ overwrite: 'never' | 'always';
36
+ concurrency: number;
37
+ directory_listing: boolean;
38
+ url_replace: UrlReplaceRule[];
39
+ }
40
+ interface AntoraLogger {
41
+ debug?: (msg: string) => void;
42
+ info?: (msg: string) => void;
43
+ warn?: (msg: string) => void;
44
+ error?: (msg: string) => void;
45
+ }
46
+ interface ExtensionEntry {
47
+ require?: string;
48
+ assetDownloader?: Partial<AssetDownloaderConfig>;
49
+ assetdownloader?: Partial<AssetDownloaderConfig>;
50
+ }
51
+ interface Playbook {
52
+ dir?: string;
53
+ antora?: {
54
+ extensions?: ExtensionEntry[];
55
+ };
56
+ }
57
+ interface ComponentVersionConfig {
58
+ name?: string;
59
+ version?: string;
60
+ asciidoc?: {
61
+ attributes?: Record<string, string>;
62
+ };
63
+ }
64
+ interface Registry {
65
+ getLogger?: (name: string) => AntoraLogger;
66
+ on: (event: string, callback: (context: {
67
+ playbook: Playbook;
68
+ contentAggregate?: ComponentVersionConfig[];
69
+ }) => Promise<void>) => void;
70
+ }
71
+ export declare function register(context: Registry): void;
72
+ export {};
73
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/extensions/external-asset-downloader/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAQH,UAAU,cAAc;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,qBAAqB;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,WAAW,EAAE,cAAc,EAAE,CAAC;CAC/B;AAUD,UAAU,YAAY;IACpB,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9B,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/B;AAED,UAAU,cAAc;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACjD,eAAe,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAClD;AAED,UAAU,QAAQ;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE;QACP,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;KAC/B,CAAC;CACH;AAED,UAAU,sBAAsB;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE;QACT,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACrC,CAAC;CACH;AAED,UAAU,QAAQ;IAChB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,YAAY,CAAC;IAC3C,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,gBAAgB,CAAC,EAAE,sBAAsB,EAAE,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;CACxI;AA2UD,wBAAgB,QAAQ,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAuDhD"}