@willbooster/wb 22.1.5 → 22.3.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.
- package/README.md +44 -0
- package/dist/index.js +31 -31
- package/dist/slidevTextlint-CR4MxEdF.js +120 -0
- package/package.json +8 -1
package/README.md
CHANGED
|
@@ -90,6 +90,8 @@ Commands:
|
|
|
90
90
|
@willbooster-private/ @willbooster-private/`)
|
|
91
91
|
so the in-image install resolves the rewritten
|
|
92
92
|
file: paths.
|
|
93
|
+
wb slidev-check [files..] Check selected Slidev decks, or all *.slidev.md
|
|
94
|
+
decks when no files are given
|
|
93
95
|
wb start [args..] Start app. Use '--' to stop wb option parsing
|
|
94
96
|
and forward the remaining arguments to the
|
|
95
97
|
underlying app command. Example: wb start --
|
|
@@ -134,3 +136,45 @@ the full log path. Truncated output is marked; read the log for earlier details.
|
|
|
134
136
|
Output is saved as it arrives, before display filtering,
|
|
135
137
|
to `.wb/verify.log` or `.wb/verify-full.log` in the verified project. Each command
|
|
136
138
|
overwrites its previous log; `--dry-run` leaves logs untouched.
|
|
139
|
+
|
|
140
|
+
## Slidev checks
|
|
141
|
+
|
|
142
|
+
`wb slidev-check` checks slide text with textlint, then checks rendered Slidev decks.
|
|
143
|
+
It does not run installation, code linting, type checking, or tests.
|
|
144
|
+
Pass one or more files to check only those decks:
|
|
145
|
+
|
|
146
|
+
```sh
|
|
147
|
+
bun wb slidev-check slides/intro.slidev.md
|
|
148
|
+
bun wb slidev-check slides/intro.slidev.md slides/setup.slidev.md
|
|
149
|
+
bun wb slidev-check slides/intro.slidev.md --fix
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
With no files, it discovers all `*.slidev.md` files under the current project,
|
|
153
|
+
using the same exclusions as `wb verify --full`. Checks stop on the first failed
|
|
154
|
+
deck and return its exit code. `--fix` applies fixes provided by `slidev-check`;
|
|
155
|
+
textlint only reports problems and never edits text. Text errors stop the check
|
|
156
|
+
before rendering, including with `--fix`. `--dry-run` lists the text checks and
|
|
157
|
+
commands without running them. File paths are relative to
|
|
158
|
+
the working directory (or `--working-dir`). Page selection within a deck is not supported.
|
|
159
|
+
|
|
160
|
+
`wb verify` does not check Slidev decks. `wb verify --full` checks all discovered
|
|
161
|
+
decks before running tests, without applying fixes.
|
|
162
|
+
|
|
163
|
+
The bundled textlint rules check half-width kana, invalid control characters,
|
|
164
|
+
and zero-width spaces (U+200B). Numeric inch marks, sentence fragments, omitted final punctuation, long technical terms,
|
|
165
|
+
polite/plain style, sentence length, and cautious wording are allowed. No local
|
|
166
|
+
textlint configuration or extra textlint installation is needed; repository
|
|
167
|
+
`.textlintrc` files do not affect these slide checks.
|
|
168
|
+
|
|
169
|
+
Textlint checks Markdown content in visible slides, including `src:` imports
|
|
170
|
+
within the workspace root or deck directory, and reports original file paths,
|
|
171
|
+
lines, columns, and rule names. Slidev's parser rejects import paths outside those
|
|
172
|
+
roots before reading them. This check compares paths without resolving symlink
|
|
173
|
+
targets. Slidev frontmatter,
|
|
174
|
+
comments/speaker notes, and code are excluded. Parsing uses the standard Markdown
|
|
175
|
+
textlint plugin; raw HTML blocks and HTML tag attributes are not checked. Slidev-specific
|
|
176
|
+
syntax is not interpreted: Vue expressions and MDC attributes may be checked
|
|
177
|
+
when the Markdown parser treats their source as prose (for example,
|
|
178
|
+
`{{ "テスト" }}` or `[visible]{title="テスト"}`). Half-width kana is checked in plain paragraph and list text, but not in headings
|
|
179
|
+
or bold/italic spans or blockquotes. The other rules also inspect headings and
|
|
180
|
+
blockquotes. Markdown coverage is not exhaustive.
|