oxlint-tui 1.0.2 → 1.0.4
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 +10 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ A lightweight, dependency-free Node.js Terminal User Interface (TUI) for browsin
|
|
|
4
4
|
|
|
5
5
|
It automatically loads your local configuration to show you the status of the rules toggled in your project.
|
|
6
6
|
|
|
7
|
-
|
|
8
8
|
|
|
9
9
|
## Why?
|
|
10
10
|
|
|
@@ -17,9 +17,14 @@ Configuring linters often involves jumping between your editor, a massive JSON f
|
|
|
17
17
|
* **View Docs**: Press <kbd>ENTER</kbd> on any rule to open its official documentation in your browser.
|
|
18
18
|
* **Zero Dependencies**: Written in pure Node.js without any heavy TUI libraries.
|
|
19
19
|
|
|
20
|
+
## Important note
|
|
21
|
+
|
|
22
|
+
Documentation links and information about fixability are not available in older versions of oxlint.
|
|
23
|
+
This tool was developed using oxlint version 1.41.0.
|
|
24
|
+
|
|
20
25
|
## Usage
|
|
21
26
|
|
|
22
|
-
###
|
|
27
|
+
### Quick Start (via npx)
|
|
23
28
|
|
|
24
29
|
Run it directly in your project folder (where your `.oxlintrc.json` is located):
|
|
25
30
|
|
|
@@ -27,7 +32,7 @@ Run it directly in your project folder (where your `.oxlintrc.json` is located):
|
|
|
27
32
|
npx oxlint-tui
|
|
28
33
|
```
|
|
29
34
|
|
|
30
|
-
###
|
|
35
|
+
### Custom Config Path
|
|
31
36
|
|
|
32
37
|
If your configuration file is located elsewhere or named differently:
|
|
33
38
|
|
|
@@ -35,7 +40,7 @@ If your configuration file is located elsewhere or named differently:
|
|
|
35
40
|
npx oxlint-tui ./configs/oxlint.json
|
|
36
41
|
```
|
|
37
42
|
|
|
38
|
-
###
|
|
43
|
+
### Global Install
|
|
39
44
|
|
|
40
45
|
If you use oxlint frequently, you can install it globally:
|
|
41
46
|
|
|
@@ -66,6 +71,7 @@ oxlint-tui
|
|
|
66
71
|
The goal is to build this into a tool that not only reads the information provided by the oxlint CLI and your configuration file - but also allows to create the configuration. Oxlint provides a lot more flexibility than just toggling rules on/off, so making this fully functional is going to require more work.
|
|
67
72
|
|
|
68
73
|
If you're willing and able, please feel free to contribute to this project and help expanding it.
|
|
74
|
+
(CONTRIBUTING.md)[https://github.com/holoflash/oxlint-tui/blob/main/CONTRIBUTING.md]
|
|
69
75
|
|
|
70
76
|
## License
|
|
71
77
|
|