Skip to content

Commit 7f150ad

Browse files
authored
(docs) wtf happened
1 parent 0d3b55f commit 7f150ad

File tree

1 file changed

+0
-70
lines changed

1 file changed

+0
-70
lines changed

packages/svelte-check/README.md

Lines changed: 0 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -50,76 +50,6 @@ Usage:
5050

5151
### Args:
5252

53-
| Flag | Description |
54-
| --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55-
| `--workspace <path>` | Path to your workspace. All subdirectories except node_modules and those listed in `--ignore` are checked |
56-
| `--output <human\|human-verbose\|machine>` |
57-
| `--watch` | Will not exit after one pass but keep watching files for changes and rerun diagnostics |
58-
| `--tsconfig <path>` | Pass a path to a tsconfig or jsconfig file. The path can be relative to the workspace path or absolute. Doing this means that only files matched by the files/include/exclude pattern of the config file are diagnosed. It also means that errors from TypeScript and JavaScript files are reported. |
59-
| `--ignore <path1,path2>` | Files/folders to ignore - relative to workspace root, comma-separated, inside quotes. Example: `--ignore "dist,build"` |
60-
| `--fail-on-warnings` | Will also exit with error code when there are warnings |
61-
| `--fail-on-hints` | Will also exit with error code when there are hints |
62-
| `--compiler-warnings <code1:error\|ignore,code2:error\|ignore>` | A list of Svelte compiler warning codes. Each entry defines whether that warning should be ignored or treated as an error. Warnings are comma-separated, between warning code and error level is a colon; all inside quotes. Example: `--compiler-warnings "css-unused-selector:ignore,unused-export-let:error"` |
63-
| `--diagnostic-sources <js,svelte,css>` | A list of diagnostic sources which should run diagnostics on your code. Possible values are `js` (includes TS), `svelte`, `css`. Comma-separated, inside quotes. By default all are active. Example: `--diagnostic-sources "js,svelte"` |
64-
| `--threshold <error\|warning>` | Filters the diagnostics to display. `error` will output only errors while `warning` will output warnings and errors. |
65-
66-
### FAQ
67-
68-
#### Why is there no option to only check specific files (for example only staged files)?
69-
70-
`svelte-check` needs to know the whole project to do valid checks. Imagine you alter a component property `export let foo` to `export let bar`, but you don't update any of the component usages. They all have errors now but you would not catch them if you only run checks on changed files.
71-
# Check your code with svelte-check
72-
73-
Provides CLI diagnostics checks for:
74-
75-
- Unused CSS
76-
- Svelte A11y hints
77-
- JavaScript/TypeScript compiler errors
78-
79-
Requires Node 12 or later.
80-
81-
### Usage:
82-
83-
#### Local / in your project
84-
85-
Installation:
86-
87-
`npm i svelte-check --save-dev`
88-
89-
Package.json:
90-
91-
```json
92-
{
93-
// ...
94-
"scripts": {
95-
"svelte-check": "svelte-check"
96-
// ...
97-
},
98-
// ...
99-
"devDependencies": {
100-
"svelte-check": "..."
101-
// ...
102-
}
103-
}
104-
```
105-
106-
Usage:
107-
108-
`npm run svelte-check`
109-
110-
#### Global (not recommended)
111-
112-
Installation:
113-
114-
`npm i svelte-check svelte -g`
115-
116-
Usage:
117-
118-
1. Go to folder where to start checking
119-
2. `svelte-check`
120-
121-
### Args:
122-
12353
| Flag | Description |
12454
| --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
12555
| `--workspace <path>` | Path to your workspace. All subdirectories except node_modules and those listed in `--ignore` are checked |

0 commit comments

Comments
 (0)