@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
package/CHANGELOG.adoc ADDED
@@ -0,0 +1,130 @@
1
+ = Changelog
2
+ :toc:
3
+
4
+ All notable changes to this project will be documented in this file.
5
+
6
+ == [1.0.0] - 2026-01-10
7
+
8
+ === Added
9
+
10
+ * *Consolidated Repository*: All six Antora extensions are now available from a single package with subpath exports
11
+ * *vale-integration*: Added `predefined_ignore_files` configuration option for vendorized package.json defaults
12
+
13
+ === Changed
14
+
15
+ * *BREAKING*: All extensions now use snake_case configuration keys exclusively
16
+ * *BREAKING*: Removed camelCase support from all extensions - only snake_case keys are accepted
17
+ * Improved logging: Changed verbose messages from `info` to `debug` level across all extensions
18
+ * Standardized configuration output format (JSON) across all extensions
19
+ * *assembler-ruby-preflight*: Removed Unicode checkmarks for Windows PowerShell compatibility
20
+ * *assembler-ruby-preflight*: Changed EVENT color to dark blue for consistency
21
+
22
+ === Extensions Included
23
+
24
+ This package consolidates the following previously separate extensions:
25
+
26
+ [cols="1,2"]
27
+ |===
28
+ | Extension | Subpath Export
29
+
30
+ | collector-writer
31
+ | `@baiyibai-antora/extensions/collector-writer`
32
+
33
+ | assembler-ruby-preflight
34
+ | `@baiyibai-antora/extensions/assembler-ruby-preflight`
35
+
36
+ | assembler-rename-pdf
37
+ | `@baiyibai-antora/extensions/assembler-rename-pdf`
38
+
39
+ | external-asset-downloader
40
+ | `@baiyibai-antora/extensions/external-asset-downloader`
41
+
42
+ | vale-integration
43
+ | `@baiyibai-antora/extensions/vale-integration`
44
+
45
+ | asciidoctorconfig
46
+ | `@baiyibai-antora/extensions/asciidoctorconfig`
47
+ |===
48
+
49
+ === Configuration Key Changes by Extension
50
+
51
+ ==== collector-writer
52
+
53
+ * `writeDir` -> `write_dir`
54
+ * `outputDir` -> `output_dir`
55
+ * Removed deprecated `name` field (use `component` instead)
56
+
57
+ ==== assembler-ruby-preflight
58
+
59
+ * `gemfilePath` -> `gemfile_path`
60
+ * `useSystemGems` -> `use_system_gems`
61
+ * `rubyVersion` -> `ruby_version`
62
+ * `rubyRevision` -> `ruby_revision`
63
+ * `rubyGuidance` -> `ruby_guidance`
64
+ * `ghostscriptVersion` -> `gs_version`
65
+ * `gsGuidance` -> `gs_guidance`
66
+ * `checkRuby` -> `check_ruby`
67
+ * `checkGhostscript` -> `check_gs`
68
+
69
+ ==== assembler-rename-pdf
70
+
71
+ * `pdfFilenameAttribute` -> `pdf_filename_attribute`
72
+ * `assemblerBaseDir` -> `assembler_base_dir`
73
+ * `siteBaseDir` -> `site_base_dir`
74
+ * `exportsSubdir` -> `exports_subdir`
75
+ * `copyTargetDir` -> `copy_target_dir`
76
+
77
+ ==== external-asset-downloader
78
+
79
+ * `attributePrefix` -> `attribute_prefix`
80
+ * `includeCommented` -> `include_commented`
81
+ * `targetDir` -> `target_dir`
82
+ * `directoryListing` -> `directory_listing`
83
+ * `urlReplace` -> `url_replace`
84
+
85
+ ==== vale-integration
86
+
87
+ * `outputDir` -> `output_dir`
88
+ * `configFile` -> `config_file`
89
+ * `ignoreFiles` -> `ignore_files`
90
+ * `toolchainConfigPath` -> `toolchain_config_path`
91
+ * `maxLogs` -> `max_logs`
92
+ * `listLimit` -> `list_limit`
93
+
94
+ ==== asciidoctorconfig
95
+
96
+ * `asciidoctorconfigAdocFilename` -> `asciidoctorconfig_adoc_filename`
97
+ * `asciidoctorconfigFilename` -> `asciidoctorconfig_filename`
98
+
99
+ === Migration Guide
100
+
101
+ . *Update your `antora-playbook.yml`* to use snake_case configuration keys
102
+
103
+ . *Update your `require` paths* to use the new consolidated package:
104
+ +
105
+ [source,yaml]
106
+ ----
107
+ # Before (separate packages)
108
+ - require: '@baiyibai-antora/antora-collector-writer'
109
+
110
+ # After (consolidated package)
111
+ - require: '@baiyibai-antora/extensions/collector-writer'
112
+ ----
113
+
114
+ . *Remove individual package dependencies* from your `package.json` and add only:
115
+ +
116
+ [source,json]
117
+ ----
118
+ "@baiyibai-antora/extensions": "^1.0.0"
119
+ ----
120
+
121
+ === Deprecated Packages
122
+
123
+ The following individual packages are deprecated in favor of this consolidated package:
124
+
125
+ * `@baiyibai-antora/antora-collector-writer`
126
+ * `@baiyibai-antora/antora-assembler-ruby-preflight`
127
+ * `@baiyibai-antora/antora-assembler-rename-pdf`
128
+ * `@baiyibai-antora/antora-external-asset-downloader`
129
+ * `@baiyibai-antora/antora-vale-integration`
130
+ * `@baiyibai-antora/asciidoctorconfig`
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Baiyibai Docs Team
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.