dsh-outline-lint 0.1.0 → 0.1.1
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 +26 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,32 @@
|
|
|
2
2
|
|
|
3
3
|
Length is not the failure mode; shape is. This reports the five defects that make a document unreviewable regardless of how good the reasoning is.
|
|
4
4
|
|
|
5
|
+
<!-- example:start -->
|
|
6
|
+
## 真实输入输出
|
|
7
|
+
|
|
8
|
+
输入：
|
|
9
|
+
|
|
10
|
+
```markdown
|
|
11
|
+
# 数据管线报告
|
|
12
|
+
|
|
13
|
+
#### 处理流程
|
|
14
|
+
|
|
15
|
+
原始数据经清洗后入库。
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
真实运行（逐字输出，由测试与工具保持同步）：
|
|
19
|
+
|
|
20
|
+
```text
|
|
21
|
+
$ outline-lint report-outline.md
|
|
22
|
+
warn heading-jump line 3: "处理流程" is h4 directly under h1, which reads as a lost level
|
|
23
|
+
error no-conclusion no conclusion before the body: add a heading matching 结论/摘要 or open the first paragraph with 结论：
|
|
24
|
+
error no-reproduction nothing a reader can run: add a 复现 section or a fenced command
|
|
25
|
+
fail: 2 errors, 1 warnings
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
出口码：1。
|
|
29
|
+
<!-- example:start -->
|
|
30
|
+
|
|
5
31
|
```bash
|
|
6
32
|
npx outline-lint report.md # human output, exit 1 on findings
|
|
7
33
|
npx outline-lint report.md --json # machine output for a pipeline
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dsh-outline-lint",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Shape check for delivered documents: no title, more than one level-1 heading, a lost heading level, no conclusion up front, and nothing a reader can run to reproduce the result.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./src/index.js",
|