isaacscript-lint 4.3.0 → 4.5.0

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.
Files changed (2) hide show
  1. package/README.md +5 -6
  2. package/package.json +10 -10
package/README.md CHANGED
@@ -2,13 +2,13 @@
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/isaacscript-lint.svg)](https://www.npmjs.com/package/isaacscript-lint)
4
4
 
5
- `isaacscript-lint` is a helper package to install all of the dependencies necessary for ESLint to work with a typical TypeScript project or a typical IsaacScript mod.
5
+ This is a helper package to install all of the dependencies necessary for ESLint to work with a typical TypeScript project or a typical IsaacScript mod.
6
6
 
7
7
  <br>
8
8
 
9
9
  ## For Use in a TypeScript / TypeScriptToLua Project
10
10
 
11
- `isaacscript-lint` is a great starting point for any TypeScript project. It's a pain in the ass to get ESLint working with TypeScript and to get everything working properly. Don't clutter your `package.json` file with 15+ different ESlint-related dependencies; just use `isaacscript-lint`.
11
+ `isaacscript-lint` is a great starting point for any TypeScript project. It's a pain in the ass to get ESLint working with TypeScript and to get everything working properly. Don't clutter your `package.json` file with 15+ different ESLint-related dependencies; just use `isaacscript-lint`.
12
12
 
13
13
  See the [installation instructions](#installation-instructions-for-typescript-projects) below.
14
14
 
@@ -50,7 +50,7 @@ ESLint is the industry standard tool for linting in JavaScript and TypeScript. A
50
50
 
51
51
  Because of the advantages of Prettier, we use it on top of the Airbnb config, and prefer Prettier's changes if there are any conflicts. Any ESLint rules that conflict with Prettier are turned off with [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier).
52
52
 
53
- Finally, some specific Airbnb rules are disabled, since they don't make much sense in certain contexts. You can see the specific exclusions in the [base.js](https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js) and [mod.js](https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/mod.js) files of the [`eslint-config-isaacscript`](https://github.com/IsaacScript/isaacscript/tree/main/packages/eslint-config-isaacscript) repository.
53
+ Finally, some specific Airbnb rules are disabled, since they don't make much sense in certain contexts. You can see the specific exclusions in the [base.js](https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js) and [mod.js](https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/mod.js) files of the [`eslint-config-isaacscript`](https://github.com/IsaacScript/isaacscript/tree/main/packages/eslint-config-isaacscript) package.
54
54
 
55
55
  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 `isaacscript-lint`, you should be running both Prettier and ESLint on save. (More info on that is below.)
56
56
 
@@ -180,13 +180,12 @@ Optionally, you can also provide a hint to anyone cloning your repository that t
180
180
 
181
181
  ```jsonc
182
182
  // These are Visual Studio Code extensions that are intended to be used with this particular
183
- // repository
184
- // https://go.microsoft.com/fwlink/?LinkId=827846
183
+ // repository: https://go.microsoft.com/fwlink/?LinkId=827846
185
184
  {
186
185
  "recommendations": [
187
186
  "esbenp.prettier-vscode", // The TypeScript formatter
188
187
  "dbaeumer.vscode-eslint", // The TypeScript linter
189
- "streetsidesoftware.code-spell-checker" // A spell-checker extension based on cspell
188
+ "streetsidesoftware.code-spell-checker" // A spell-checker extension based on CSpell
190
189
  ]
191
190
  }
192
191
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "isaacscript-lint",
3
- "version": "4.3.0",
3
+ "version": "4.5.0",
4
4
  "description": "A linting dependency meta-package for IsaacScript and TypeScript projects.",
5
5
  "keywords": [
6
6
  "isaacscript",
@@ -22,22 +22,22 @@
22
22
  "type": "commonjs",
23
23
  "dependencies": {
24
24
  "@prettier/plugin-xml": "^2.2.0",
25
- "@typescript-eslint/eslint-plugin": "^5.47.1",
26
- "@typescript-eslint/parser": "^5.47.1",
27
- "cspell": "^6.18.0",
28
- "eslint": "^8.30.0",
25
+ "@typescript-eslint/eslint-plugin": "^5.48.1",
26
+ "@typescript-eslint/parser": "^5.48.1",
27
+ "cspell": "^6.18.1",
28
+ "eslint": "^8.31.0",
29
29
  "eslint-config-airbnb-base": "^15.0.0",
30
30
  "eslint-config-airbnb-typescript": "^17.0.0",
31
- "eslint-config-isaacscript": "^3.1.2",
32
- "eslint-config-prettier": "^8.5.0",
31
+ "eslint-config-isaacscript": "^3.3.0",
32
+ "eslint-config-prettier": "^8.6.0",
33
33
  "eslint-plugin-eslint-comments": "^3.2.0",
34
- "eslint-plugin-import": "^2.26.0",
35
- "eslint-plugin-isaacscript": "^1.5.4",
34
+ "eslint-plugin-import": "^2.27.4",
35
+ "eslint-plugin-isaacscript": "^1.7.0",
36
36
  "eslint-plugin-jsdoc": "^39.6.4",
37
37
  "eslint-plugin-no-type-assertion": "^1.3.0",
38
38
  "eslint-plugin-only-warn": "^1.1.0",
39
39
  "eslint-plugin-sort-exports": "^0.8.0",
40
- "prettier": "^2.8.1",
40
+ "prettier": "^2.8.2",
41
41
  "prettier-plugin-organize-imports": "^3.2.1",
42
42
  "ts-prune-2": "^0.10.7"
43
43
  },