complete-lint 1.0.0 → 1.0.2
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 +5 -5
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ This is a meta package to install all of the dependencies necessary for [ESLint]
|
|
|
6
6
|
|
|
7
7
|
## Why This Package Is Useful
|
|
8
8
|
|
|
9
|
-
It is a pain to get Prettier & ESLint working with TypeScript. `
|
|
9
|
+
It is a pain to get Prettier & ESLint working with TypeScript. `complete-lint` is designed to make it as easy as possible. Don't clutter your `package.json` file with 15+ different ESLint-related dependencies. Don't bother researching which of the hundreds of existing ESLint rules to turn on and turn off. Just use `complete-lint`.
|
|
10
10
|
|
|
11
11
|
If you are ready to start, see the [installation instructions](#installation-instructions).
|
|
12
12
|
|
|
@@ -149,16 +149,16 @@ In JavaScript and TypeScript land, there isn't an official code formatting stand
|
|
|
149
149
|
|
|
150
150
|
[Prettier](https://prettier.io/) is an auto-formatter for JavaScript/TypeScript. First released in 2017, it has become widespread and is probably considered to be the industry standard in 2023. Prettier works by completely rebuilding your code from scratch using the [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree), which allows it to make better transformations than other tools.
|
|
151
151
|
|
|
152
|
-
In `
|
|
152
|
+
In `complete-lint`, we choose we choose the Prettier style for code formatting, since it is the most popular TypeScript style. Any ESLint rules that conflict with Prettier are turned off with [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier).
|
|
153
153
|
|
|
154
|
-
Prettier handles almost everything, but the `
|
|
154
|
+
Prettier handles almost everything, but the `complete-lint` linting config also has a few formatting-related rules turned on, like [`complete/format-jsdoc-comments`](TODO) (since Prettier does not format comments).
|
|
155
155
|
|
|
156
156
|
### ESLint
|
|
157
157
|
|
|
158
158
|
ESLint is the best tool to lint JavaScript and TypeScript, as it has a massive ecosystem of rules and plugins that can help find errors in your codebase.
|
|
159
159
|
|
|
160
|
-
With `
|
|
160
|
+
With `complete-lint`, the philosophy is that we want to enable as many lint rules as possible, so that we can catch as many bugs as possible. It takes a lot of work to figure out which rules to turn on and which to not bother with, but we've done it for you. This is documented in more detail on [the docs for `eslint-config-complete`](TODO).
|
|
161
161
|
|
|
162
162
|
### Using Prettier & ESLint Together
|
|
163
163
|
|
|
164
|
-
In order to avoid running two different tools, we could use [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) to run Prettier as an ESLint rule. However, doing this [is not recommended by Prettier](https://prettier.io/docs/en/integrating-with-linters.html). Thus, in order to use `
|
|
164
|
+
In order to avoid running two different tools, we could use [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) to run Prettier as an ESLint rule. However, doing this [is not recommended by Prettier](https://prettier.io/docs/en/integrating-with-linters.html). Thus, in order to use `complete-lint`, you should be running both Prettier and ESLint on save. (More info on that is below.)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "complete-lint",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "A linting dependency meta-package for TypeScript projects.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"lint",
|
|
@@ -27,10 +27,10 @@
|
|
|
27
27
|
"dependencies": {
|
|
28
28
|
"@prettier/plugin-xml": "^3.4.1",
|
|
29
29
|
"cspell": "^8.14.2",
|
|
30
|
-
"cspell-check-unused-words": "^1.3.
|
|
31
|
-
"eslint": "^9.
|
|
32
|
-
"eslint-config-complete": "^
|
|
33
|
-
"knip": "^5.
|
|
30
|
+
"cspell-check-unused-words": "^1.3.1",
|
|
31
|
+
"eslint": "^9.10.0",
|
|
32
|
+
"eslint-config-complete": "^1.0.0",
|
|
33
|
+
"knip": "^5.30.0",
|
|
34
34
|
"prettier": "^3.3.3",
|
|
35
35
|
"prettier-plugin-organize-imports": "^4.0.0",
|
|
36
36
|
"prettier-plugin-packagejson": "^2.5.2"
|