@logtape/lint 2.2.0-dev.675 → 2.2.0-dev.676
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 +50 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
<!-- deno-fmt-ignore-file -->
|
|
2
|
+
|
|
3
|
+
@logtape/lint: lint rules for LogTape
|
|
4
|
+
=====================================
|
|
5
|
+
|
|
6
|
+
[![JSR][JSR badge]][JSR]
|
|
7
|
+
[![npm][npm badge]][npm]
|
|
8
|
+
|
|
9
|
+
*@logtape/lint* provides lint rules for [ESLint] (v8 and v9), [Oxlint], and
|
|
10
|
+
[Deno Lint] that detect common [LogTape] usage mistakes at development time.
|
|
11
|
+
|
|
12
|
+
[JSR badge]: https://jsr.io/badges/@logtape/lint
|
|
13
|
+
[JSR]: https://jsr.io/@logtape/lint
|
|
14
|
+
[npm badge]: https://img.shields.io/npm/v/@logtape/lint?logo=npm
|
|
15
|
+
[npm]: https://www.npmjs.com/package/@logtape/lint
|
|
16
|
+
[ESLint]: https://eslint.org/
|
|
17
|
+
[Oxlint]: https://oxc.rs/docs/guide/usage/linter.html
|
|
18
|
+
[Deno Lint]: https://docs.deno.com/runtime/reference/cli/linter/
|
|
19
|
+
[LogTape]: https://logtape.org/
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
Rules
|
|
23
|
+
-----
|
|
24
|
+
|
|
25
|
+
| Rule | Default severity | Fix |
|
|
26
|
+
| -------------------------- | ---------------- | ----------------- |
|
|
27
|
+
| `no-message-interpolation` | error | no |
|
|
28
|
+
| `prefer-lazy-evaluation` | warn | yes |
|
|
29
|
+
| `no-unawaited-log` | error | yes (conditional) |
|
|
30
|
+
| `require-meta-sink` | warn | no |
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
Installation
|
|
34
|
+
------------
|
|
35
|
+
|
|
36
|
+
~~~~ sh
|
|
37
|
+
deno add --jsr @logtape/lint # for Deno
|
|
38
|
+
npm add --save-dev @logtape/lint # for npm
|
|
39
|
+
pnpm add --save-dev @logtape/lint # for pnpm
|
|
40
|
+
yarn add --dev @logtape/lint # for Yarn
|
|
41
|
+
bun add --dev @logtape/lint # for Bun
|
|
42
|
+
~~~~
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
Docs
|
|
46
|
+
----
|
|
47
|
+
|
|
48
|
+
The documentation for this package is available at
|
|
49
|
+
<https://logtape.org/lint/>. For the API references, see
|
|
50
|
+
<https://jsr.io/@logtape/lint>.
|