You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-7Lines changed: 21 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,8 @@ quick-lint-js finds many bugs, including:
13
13
14
14
## Installing
15
15
16
-
There are many ways to install `quick-lint-js`, depending on how you prefer to work! Here are the environments we support:
16
+
There are many ways to install quick-lint-js, depending on how you prefer to
17
+
work! Here are the environments we support:
17
18
18
19
- CLI (Command-Line Interface)
19
20
- LSP (Language Server Protocol)
@@ -25,44 +26,57 @@ There are many ways to install `quick-lint-js`, depending on how you prefer to w
25
26
- Emacs
26
27
- Kate
27
28
28
-
For detailed installation instructions, visit the [quick-lint-js installation guide](https://quick-lint-js.com/install/).
29
+
For detailed installation instructions, visit the [quick-lint-js installation
30
+
guide](https://quick-lint-js.com/install/).
29
31
30
32
## Examples
31
-
Here are some common bugs that `quick-lint-js` can catch:
33
+
34
+
Here are some common bugs that quick-lint-js can catch:
32
35
33
36
### Example 1: Undefined Variable
37
+
34
38
```js
35
39
constoccupation="Engineer";
36
40
console.log("Welcome, "+ ocupation); // Typo: 'ocupation' should be 'occupation'
37
41
```
38
42
Output: `use of undeclared variable: ocupation`
39
43
40
44
### Example 2: Reassigning a const variable
45
+
41
46
```js
42
47
constname="John";
43
48
name ="Doe"; // Error: Cannot reassign a constant
44
49
```
45
50
Output: `assignment to const variable: name`
46
51
47
52
### Example 3: Using await in a non-async function
53
+
48
54
```js
49
55
functiongetData() {
50
56
awaitfetch("/data");
51
57
}
52
58
```
53
59
Output: `await used in non-async function`
54
60
55
-
These are just a few examples of how `quick-lint-js` can help identify common issues in your JavaScript code.
61
+
These are just a few examples of how quick-lint-js can help identify common
62
+
issues in your JavaScript code.
56
63
57
64
## Contributing
58
65
59
-
We’re always happy to welcome new contributors! If you’d like to contribute to `quick-lint-js`, please refer to the contributing guide on our website for all the details.
66
+
We’re always happy to welcome new contributors! If you’d like to contribute to
67
+
quick-lint-js, please refer to the contributing guide on our website for all the
68
+
details.
60
69
61
70
Check out the [contributing guide here](https://quick-lint-js.com/contribute/).
62
71
63
72
## Contact
73
+
64
74
If you have any questions or feedback, feel free to reach out:
65
75
66
76
-**Bugs and feature requests**: File an issue on GitHub.
67
-
-**IRC**: Ask questions in the quick-lint-js channel on Libera.Chat.
68
-
-**Security bug reports** (private disclosure): Email us at strager.nds@gmail.com
77
+
-**IRC**: Ask questions in the [#quick-lint-js][quick-lint-js-irc-web] channel
78
+
on Libera.Chat.
79
+
-**Security bug reports** (private disclosure): Email us at
0 commit comments