asciidoc-pubkit 1.0.1 → 1.0.2
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +11 -0
- data/README.md +8 -5
- data/data/review-rules.ja.yml +24 -0
- data/docs/document-commands.md +1 -1
- data/docs/installation.md +2 -2
- data/docs/prose-evaluation.md +14 -3
- data/docs/review-workflow.md +12 -1
- data/docs/rules-and-coverage.md +2 -2
- data/docs/writing.md +1 -1
- data/lib/asciidoc_pubkit.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 905d849fe8f73050f29a9a30178a97487220b732b9d4b512e239708cd4141183
|
|
4
|
+
data.tar.gz: 49fda58238752aa5428f5ae01dcecd2ee064647686f42e98daf36cf47114d67b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1f4faad90e82bbfcdff69672807169610db35c9eb36d0863f32e5a3d44af97e2d67ebdcdea6505197a3163cc65c3eed2232dc236f2078415776acfe60358bfcf
|
|
7
|
+
data.tar.gz: 99c3dc7d0c57ac49d05340e29e4a224eb2676a3a26ba52c6ad2f44691dfa7e8cf3b74b82992bffa7eaa3e714098caf236cf21e7b4f6eab4bd2d56dd369e07330
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.0.2 — 2026-10-05
|
|
4
|
+
|
|
5
|
+
- Add contextual prose candidates for 分かる, 置く, 変える, 発火, 短い, and 長い,
|
|
6
|
+
including MeCab potential forms of 作る such as 作れます. Preserve inflection,
|
|
7
|
+
negation, allow lists, and protected inline content; these are review hints,
|
|
8
|
+
not prohibited words or automatic replacements.
|
|
9
|
+
- Extend development revision calibration from 20 to 31 pairs with operation,
|
|
10
|
+
capability, comparison, reference, dependency, and responsibility distinctions.
|
|
11
|
+
Include faithful revisions and unresolved evidence as controls; automated
|
|
12
|
+
fixture tests do not establish AI editorial accuracy.
|
|
13
|
+
|
|
3
14
|
## 1.0.1 — 2026-10-05
|
|
4
15
|
|
|
5
16
|
- Explain the project's publishing background and link the book catalogs without
|
data/README.md
CHANGED
|
@@ -16,7 +16,7 @@ and books on health, exercise, and sports science published under
|
|
|
16
16
|
The experience informs the toolkit's writing criteria, contextual review prompts,
|
|
17
17
|
and checks for preserving manuscript content during revision.
|
|
18
18
|
|
|
19
|
-
Version 1.0.
|
|
19
|
+
Version 1.0.2 provides document inspection, explicit prose-only mechanical
|
|
20
20
|
replacements, and Japanese manuscript review. Inspect a book's outline,
|
|
21
21
|
metadata, and local cross-references; preview and apply your replacement rules;
|
|
22
22
|
then review and verify edits against a saved baseline.
|
|
@@ -26,7 +26,7 @@ Japanese manuscript excerpts and rule terms retain their original text.
|
|
|
26
26
|
|
|
27
27
|
## Available features
|
|
28
28
|
|
|
29
|
-
The following commands are available in version 1.0.
|
|
29
|
+
The following commands are available in version 1.0.2.
|
|
30
30
|
|
|
31
31
|
| Feature | Commands | Behavior |
|
|
32
32
|
| --- | --- | --- |
|
|
@@ -44,7 +44,7 @@ The following commands are available in version 1.0.1.
|
|
|
44
44
|
| [Manuscript scoring](docs/scoring.md#score-an-asciidoc-manuscript) | `review score` | Report a prose candidate-density score; explicit `--agent codex` or `--agent claude` optionally invokes a local AI CLI for readability ratings |
|
|
45
45
|
| [Writing criteria and prompts](docs/writing.md#writing-commands) | `writing criteria`, `writing prompt` | Print Japanese prose criteria or generate a writing prompt without a manuscript or MeCab |
|
|
46
46
|
|
|
47
|
-
Version 1.0.1
|
|
47
|
+
Version 1.0.1 extended the [shared writing criteria](docs/writing.md#writing-commands)
|
|
48
48
|
with structural comparison before and after revision and preservation of sentence
|
|
49
49
|
functions and plain or polite style. The [development evaluation](docs/prose-evaluation.md)
|
|
50
50
|
includes new cases for these checks.
|
|
@@ -68,6 +68,9 @@ installed AI CLI, which may use its configured model provider.
|
|
|
68
68
|
Findings are review candidates; verification checks mechanical preservation and
|
|
69
69
|
keeps `meaning_verified: false`. The CLI does not publish books or provide EPUB,
|
|
70
70
|
image, or book scaffolding commands.
|
|
71
|
+
The packaged prose rules also flag broad operation and degree wording such as
|
|
72
|
+
`分かる`, `置く`, `変える`, `発火`, `短い`, `長い`, and `作れます` for contextual
|
|
73
|
+
review. Precise everyday language may remain; see the [review guide](docs/review-workflow.md).
|
|
71
74
|
|
|
72
75
|
## Install
|
|
73
76
|
|
|
@@ -78,7 +81,7 @@ asciidoc-pubkit --help
|
|
|
78
81
|
```
|
|
79
82
|
|
|
80
83
|
To update, run `gem update asciidoc-pubkit`. For Bundler, add
|
|
81
|
-
`gem 'asciidoc-pubkit', '~> 1.0.
|
|
84
|
+
`gem 'asciidoc-pubkit', '~> 1.0.2'` to your project's `Gemfile` and run commands
|
|
82
85
|
through `bundle exec`. See [source installation and local checkout usage](docs/installation.md).
|
|
83
86
|
|
|
84
87
|
## Quick start
|
|
@@ -118,7 +121,7 @@ asciidoc-pubkit writing prompt --lang ja --output writing-prompt.md
|
|
|
118
121
|
|
|
119
122
|
Existing review sessions require the exact tool version that created them.
|
|
120
123
|
Before upgrading, finish ongoing reviews with that version or preserve their
|
|
121
|
-
baselines and start a new review in a separate directory with v1.0.
|
|
124
|
+
baselines and start a new review in a separate directory with v1.0.2. A new
|
|
122
125
|
scan cannot verify preservation relative to an earlier baseline.
|
|
123
126
|
|
|
124
127
|
## Documentation
|
data/data/review-rules.ja.yml
CHANGED
|
@@ -34,6 +34,8 @@ terms:
|
|
|
34
34
|
# Review context before choosing a katakana technical term.
|
|
35
35
|
- 木
|
|
36
36
|
- 余白
|
|
37
|
+
# Event or operation wording requires context, not a fixed synonym.
|
|
38
|
+
- 発火
|
|
37
39
|
question: Identify the concrete referent, components, role, or measurable work.
|
|
38
40
|
For 入口, apply the shared role-metaphor criteria; a clear referent alone is
|
|
39
41
|
not a sufficient reason to keep vague operation wording. Keep
|
|
@@ -51,6 +53,9 @@ terms:
|
|
|
51
53
|
- 意味しません
|
|
52
54
|
- 把握します
|
|
53
55
|
- 捉えます
|
|
56
|
+
- 分かる
|
|
57
|
+
- 分かります
|
|
58
|
+
- 分かりません
|
|
54
59
|
# Writing, representation, and inspection.
|
|
55
60
|
- 記述します
|
|
56
61
|
- 記述できます
|
|
@@ -79,6 +84,9 @@ terms:
|
|
|
79
84
|
# Construction, preparation, and combination.
|
|
80
85
|
- 用意します
|
|
81
86
|
- 作ります
|
|
87
|
+
- 作れる
|
|
88
|
+
- 作れます
|
|
89
|
+
- 作れません
|
|
82
90
|
- 組み立てられます
|
|
83
91
|
- 組み合わせます
|
|
84
92
|
- 積み重なります
|
|
@@ -104,6 +112,12 @@ terms:
|
|
|
104
112
|
- 決まります
|
|
105
113
|
# Change, transfer, and retention.
|
|
106
114
|
- 変わります
|
|
115
|
+
- 変える
|
|
116
|
+
- 変えます
|
|
117
|
+
- 置く
|
|
118
|
+
- 置きます
|
|
119
|
+
- 発火します
|
|
120
|
+
- 発火させます
|
|
107
121
|
- 書き換える
|
|
108
122
|
- 置き換えます
|
|
109
123
|
- 加えます
|
|
@@ -131,6 +145,8 @@ terms:
|
|
|
131
145
|
terms:
|
|
132
146
|
- 浅い
|
|
133
147
|
- 深い
|
|
148
|
+
- 短い
|
|
149
|
+
- 長い
|
|
134
150
|
question: Identify the concrete depth, level, scope, or comparison. Keep literal
|
|
135
151
|
measurements and established technical meanings.
|
|
136
152
|
contextual-phrase:
|
|
@@ -241,6 +257,12 @@ verbs:
|
|
|
241
257
|
- 見落とす
|
|
242
258
|
示す:
|
|
243
259
|
- 示す
|
|
260
|
+
分かる:
|
|
261
|
+
- 分かる
|
|
262
|
+
置く:
|
|
263
|
+
- 置く
|
|
264
|
+
変える:
|
|
265
|
+
- 変える
|
|
244
266
|
変わる:
|
|
245
267
|
- 変わる
|
|
246
268
|
分ける:
|
|
@@ -311,6 +333,7 @@ verbs:
|
|
|
311
333
|
- 調べる
|
|
312
334
|
作る:
|
|
313
335
|
- 作る
|
|
336
|
+
- 作れる
|
|
314
337
|
抜ける:
|
|
315
338
|
- 抜ける
|
|
316
339
|
捉える:
|
|
@@ -331,6 +354,7 @@ verbs:
|
|
|
331
354
|
ある:
|
|
332
355
|
- ある
|
|
333
356
|
sahen:
|
|
357
|
+
- 発火
|
|
334
358
|
- 利用
|
|
335
359
|
- 整理
|
|
336
360
|
- 把握
|
data/docs/document-commands.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Document commands
|
|
2
2
|
|
|
3
|
-
Version 1.0.
|
|
3
|
+
Version 1.0.2 provides four read-only document commands. They require neither
|
|
4
4
|
MeCab nor an AI CLI, accept documents in any language, and do not create review
|
|
5
5
|
sessions or change manuscripts.
|
|
6
6
|
|
data/docs/installation.md
CHANGED
|
@@ -41,7 +41,7 @@ Add the gem to your project's `Gemfile` to manage its version with Bundler:
|
|
|
41
41
|
|
|
42
42
|
```ruby
|
|
43
43
|
source 'https://rubygems.org'
|
|
44
|
-
gem 'asciidoc-pubkit', '~> 1.0.
|
|
44
|
+
gem 'asciidoc-pubkit', '~> 1.0.2'
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
Then install dependencies and run the CLI through Bundler:
|
|
@@ -66,7 +66,7 @@ git clone https://github.com/cybergarage/asciidoc-pubkit.git
|
|
|
66
66
|
cd asciidoc-pubkit
|
|
67
67
|
bundle install
|
|
68
68
|
gem build asciidoc-pubkit.gemspec
|
|
69
|
-
gem install ./asciidoc-pubkit-1.0.
|
|
69
|
+
gem install ./asciidoc-pubkit-1.0.2.gem
|
|
70
70
|
asciidoc-pubkit --version
|
|
71
71
|
```
|
|
72
72
|
|
data/docs/prose-evaluation.md
CHANGED
|
@@ -5,8 +5,8 @@ criteria changes against a project-defined baseline. Keep detection performance,
|
|
|
5
5
|
readability, and meaning preservation separate so that a clearer rewrite cannot
|
|
6
6
|
hide a lost condition or invented fact.
|
|
7
7
|
|
|
8
|
-
This guide describes
|
|
9
|
-
`technical-prose-v2` corpus and
|
|
8
|
+
This guide describes version 1.0.2, including the
|
|
9
|
+
`technical-prose-v2` corpus and expanded revision calibration. The evaluation runner is not an
|
|
10
10
|
installed gem command. It does not measure Japanese naturalness or AI authorship
|
|
11
11
|
as a single validated score.
|
|
12
12
|
|
|
@@ -42,7 +42,7 @@ of Japanese writing.
|
|
|
42
42
|
| [prose_benchmark.ja.adoc](../test/fixtures/prose_benchmark.ja.adoc) | 21 paragraphs used as the actual AsciiDoc input |
|
|
43
43
|
| [prose_benchmark.ja.json](../test/fixtures/prose_benchmark.ja.json) | Matching paragraph IDs and text, 11 annotated detector targets, and preservation checklists |
|
|
44
44
|
| [prose_benchmark.yml](../test/fixtures/prose_benchmark.yml) | Fixed empty configuration that isolates the benchmark from discovered manuscript settings |
|
|
45
|
-
| [prose_evaluation.ja.json](../test/fixtures/prose_evaluation.ja.json) | Detection examples and
|
|
45
|
+
| [prose_evaluation.ja.json](../test/fixtures/prose_evaluation.ja.json) | Detection examples and 31 manual revision pairs with expected `accept`, `reject`, or `needs-evidence` dispositions |
|
|
46
46
|
|
|
47
47
|
The corpus includes framing such as `重要なのは`, metaphorical operations such
|
|
48
48
|
as `地味に効く`, inflected and negative forms, and repeated endings. Controls
|
|
@@ -66,6 +66,17 @@ incorrectly extended to audit logging, independent checks made conditional, and
|
|
|
66
66
|
an unsolicited change from plain to polite style. Acceptable pairs and unresolved
|
|
67
67
|
cases prevent calibration from treating every change as an error.
|
|
68
68
|
|
|
69
|
+
Eleven further pairs cover path length changed into performance, capability
|
|
70
|
+
expanded into reuse, reconstruction changed into guaranteed shortening,
|
|
71
|
+
separate operations claimed to be independent, references changed into loaded
|
|
72
|
+
content, optional inheritance made mandatory, user-side storage assumed local,
|
|
73
|
+
and policy definition confused with enforcement. Controls retain precise plain
|
|
74
|
+
verbs or replace relative wording with supported counts and event operations.
|
|
75
|
+
Unsupported details use `needs-evidence`; contradictions and lost explicit
|
|
76
|
+
conditions use `reject`. These are original editorial fixtures, not manuscript
|
|
77
|
+
excerpts. The 21-paragraph corpus and judge rubric are unchanged, but the changed
|
|
78
|
+
calibration fingerprint requires a new AI baseline for comparison.
|
|
79
|
+
|
|
69
80
|
## What normal tests check
|
|
70
81
|
|
|
71
82
|
Run the complete suite from the repository root with MeCab and UTF-8 IPADIC
|
data/docs/review-workflow.md
CHANGED
|
@@ -151,7 +151,7 @@ manuscripts. Numeric title changes
|
|
|
151
151
|
are manual-review notices, and remaining candidates do not fail verification.
|
|
152
152
|
`meaning_verified` remains `false`.
|
|
153
153
|
|
|
154
|
-
Version 1.0.
|
|
154
|
+
Version 1.0.2 uses session schema 3 and requires the exact tool version saved in
|
|
155
155
|
the session. Preserve or finish an ongoing review with its original tool before
|
|
156
156
|
establishing a new baseline in a separate directory.
|
|
157
157
|
`review score` continues to support prose only and rejects `--scope`.
|
|
@@ -188,6 +188,17 @@ one-based Unicode source columns. MeCab remains the default; only explicit
|
|
|
188
188
|
|
|
189
189
|
### Prompt
|
|
190
190
|
|
|
191
|
+
Version 1.0.2 adds packaged prose candidates for
|
|
192
|
+
`分かる`, `置く`, `変える`, `発火`, `短い`, `長い`, and potential forms of `作る`
|
|
193
|
+
such as `作れます`. MeCab detects configured lemmas with inflection and negation;
|
|
194
|
+
literal mode matches only the explicitly registered surfaces. `発火` is also a
|
|
195
|
+
noun candidate, for example in a condition description.
|
|
196
|
+
These hints ask for context, not formal synonyms: a short path does not establish
|
|
197
|
+
low resource use, and an available operation does not establish reuse. Keep
|
|
198
|
+
precise plain verbs, literal lengths, and established event terminology when
|
|
199
|
+
appropriate. Allow lists and inline protection still apply. Custom rules replace
|
|
200
|
+
the packaged set, and existing sessions keep their saved rules.
|
|
201
|
+
|
|
191
202
|
```sh
|
|
192
203
|
asciidoc-pubkit review prompt .pubkit/review --mode revise --output review-prompt.md
|
|
193
204
|
asciidoc-pubkit review prompt .pubkit/review --mode diagnose
|
data/docs/rules-and-coverage.md
CHANGED
|
@@ -131,13 +131,13 @@ reports analyzer changes instead of treating results from different dictionaries
|
|
|
131
131
|
as directly comparable. Prompt generation uses saved evidence and does not need
|
|
132
132
|
MeCab. Changed rules or dictionary settings require a new scan.
|
|
133
133
|
|
|
134
|
-
Version 1.0.
|
|
134
|
+
Version 1.0.2 uses session schema 3.
|
|
135
135
|
Sessions with a different schema or tool version cannot be loaded. Keep the original baseline for
|
|
136
136
|
an ongoing review and finish it with the original version, or start a new review
|
|
137
137
|
pass in a different directory:
|
|
138
138
|
|
|
139
139
|
```sh
|
|
140
|
-
asciidoc-pubkit review scan book.adoc --output .pubkit/review-1.0.
|
|
140
|
+
asciidoc-pubkit review scan book.adoc --output .pubkit/review-1.0.2
|
|
141
141
|
```
|
|
142
142
|
|
|
143
143
|
Severity describes review priority, not proof of an error. There is no AI-authorship
|
data/docs/writing.md
CHANGED
|
@@ -24,7 +24,7 @@ asciidoc-pubkit writing prompt --lang ja --output writing-prompt.md
|
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
For example, `--lang en` exits with an unsupported-language error. No English
|
|
27
|
-
review or writing criteria are shipped in 1.0.
|
|
27
|
+
review or writing criteria are shipped in 1.0.2.
|
|
28
28
|
|
|
29
29
|
For a small trial, use `examples/book.adoc` as the scan input. Its Japanese
|
|
30
30
|
paragraphs deliberately contain review candidates; its code block must remain
|
data/lib/asciidoc_pubkit.rb
CHANGED