@rse/ase 0.9.65 → 0.9.67
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/dst/ase-hook.js +1 -1
- package/dst/ase-metric.js +103 -0
- package/dst/ase-mint.js +106 -0
- package/dst/ase-service.js +4 -0
- package/dst/ase-setup.js +133 -1
- package/dst/ase-spec.js +104 -40
- package/dst/ase-statusline.js +11 -2
- package/dst/ase.js +4 -0
- package/package.json +13 -12
- package/plugin/.claude-plugin/plugin.json +1 -1
- package/plugin/.codex-plugin/plugin.json +1 -1
- package/plugin/.github/plugin/plugin.json +1 -1
- package/plugin/agents/ase-docs-proofread.md +13 -7
- package/plugin/agents/ase-docs-refine.md +165 -0
- package/plugin/agents/ase-docs-shorten.md +182 -0
- package/plugin/package.json +4 -4
- package/plugin/skills/ase-arch-analyze/help.md +1 -1
- package/plugin/skills/ase-arch-discover/help.md +4 -4
- package/plugin/skills/ase-code-analyze/help.md +1 -1
- package/plugin/skills/ase-code-craft/help.md +7 -7
- package/plugin/skills/ase-code-dissect/help.md +5 -5
- package/plugin/skills/ase-code-edit/help.md +7 -7
- package/plugin/skills/ase-code-explain/help.md +1 -1
- package/plugin/skills/ase-code-insight/help.md +1 -1
- package/plugin/skills/ase-code-lint/help.md +5 -5
- package/plugin/skills/ase-code-refactor/help.md +6 -6
- package/plugin/skills/ase-code-resolve/help.md +6 -6
- package/plugin/skills/ase-docs-distill/help.md +2 -2
- package/plugin/skills/ase-docs-proofread/SKILL.md +16 -12
- package/plugin/skills/ase-docs-proofread/help.md +18 -8
- package/plugin/skills/ase-docs-refine/SKILL.md +396 -0
- package/plugin/skills/ase-docs-refine/help.md +104 -0
- package/plugin/skills/ase-docs-shorten/SKILL.md +527 -0
- package/plugin/skills/ase-docs-shorten/help.md +120 -0
- package/plugin/skills/ase-help-intent/help.md +1 -1
- package/plugin/skills/ase-help-skill/catalog.md +4 -1
- package/plugin/skills/ase-help-skill/help.md +1 -1
- package/plugin/skills/ase-meta-brainstorm/help.md +5 -5
- package/plugin/skills/ase-meta-chat/help.md +2 -2
- package/plugin/skills/ase-meta-config/help.md +3 -3
- package/plugin/skills/ase-meta-diaboli/help.md +2 -2
- package/plugin/skills/ase-meta-diff/help.md +3 -3
- package/plugin/skills/ase-meta-eli5/help.md +2 -2
- package/plugin/skills/ase-meta-evaluate/help.md +1 -1
- package/plugin/skills/ase-meta-mint/SKILL.md +157 -0
- package/plugin/skills/ase-meta-mint/help.md +114 -0
- package/plugin/skills/ase-meta-proximity/help.md +3 -3
- package/plugin/skills/ase-meta-quorum/help.md +2 -2
- package/plugin/skills/ase-meta-quotes/help.md +4 -4
- package/plugin/skills/ase-meta-review/help.md +1 -1
- package/plugin/skills/ase-meta-search/help.md +2 -2
- package/plugin/skills/ase-meta-steelman/help.md +3 -3
- package/plugin/skills/ase-meta-why/help.md +3 -3
- package/plugin/skills/ase-meta-workflow/SKILL.md +3 -2
- package/plugin/skills/ase-meta-workflow/help.md +4 -4
- package/plugin/skills/ase-meta-workflow/workflow.txt +8 -2
- package/plugin/skills/ase-spec-edit/SKILL.md +1 -1
- package/plugin/skills/ase-spec-edit/help.md +6 -6
- package/plugin/skills/ase-sync-export/SKILL.md +3 -1
- package/plugin/skills/ase-sync-export/help.md +1 -1
- package/plugin/skills/ase-sync-import/SKILL.md +1 -1
- package/plugin/skills/ase-sync-import/help.md +2 -2
- package/plugin/skills/ase-sync-reconcile/SKILL.md +1 -1
- package/plugin/skills/ase-sync-reconcile/help.md +4 -4
- package/plugin/skills/ase-task-condense/SKILL.md +7 -4
- package/plugin/skills/ase-task-condense/help.md +2 -2
- package/plugin/skills/ase-task-delete/help.md +1 -1
- package/plugin/skills/ase-task-dissect/help.md +5 -5
- package/plugin/skills/ase-task-edit/help.md +4 -4
- package/plugin/skills/ase-task-grill/help.md +3 -3
- package/plugin/skills/ase-task-id/help.md +1 -1
- package/plugin/skills/ase-task-implement/help.md +3 -3
- package/plugin/skills/ase-task-list/help.md +3 -3
- package/plugin/skills/ase-task-preflight/help.md +2 -2
- package/plugin/skills/ase-task-reboot/help.md +2 -2
- package/plugin/skills/ase-task-rename/help.md +1 -1
- package/plugin/skills/ase-task-view/help.md +2 -2
|
@@ -32,18 +32,18 @@ entirely and applies the change set to the affected artifacts itself.
|
|
|
32
32
|
|
|
33
33
|
## OPTIONS
|
|
34
34
|
|
|
35
|
-
`--auto`|`-a`:
|
|
35
|
+
- `--auto`|`-a`:
|
|
36
36
|
Automatically pick the recommended feature approach without
|
|
37
37
|
asking the user via the interactive dialog.
|
|
38
38
|
|
|
39
|
-
`--dry`|`-d`:
|
|
39
|
+
- `--dry`|`-d`:
|
|
40
40
|
Compose the plan *without* the `## VERIFICATION` section. When
|
|
41
41
|
`ase-task-implement` later applies such a plan, it strictly skips
|
|
42
42
|
the entire verification phase (no build, tests, linter,
|
|
43
43
|
type-checker, or program execution) once the source files have
|
|
44
44
|
been modified.
|
|
45
45
|
|
|
46
|
-
`--direct`|`-D`:
|
|
46
|
+
- `--direct`|`-D`:
|
|
47
47
|
Craft the feature *immediately* and *in place*: skip the
|
|
48
48
|
feature approaches, the interactive dialog, and the entire task
|
|
49
49
|
plan ceremony, and directly apply the complete change set to the
|
|
@@ -52,20 +52,20 @@ entirely and applies the change set to the affected artifacts itself.
|
|
|
52
52
|
`--next` have no effect, as neither approaches are proposed nor a
|
|
53
53
|
plan is composed.
|
|
54
54
|
|
|
55
|
-
`--interactive`|`-i`:
|
|
55
|
+
- `--interactive`|`-i`:
|
|
56
56
|
Craft *interactively*: implies `--direct` and, once the initial
|
|
57
57
|
*feature* has been applied, repeatedly asks for the *next change*
|
|
58
58
|
with a free-text dialog and immediately applies it in place, too,
|
|
59
59
|
until the user stops the loop by answering `DONE`.
|
|
60
60
|
|
|
61
|
-
`--quick`|`-Q`:
|
|
61
|
+
- `--quick`|`-Q`:
|
|
62
62
|
Shorthand alias for `-a -d -n IMPLEMENT,DELETE`: automatically pick
|
|
63
63
|
the recommended feature approach, compose the plan *without* the
|
|
64
64
|
`## VERIFICATION` section, immediately hand off to `ase-task-implement`,
|
|
65
65
|
and finally `ase-task-delete` the now-consumed plan. This gives a
|
|
66
66
|
single, fast *one-shot* crafting mode.
|
|
67
67
|
|
|
68
|
-
`--next`|`-n` *option*[,...]:
|
|
68
|
+
- `--next`|`-n` *option*[,...]:
|
|
69
69
|
Automatically choose the next step after composing the plan.
|
|
70
70
|
*option* is a single token or a *comma-separated chronological
|
|
71
71
|
list* of tokens; an `IMPLEMENT`, `PREFLIGHT`, or `GRILL` head token
|
|
@@ -84,7 +84,7 @@ entirely and applies the change set to the affected artifacts itself.
|
|
|
84
84
|
|
|
85
85
|
## ARGUMENTS
|
|
86
86
|
|
|
87
|
-
[*task-id*:] *feature*:
|
|
87
|
+
- [*task-id*:] *feature*:
|
|
88
88
|
Description of the *feature* to craft. Optionally prefixed with
|
|
89
89
|
a *task-id* followed by a colon to bind the resulting plan to
|
|
90
90
|
a specific task id.
|
|
@@ -59,22 +59,22 @@ cleanly and are then reported as failed; stage everything and use
|
|
|
59
59
|
|
|
60
60
|
## OPTIONS
|
|
61
61
|
|
|
62
|
-
`--max-parts`|`-m` *count*:
|
|
62
|
+
- `--max-parts`|`-m` *count*:
|
|
63
63
|
Upper bound for the number of derived parts (default: `8`). The
|
|
64
64
|
lower bound is always `2`, because fewer parts are no dissection.
|
|
65
65
|
|
|
66
|
-
`--staged`|`-s`:
|
|
66
|
+
- `--staged`|`-s`:
|
|
67
67
|
Dissect the *staged* changes (the Git index against `HEAD`) instead
|
|
68
68
|
of the working copy changes. Untracked files are then *not* folded
|
|
69
69
|
in, because they are by definition not part of the index.
|
|
70
70
|
|
|
71
|
-
`--dry`|`-d`:
|
|
71
|
+
- `--dry`|`-d`:
|
|
72
72
|
*Report only* -- print the dissection table but create *no*
|
|
73
73
|
artifacts at all, so the decision stays fully reversible. Note that
|
|
74
74
|
this meaning differs from `--dry`/`-d` in `ase-code-craft`, where it
|
|
75
75
|
instead omits the `## VERIFICATION` section of the composed plan.
|
|
76
76
|
|
|
77
|
-
`--force`|`-f`:
|
|
77
|
+
- `--force`|`-f`:
|
|
78
78
|
Remove and re-create already existing worktrees and branches of the
|
|
79
79
|
derived names. Without this option, the skill detects colliding
|
|
80
80
|
targets *before* writing anything, reports them, and stops with
|
|
@@ -82,7 +82,7 @@ cleanly and are then reported as failed; stage everything and use
|
|
|
82
82
|
|
|
83
83
|
## ARGUMENTS
|
|
84
84
|
|
|
85
|
-
*dissect-hint*:
|
|
85
|
+
- *dissect-hint*:
|
|
86
86
|
A free-text hint telling *how* the change set should be split. If
|
|
87
87
|
omitted, the parts are derived from the change set alone.
|
|
88
88
|
|
|
@@ -36,12 +36,12 @@ implementation until it passes). The *querying* state and every
|
|
|
36
36
|
|
|
37
37
|
## OPTIONS
|
|
38
38
|
|
|
39
|
-
`--mode`|`-m` `auto`|`craft`|`refactor`|`resolve`:
|
|
39
|
+
- `--mode`|`-m` `auto`|`craft`|`refactor`|`resolve`:
|
|
40
40
|
Select the tenet set internalized for the implementation: `craft`
|
|
41
41
|
(CRAFTING), `refactor` (REFACTORING), or `resolve` (RESOLVING).
|
|
42
42
|
The default `auto` infers the tenet set from the query itself.
|
|
43
43
|
|
|
44
|
-
`--grill`|`-g`:
|
|
44
|
+
- `--grill`|`-g`:
|
|
45
45
|
Grill the query before implementing, similar to `ase-task-grill`:
|
|
46
46
|
raise 1-10 questions per round which resolve the open points of the
|
|
47
47
|
query. Each question carries a `FOCUS-AREA` -- `DOMAIN`
|
|
@@ -68,27 +68,27 @@ implementation until it passes). The *querying* state and every
|
|
|
68
68
|
merged back into the WHAT and HOW parts of the query. Without
|
|
69
69
|
`--grill`, no questions are asked at all.
|
|
70
70
|
|
|
71
|
-
`--grill-rounds`|`-r` *n*:
|
|
71
|
+
- `--grill-rounds`|`-r` *n*:
|
|
72
72
|
The number of grill rounds to apply (default: `1`). Each round
|
|
73
73
|
starts from scratch from only the current WHAT and HOW parts,
|
|
74
74
|
forgetting all information of previous rounds, and closes with an
|
|
75
75
|
`EDIT TODO` box. Only effective together with `--grill`.
|
|
76
76
|
|
|
77
|
-
`--verify`|`-v`:
|
|
77
|
+
- `--verify`|`-v`:
|
|
78
78
|
Verify whether the implementation fulfills the requirements, by
|
|
79
79
|
running the available verification commands (build, tests, linter,
|
|
80
80
|
type-checker) and adjusting the failing parts of the change set
|
|
81
81
|
until the verification passes. Without `--verify`, strictly no
|
|
82
82
|
verification is performed at all.
|
|
83
83
|
|
|
84
|
-
`--worktree`|`-w`:
|
|
84
|
+
- `--worktree`|`-w`:
|
|
85
85
|
Apply the change sets inside a dedicated Git worktree (as
|
|
86
86
|
`ase-task-implement --worktree`) instead of the current working
|
|
87
87
|
copy. One single worktree, named by a two-word id derived from the
|
|
88
88
|
first query, serves the whole skill run: all `--loop` iterations
|
|
89
89
|
land in it and it is left uncommitted for review.
|
|
90
90
|
|
|
91
|
-
`--loop`|`-l`:
|
|
91
|
+
- `--loop`|`-l`:
|
|
92
92
|
Loop the whole state cycle: after each iteration, ask for the next
|
|
93
93
|
edit query via the interactive `Edit Query` dialog and repeat, until
|
|
94
94
|
the user answers with its fixed `STOP SKILL` option or cancels the
|
|
@@ -96,7 +96,7 @@ implementation until it passes). The *querying* state and every
|
|
|
96
96
|
|
|
97
97
|
## ARGUMENTS
|
|
98
98
|
|
|
99
|
-
*query*:
|
|
99
|
+
- *query*:
|
|
100
100
|
Description of the edit to perform. When omitted, the skill asks
|
|
101
101
|
for the query via an interactive `Edit Query` dialog, carrying the
|
|
102
102
|
fixed `STOP SKILL` option plus free-text input.
|
|
@@ -54,11 +54,11 @@ the code, and comments contradicting the code.
|
|
|
54
54
|
|
|
55
55
|
## OPTIONS
|
|
56
56
|
|
|
57
|
-
`--auto`|`-a`:
|
|
57
|
+
- `--auto`|`-a`:
|
|
58
58
|
Automatically apply every proposed correction without asking the
|
|
59
59
|
user via the interactive dialog.
|
|
60
60
|
|
|
61
|
-
`--severity`|`-S`=(`LOW`|`MEDIUM`|`HIGH`):
|
|
61
|
+
- `--severity`|`-S`=(`LOW`|`MEDIUM`|`HIGH`):
|
|
62
62
|
Set the *severity floor* (default `LOW`): findings below the chosen
|
|
63
63
|
threshold are silently suppressed, ordered `LOW` < `MEDIUM` <
|
|
64
64
|
`HIGH`. The default `LOW` keeps all findings; `ACCEPTED` findings are
|
|
@@ -66,19 +66,19 @@ the code, and comments contradicting the code.
|
|
|
66
66
|
severity* order `HIGH`, `MEDIUM`, `LOW`, `ACCEPTED`, keeping the
|
|
67
67
|
`file`/`line` order within the same severity.
|
|
68
68
|
|
|
69
|
-
`--include`|`-i`=*aspect*[`,`...]:
|
|
69
|
+
- `--include`|`-i`=*aspect*[`,`...]:
|
|
70
70
|
Restrict the checked code quality aspects to the given
|
|
71
71
|
comma-separated list of aspect ids (e.g. `A01,A04`). Without this
|
|
72
72
|
option, all twenty-one aspects are checked.
|
|
73
73
|
|
|
74
|
-
`--exclude`|`-e`=*aspect*[`,`...]:
|
|
74
|
+
- `--exclude`|`-e`=*aspect*[`,`...]:
|
|
75
75
|
Remove the given comma-separated list of aspect ids from the checked
|
|
76
76
|
code quality aspects. Applied *after* `--include`, so
|
|
77
77
|
`-i A01,A02 -e A02` checks `A01` only.
|
|
78
78
|
|
|
79
79
|
## ARGUMENTS
|
|
80
80
|
|
|
81
|
-
*source-reference*:
|
|
81
|
+
- *source-reference*:
|
|
82
82
|
A file, directory, or other reference to the source code to lint.
|
|
83
83
|
|
|
84
84
|
## SCENARIOS
|
|
@@ -31,18 +31,18 @@ entirely and applies the change set to the affected artifacts itself.
|
|
|
31
31
|
|
|
32
32
|
## OPTIONS
|
|
33
33
|
|
|
34
|
-
`--auto`|`-a`:
|
|
34
|
+
- `--auto`|`-a`:
|
|
35
35
|
Automatically pick the recommended refactoring approach without
|
|
36
36
|
asking the user via the interactive dialog.
|
|
37
37
|
|
|
38
|
-
`--dry`|`-d`:
|
|
38
|
+
- `--dry`|`-d`:
|
|
39
39
|
Compose the plan *without* the `## VERIFICATION` section. When
|
|
40
40
|
`ase-task-implement` later applies such a plan, it strictly skips
|
|
41
41
|
the entire verification phase (no build, tests, linter,
|
|
42
42
|
type-checker, or program execution) once the source files have
|
|
43
43
|
been modified.
|
|
44
44
|
|
|
45
|
-
`--direct`|`-D`:
|
|
45
|
+
- `--direct`|`-D`:
|
|
46
46
|
Apply the refactoring *immediately* and *in place*: skip the
|
|
47
47
|
refactoring approaches, the interactive dialog, and the entire task
|
|
48
48
|
plan ceremony, and directly apply the complete change set to the
|
|
@@ -51,14 +51,14 @@ entirely and applies the change set to the affected artifacts itself.
|
|
|
51
51
|
`--next` have no effect, as neither approaches are proposed nor a
|
|
52
52
|
plan is composed.
|
|
53
53
|
|
|
54
|
-
`--quick`|`-Q`:
|
|
54
|
+
- `--quick`|`-Q`:
|
|
55
55
|
Shorthand alias for `-a -d -n IMPLEMENT,DELETE`: automatically pick
|
|
56
56
|
the recommended refactoring approach, compose the plan *without* the
|
|
57
57
|
`## VERIFICATION` section, immediately hand off to `ase-task-implement`,
|
|
58
58
|
and finally `ase-task-delete` the now-consumed plan. This gives a
|
|
59
59
|
single, fast *one-shot* refactoring mode.
|
|
60
60
|
|
|
61
|
-
`--next`|`-n` *option*[,...]:
|
|
61
|
+
- `--next`|`-n` *option*[,...]:
|
|
62
62
|
Automatically choose the next step after composing the plan.
|
|
63
63
|
*option* is a single token or a *comma-separated chronological
|
|
64
64
|
list* of tokens; an `IMPLEMENT`, `PREFLIGHT`, or `GRILL` head token
|
|
@@ -77,7 +77,7 @@ entirely and applies the change set to the affected artifacts itself.
|
|
|
77
77
|
|
|
78
78
|
## ARGUMENTS
|
|
79
79
|
|
|
80
|
-
[*task-id*:] *request*:
|
|
80
|
+
- [*task-id*:] *request*:
|
|
81
81
|
Description of the refactoring *request*. Optionally prefixed
|
|
82
82
|
with a *task-id* followed by a colon to bind the resulting plan
|
|
83
83
|
to a specific task id.
|
|
@@ -36,18 +36,18 @@ entirely and applies the change set to the affected artifacts itself.
|
|
|
36
36
|
|
|
37
37
|
## OPTIONS
|
|
38
38
|
|
|
39
|
-
`--auto`|`-a`:
|
|
39
|
+
- `--auto`|`-a`:
|
|
40
40
|
Automatically pick the recommended resolution approach without
|
|
41
41
|
asking the user via the interactive dialog.
|
|
42
42
|
|
|
43
|
-
`--dry`|`-d`:
|
|
43
|
+
- `--dry`|`-d`:
|
|
44
44
|
Compose the plan *without* the `## VERIFICATION` section. When
|
|
45
45
|
`ase-task-implement` later applies such a plan, it strictly skips
|
|
46
46
|
the entire verification phase (no build, tests, linter,
|
|
47
47
|
type-checker, or program execution) once the source files have
|
|
48
48
|
been modified.
|
|
49
49
|
|
|
50
|
-
`--direct`|`-D`:
|
|
50
|
+
- `--direct`|`-D`:
|
|
51
51
|
Resolve the problem *immediately* and *in place*: skip the
|
|
52
52
|
resolution approaches, the interactive dialog, and the entire task
|
|
53
53
|
plan ceremony, and directly apply the complete change set to the
|
|
@@ -56,14 +56,14 @@ entirely and applies the change set to the affected artifacts itself.
|
|
|
56
56
|
`--next` have no effect, as neither approaches are proposed nor a
|
|
57
57
|
plan is composed.
|
|
58
58
|
|
|
59
|
-
`--quick`|`-Q`:
|
|
59
|
+
- `--quick`|`-Q`:
|
|
60
60
|
Shorthand alias for `-a -d -n IMPLEMENT,DELETE`: automatically pick
|
|
61
61
|
the recommended resolution approach, compose the plan *without* the
|
|
62
62
|
`## VERIFICATION` section, immediately hand off to `ase-task-implement`,
|
|
63
63
|
and finally `ase-task-delete` the now-consumed plan. This gives a
|
|
64
64
|
single, fast *one-shot* resolution mode.
|
|
65
65
|
|
|
66
|
-
`--next`|`-n` *option*[,...]:
|
|
66
|
+
- `--next`|`-n` *option*[,...]:
|
|
67
67
|
Automatically choose the next step after composing the plan.
|
|
68
68
|
*option* is a single token or a *comma-separated chronological
|
|
69
69
|
list* of tokens; an `IMPLEMENT`, `PREFLIGHT`, or `GRILL` head token
|
|
@@ -82,7 +82,7 @@ entirely and applies the change set to the affected artifacts itself.
|
|
|
82
82
|
|
|
83
83
|
## ARGUMENTS
|
|
84
84
|
|
|
85
|
-
[*task-id*:] *problem*:
|
|
85
|
+
- [*task-id*:] *problem*:
|
|
86
86
|
Description of the *problem* to resolve, or a bare issue
|
|
87
87
|
identifier like `P1` or `T1` previously produced by an analyzer
|
|
88
88
|
skill. Optionally prefixed with a *task-id* followed by a colon
|
|
@@ -39,7 +39,7 @@ non-numeric value falls back to the default *5*.
|
|
|
39
39
|
|
|
40
40
|
## OPTIONS
|
|
41
41
|
|
|
42
|
-
`--top`|`-t` *N*:
|
|
42
|
+
- `--top`|`-t` *N*:
|
|
43
43
|
Bound the ranked list to at most *N* key points (default *5*). The
|
|
44
44
|
bound is a *cap*, never a *quota* - fewer points are emitted when the
|
|
45
45
|
document does not contain *N* salient ones, and an invalid or
|
|
@@ -47,7 +47,7 @@ non-numeric value falls back to the default *5*.
|
|
|
47
47
|
|
|
48
48
|
## ARGUMENTS
|
|
49
49
|
|
|
50
|
-
*document-reference*:
|
|
50
|
+
- *document-reference*:
|
|
51
51
|
The document to distill - either a *path* to a readable file or the
|
|
52
52
|
*text* itself pasted inline. If it resolves to a readable file the
|
|
53
53
|
file is read; otherwise it is treated verbatim as pasted text.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: ase-docs-proofread
|
|
3
3
|
argument-hint: "[--help|-h] [--auto|-a] <docs-reference>"
|
|
4
4
|
description: >
|
|
5
|
-
Analyze the documents for spelling, punctuation, or grammar errors.
|
|
5
|
+
Analyze the documents for spelling, capitalization, punctuation, word break, or grammar errors.
|
|
6
6
|
Use when the user wants to "proofread" or "spellcheck" a document.
|
|
7
7
|
user-invocable: true
|
|
8
8
|
disable-model-invocation: false
|
|
@@ -15,7 +15,7 @@ effort: high
|
|
|
15
15
|
@${CLAUDE_SKILL_DIR}/../../meta/ase-getopt.md
|
|
16
16
|
|
|
17
17
|
<purpose name="ase-docs-proofread">
|
|
18
|
-
Analyze documents for spelling, punctuation, or grammar errors
|
|
18
|
+
Analyze documents for spelling, capitalization, punctuation, word break, or grammar errors
|
|
19
19
|
</purpose>
|
|
20
20
|
|
|
21
21
|
<expand name="getopt"
|
|
@@ -26,7 +26,7 @@ Analyze documents for spelling, punctuation, or grammar errors
|
|
|
26
26
|
|
|
27
27
|
<objective>
|
|
28
28
|
*Proofread* the documents of `<getopt-arguments/>` for problems in their
|
|
29
|
-
*spelling*, *punctuation*, or *grammar* and propose corrections.
|
|
29
|
+
*spelling*, *capitalization*, *punctuation*, *word break*, or *grammar* and propose corrections.
|
|
30
30
|
</objective>
|
|
31
31
|
|
|
32
32
|
<flow>
|
|
@@ -100,19 +100,23 @@ Analyze documents for spelling, punctuation, or grammar errors
|
|
|
100
100
|
<template>
|
|
101
101
|
<ase-tpl-bullet-secondary/> **PROOFREADING SUMMARY**:
|
|
102
102
|
|
|
103
|
-
| *Proofread Type*
|
|
104
|
-
|
|
|
105
|
-
| **SPELLING**:
|
|
106
|
-
| **
|
|
107
|
-
| **
|
|
103
|
+
| *Proofread Type* | *Proofread Result* |
|
|
104
|
+
| ------------------- | ----------------------- |
|
|
105
|
+
| **SPELLING**: | **<n/>** problems found |
|
|
106
|
+
| **CAPITALIZATION**: | **<c/>** problems found |
|
|
107
|
+
| **PUNCTUATION**: | **<m/>** problems found |
|
|
108
|
+
| **WORD-BREAK**: | **<w/>** problems found |
|
|
109
|
+
| **GRAMMAR**: | **<k/>** problems found |
|
|
108
110
|
|
|
109
111
|
</template>
|
|
110
112
|
|
|
111
113
|
Hints:
|
|
112
114
|
|
|
113
|
-
- <n/> is the number of problems with `type` equal to `SPELLING`
|
|
114
|
-
- <
|
|
115
|
-
- <
|
|
115
|
+
- <n/> is the number of problems with `type` equal to `SPELLING` in <problems/>
|
|
116
|
+
- <c/> is the number of problems with `type` equal to `CAPITALIZATION` in <problems/>
|
|
117
|
+
- <m/> is the number of problems with `type` equal to `PUNCTUATION` in <problems/>
|
|
118
|
+
- <w/> is the number of problems with `type` equal to `WORD-BREAK` in <problems/>
|
|
119
|
+
- <k/> is the number of problems with `type` equal to `GRAMMAR` in <problems/>
|
|
116
120
|
|
|
117
121
|
</step>
|
|
118
122
|
|
|
@@ -238,7 +242,7 @@ Analyze documents for spelling, punctuation, or grammar errors
|
|
|
238
242
|
|
|
239
243
|
Set <old-start/> to the 1-based line number of the *first*
|
|
240
244
|
old-side hunk line: if <context-before/> is non-empty, that is
|
|
241
|
-
the line of its *first* context line, i.e
|
|
245
|
+
the line of its *first* context line, i.e., <line/> minus the
|
|
242
246
|
number of lines in <context-before/>; otherwise it is <line/> itself
|
|
243
247
|
(the first line of <old-text/>). For a hunk that *only inserts*
|
|
244
248
|
new lines (empty <old-text/> *and* empty context), set it to the
|
|
@@ -13,10 +13,10 @@
|
|
|
13
13
|
## DESCRIPTION
|
|
14
14
|
|
|
15
15
|
The `ase-docs-proofread` skill analyzes the referenced documents for
|
|
16
|
-
*spelling*, *punctuation*, and *grammar*
|
|
17
|
-
corrections. The investigation is dispatched to a
|
|
18
|
-
(`ase:ase-docs-proofread`) so that scanning details do not
|
|
19
|
-
the user-visible transcript.
|
|
16
|
+
*spelling*, *capitalization*, *punctuation*, *word break*, and *grammar*
|
|
17
|
+
errors and proposes corrections. The investigation is dispatched to a
|
|
18
|
+
sub-agent (`ase:ase-docs-proofread`) so that scanning details do not
|
|
19
|
+
leak into the user-visible transcript.
|
|
20
20
|
|
|
21
21
|
For each detected problem, the skill renders a unified-diff
|
|
22
22
|
*CORRECTION* preview and either asks the user to `ACCEPT` or `REJECT`
|
|
@@ -24,21 +24,31 @@ the proposed correction interactively (or refine it via a free-text
|
|
|
24
24
|
hint, which re-proposes the correction without limit) or - with
|
|
25
25
|
`--auto` - applies all corrections automatically.
|
|
26
26
|
|
|
27
|
+
`ase-docs-proofread` is the correctness-fixing member of the document
|
|
28
|
+
triple. The recommended order over one document is
|
|
29
|
+
[`ase-docs-shorten`](../ase-docs-shorten/help.md) first (cut the bulk),
|
|
30
|
+
then [`ase-docs-refine`](../ase-docs-refine/help.md) (polish what
|
|
31
|
+
survives), then `ase-docs-proofread` (final correctness pass), so no
|
|
32
|
+
correction effort is spent on text which is later dropped.
|
|
33
|
+
|
|
27
34
|
## OPTIONS
|
|
28
35
|
|
|
29
|
-
`--auto`|`-a`:
|
|
36
|
+
- `--auto`|`-a`:
|
|
30
37
|
Automatically apply every proposed correction without asking the
|
|
31
38
|
user via the interactive dialog.
|
|
32
39
|
|
|
33
40
|
## ARGUMENTS
|
|
34
41
|
|
|
35
|
-
*docs-reference*:
|
|
42
|
+
- *docs-reference*:
|
|
36
43
|
A file, directory, or other reference to the documents to
|
|
37
44
|
proofread.
|
|
38
45
|
|
|
39
46
|
## SCENARIOS
|
|
40
47
|
|
|
41
|
-
- You want documents checked for spelling,
|
|
48
|
+
- You want documents checked for spelling, capitalization,
|
|
49
|
+
punctuation, word break, and grammar
|
|
50
|
+
- You want inconsistent capitalization of terms and headings unified
|
|
51
|
+
- You want wrong word breaks like "data base" or "check-list" repaired
|
|
42
52
|
- You want corrections proposed which you accept or reject one by one
|
|
43
53
|
- You want a whole documentation directory corrected automatically
|
|
44
54
|
- You want a final language pass over a text before publishing
|
|
@@ -59,4 +69,4 @@ Proofread an entire documentation directory automatically:
|
|
|
59
69
|
|
|
60
70
|
## SEE ALSO
|
|
61
71
|
|
|
62
|
-
[`ase-code-lint`](../ase-code-lint/help.md), [`ase-meta-changelog`](../ase-meta-changelog/help.md).
|
|
72
|
+
[`ase-docs-shorten`](../ase-docs-shorten/help.md), [`ase-docs-refine`](../ase-docs-refine/help.md), [`ase-docs-distill`](../ase-docs-distill/help.md), [`ase-code-lint`](../ase-code-lint/help.md), [`ase-meta-changelog`](../ase-meta-changelog/help.md).
|