Skip to content

Commit 76d4760

Browse files
committedMar 13, 2025
Format docs
1 parent cd8ffbb commit 76d4760

File tree

3 files changed

+36
-33
lines changed

3 files changed

+36
-33
lines changed
 

‎packages/docs/src/content/docs/features/reporters.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Knip provides the following built-in reporters:
1111
- [`disclosure`][1]
1212
- [`json`][2]
1313
- [`markdown`][3]
14-
- [`codeclimate`][5]
14+
- [`codeclimate`][4]
1515
- `symbol` (default)
1616

1717
Example usage:
@@ -72,7 +72,7 @@ object per file structured like this:
7272
}
7373
```
7474

75-
The keys match the [reported issue types][4]. Example usage:
75+
The keys match the [reported issue types][5]. Example usage:
7676

7777
```sh
7878
knip --reporter json
@@ -159,28 +159,29 @@ my-package package.json
159159

160160
### CodeClimate
161161

162-
The built-in `codeclimate` reporter generates output in the Code Climate Report JSON format. Example usage:
162+
The built-in `codeclimate` reporter generates output in the Code Climate Report
163+
JSON format. Example usage:
163164

164165
```text
165166
$ knip --reporter codeclimate
166167
167168
[
168169
{
169-
"type":"issue",
170-
"check_name":"Unused exports",
171-
"description":"isUnused",
172-
"categories":["Bug Risk"],
170+
"type": "issue",
171+
"check_name": "Unused exports",
172+
"description": "isUnused",
173+
"categories": ["Bug Risk"],
173174
"location": {
174-
"path":"path/to/file.ts",
175+
"path": "path/to/file.ts",
175176
"positions": {
176177
"begin": {
177-
"line":6,
178-
"column":1
178+
"line": 6,
179+
"column": 1
179180
}
180181
}
181182
}
182-
"severity":"major",
183-
"fingerprint":"e9789995c1fe9f7d75eed6a0c0f89e84",
183+
"severity": "major",
184+
"fingerprint": "e9789995c1fe9f7d75eed6a0c0f89e84",
184185
}
185186
]
186187
```
@@ -285,5 +286,5 @@ knip --preprocessor ./preprocess.ts
285286
[1]: #disclosure
286287
[2]: #json
287288
[3]: #markdown
288-
[4]: ../reference/issue-types.md
289-
[5]: #codeclimate
289+
[4]: #codeclimate
290+
[5]: ../reference/issue-types.md

‎packages/docs/src/content/docs/reference/configuration.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -180,15 +180,15 @@ notation below is valid and will report only exports tagged `@lintignore` or
180180
}
181181
```
182182

183-
Also see [JSDoc & TSDoc Tags](./jsdoc-tsdoc-tags.md).
183+
Also see [JSDoc & TSDoc Tags][8].
184184

185185
## Ignore Issues
186186

187187
### `ignore`
188188

189189
:::tip
190190

191-
Please read [project files configuration][8] before using the `ignore` option,
191+
Please read [project files configuration][9] before using the `ignore` option,
192192
because in many cases you'll want to **exclude project files** instead.
193193

194194
:::
@@ -340,4 +340,5 @@ configurations individually.
340340
[5]: ../explanations/plugins.md#entry-files
341341
[6]: ../explanations/plugins.md
342342
[7]: ../features/rules-and-filters.md#filters
343-
[8]: ../guides/configuring-project-files.md
343+
[8]: ./jsdoc-tsdoc-tags.md
344+
[9]: ../guides/configuring-project-files.md

‎packages/docs/src/content/docs/reference/jsdoc-tsdoc-tags.md

+17-16
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ like so:
4040
knip --tags=-lintignore,-internal
4141
```
4242

43-
Tags can also be [configured in `knip.json`](./configuration.md#tags).
43+
Tags can also be [configured in `knip.json`][2].
4444

4545
## `@public`
4646

@@ -58,14 +58,14 @@ export const unusedFunction = () => {};
5858
```
5959

6060
This tag can also be used to make exceptions in entry files when using
61-
[--include-entry-exports][2].
61+
[--include-entry-exports][3].
6262

63-
[JSDoc: @public][3] and [TSDoc: @public][4]
63+
[JSDoc: @public][4] and [TSDoc: @public][5]
6464

6565
## `@internal`
6666

6767
Internal exports are not meant for public consumption, but only for internal
68-
usage such as tests. This means they would be reported in [production mode][5].
68+
usage such as tests. This means they would be reported in [production mode][6].
6969

7070
Mark the export with `@internal` and Knip will not report the export in
7171
production mode.
@@ -82,7 +82,7 @@ exceptions are possible. Those should not be reported as false positives, so
8282
when using production mode you'll need to help Knip out by tagging them as
8383
`@internal`.
8484

85-
[TSDoc: @internal][6]
85+
[TSDoc: @internal][7]
8686

8787
## `@alias`
8888

@@ -101,21 +101,22 @@ export default Component;
101101
An alternative solution is to use `--exclude duplicates` and exclude all
102102
duplicates from being reported.
103103

104-
[JSDoc: @alias][7]
104+
[JSDoc: @alias][8]
105105

106106
## `@beta`
107107

108-
Works identical to [`@public`][8]. Knip ignores other tags like `@alpha` and
108+
Works identical to [`@public`][9]. Knip ignores other tags like `@alpha` and
109109
`@experimental`.
110110

111-
[TSDoc: @beta][9]
111+
[TSDoc: @beta][10]
112112

113113
[1]: ../reference/cli.md#--tags
114-
[2]: ./cli.md#--include-entry-exports
115-
[3]: https://jsdoc.app/tags-public.html
116-
[4]: https://tsdoc.org/pages/tags/public/
117-
[5]: ../features/production-mode.md
118-
[6]: https://tsdoc.org/pages/tags/internal/
119-
[7]: https://jsdoc.app/tags-alias.html
120-
[8]: #public
121-
[9]: https://tsdoc.org/pages/tags/beta/
114+
[2]: ./configuration.md#tags
115+
[3]: ./cli.md#--include-entry-exports
116+
[4]: https://jsdoc.app/tags-public.html
117+
[5]: https://tsdoc.org/pages/tags/public/
118+
[6]: ../features/production-mode.md
119+
[7]: https://tsdoc.org/pages/tags/internal/
120+
[8]: https://jsdoc.app/tags-alias.html
121+
[9]: #public
122+
[10]: https://tsdoc.org/pages/tags/beta/

0 commit comments

Comments
 (0)
Please sign in to comment.