@contextlint/cli 0.4.0 → 0.4.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.
- package/README.md +48 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# @contextlint/cli
|
|
2
|
+
|
|
3
|
+
CLI for [contextlint](https://github.com/nozomi-koborinai/contextlint) —
|
|
4
|
+
a rule-based linter for structured Markdown documents.
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
npm install -D @contextlint/cli
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Usage
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
contextlint --config contextlint.config.json "docs/**/*.md"
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Or run without installing:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx @contextlint/cli --config contextlint.config.json "docs/**/*.md"
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Configuration
|
|
25
|
+
|
|
26
|
+
Create `contextlint.config.json`:
|
|
27
|
+
|
|
28
|
+
```json
|
|
29
|
+
{
|
|
30
|
+
"$schema": "https://raw.githubusercontent.com/nozomi-koborinai/contextlint/main/schema.json",
|
|
31
|
+
"rules": [
|
|
32
|
+
{ "rule": "tbl001", "options": { "requiredColumns": ["ID", "Status"] } },
|
|
33
|
+
{ "rule": "tbl002", "options": { "columns": ["ID", "Status"] } },
|
|
34
|
+
{ "rule": "ref001" }
|
|
35
|
+
]
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Adding `$schema` enables autocomplete in VS Code, Cursor,
|
|
40
|
+
JetBrains, and other editors.
|
|
41
|
+
|
|
42
|
+
See the
|
|
43
|
+
[main repository](https://github.com/nozomi-koborinai/contextlint)
|
|
44
|
+
for the full list of rules and configuration options.
|
|
45
|
+
|
|
46
|
+
## License
|
|
47
|
+
|
|
48
|
+
[MIT](https://github.com/nozomi-koborinai/contextlint/blob/main/LICENSE)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contextlint/cli",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"description": "CLI entry point for contextlint",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"dependencies": {
|
|
15
15
|
"commander": "^14.0.0",
|
|
16
16
|
"glob": "^13.0.6",
|
|
17
|
-
"@contextlint/core": "0.4.
|
|
17
|
+
"@contextlint/core": "0.4.2"
|
|
18
18
|
},
|
|
19
19
|
"publishConfig": {
|
|
20
20
|
"access": "public"
|