pickier-vscode 0.1.10 → 0.1.12
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/LICENSE.md +21 -0
- package/README.md +27 -28
- package/dist/extension.js +26470 -0
- package/docs/USAGE.md +39 -61
- package/examples/01-hover-help-text.ts +0 -1
- package/examples/02-codelens-annotations.ts +0 -1
- package/examples/03-code-actions.ts +0 -1
- package/examples/04-problems-panel.ts +0 -1
- package/examples/06-all-severities.ts +0 -1
- package/examples/07-auto-fixable-vs-manual.ts +0 -1
- package/examples/08-disable-comments.ts +0 -3
- package/examples/10-comprehensive-test.ts +0 -3
- package/examples/README.md +62 -119
- package/package.json +9 -9
- package/test/fixtures/fixable.ts +0 -1
- package/test/fixtures/lint-debugger-console.ts +0 -2
- package/test/fixtures/lint-errors.ts +0 -1
package/LICENSE.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Open Web Foundation
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -4,21 +4,22 @@ Fast, modern formatter and linter for TypeScript, JavaScript, JSON, HTML, CSS, M
|
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
7
|
+
-**Lightning Fast**: Built on Bun runtime for incredible performance
|
|
8
|
+
-**Real-time Linting**: See errors and warnings as you type
|
|
9
|
+
-**Auto-fix**: Automatically fix many issues with one command
|
|
10
|
+
-**Multiple Languages**: TypeScript, JavaScript, JSON, HTML, CSS, Markdown, YAML
|
|
11
|
+
-**Markdown Linting**: Comprehensive MD001-MD059 rule coverage
|
|
12
|
+
-**Problems Integration**: All issues appear in VS Code's Problems panel
|
|
13
|
+
-**Smart Underlines**: Visual indicators for errors (red) and warnings (yellow)
|
|
14
|
+
-**Hover Tooltips**: Detailed error/warning information on hover
|
|
15
|
+
-**Status Bar**: See issue count at a glance
|
|
16
16
|
|
|
17
17
|
## Usage
|
|
18
18
|
|
|
19
19
|
### Automatic Linting
|
|
20
20
|
|
|
21
21
|
The extension automatically lints files when you:
|
|
22
|
+
|
|
22
23
|
- Open a file
|
|
23
24
|
- Save a file (configurable)
|
|
24
25
|
- Type (with 500ms debounce, configurable)
|
|
@@ -27,20 +28,19 @@ The extension automatically lints files when you:
|
|
|
27
28
|
|
|
28
29
|
Access commands via Command Palette (Cmd/Ctrl+Shift+P):
|
|
29
30
|
|
|
30
|
-
- `Pickier: Format Document
|
|
31
|
-
- `Pickier: Format Selection` - Format selected text
|
|
32
|
-
- `Pickier: Lint Document` - Lint the current file
|
|
33
|
-
- `Pickier: Lint Workspace` - Lint all files in workspace
|
|
34
|
-
- `Pickier: Fix All Auto-fixable Issues` - Apply all available fixes
|
|
35
|
-
- `Pickier: Organize Imports` - Sort and organize imports
|
|
36
|
-
- `Pickier: Show Output Channel` - Show detailed output
|
|
37
|
-
- `Pickier: Restart Extension` - Restart the extension
|
|
31
|
+
- `Pickier: Format Document`- Format the current file
|
|
38
32
|
|
|
39
|
-
|
|
33
|
+
-`Pickier: Format Selection`- Format selected text
|
|
34
|
+
-`Pickier: Lint Document`- Lint the current file
|
|
35
|
+
-`Pickier: Lint Workspace`- Lint all files in workspace
|
|
36
|
+
-`Pickier: Fix All Auto-fixable Issues`- Apply all available fixes
|
|
37
|
+
-`Pickier: Organize Imports`- Sort and organize imports
|
|
38
|
+
-`Pickier: Show Output Channel`- Show detailed output
|
|
39
|
+
-`Pickier: Restart Extension`- Restart the extension
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
### Configuration
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
Configure Pickier in VS Code settings:```json
|
|
44
44
|
{
|
|
45
45
|
"pickier.enable": true,
|
|
46
46
|
"pickier.lintOnSave": true,
|
|
@@ -49,14 +49,15 @@ Configure Pickier in VS Code settings:
|
|
|
49
49
|
"pickier.formatOnPaste": false,
|
|
50
50
|
"pickier.statusBar.showIssueCount": true
|
|
51
51
|
}
|
|
52
|
+
|
|
52
53
|
```
|
|
53
54
|
|
|
54
55
|
### Visual Indicators
|
|
55
56
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
57
|
+
-**Red Squiggles**: Errors that must be fixed
|
|
58
|
+
-**Yellow Squiggles**: Warnings and style suggestions
|
|
59
|
+
-**Faded Text**: Unused variables/imports
|
|
60
|
+
-**Strikethrough**: Deprecated code
|
|
60
61
|
|
|
61
62
|
## Requirements
|
|
62
63
|
|
|
@@ -65,9 +66,7 @@ Configure Pickier in VS Code settings:
|
|
|
65
66
|
|
|
66
67
|
## Configuration File
|
|
67
68
|
|
|
68
|
-
Create a `pickier.config.ts`
|
|
69
|
-
|
|
70
|
-
```typescript
|
|
69
|
+
Create a `pickier.config.ts`in your project root:```typescript
|
|
71
70
|
import type { PickierConfig } from 'pickier'
|
|
72
71
|
|
|
73
72
|
export default {
|
|
@@ -95,7 +94,7 @@ export default {
|
|
|
95
94
|
|
|
96
95
|
## Issues & Feedback
|
|
97
96
|
|
|
98
|
-
Report issues at: https://github.com/
|
|
97
|
+
Report issues at: <https://github.com/pickier/pickier/issues>
|
|
99
98
|
|
|
100
99
|
## License
|
|
101
100
|
|