isaacscript-lint 4.1.1 → 4.1.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.
Files changed (2) hide show
  1. package/README.md +10 -9
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -142,28 +142,30 @@ You can add extra rules (or ignore existing rules) by editing the `rules` sectio
142
142
 
143
143
  ### Extensions
144
144
 
145
- In order for the linter inside of VSCode, you will have to install the following extensions:
145
+ In order for the linter to work inside of VSCode, you will have to install the following extensions:
146
146
 
147
147
  - [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
148
148
  - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
149
149
 
150
- ### `.vscode/settings.json`
150
+ #### `.vscode/settings.json`
151
151
 
152
152
  Furthermore, you will probably want Prettier and ESLint to be run automatically every time you save a TypeScript file. You can tell VSCode to do this by adding the following to your project's `.vscode/settings.json` file:
153
153
 
154
154
  ```jsonc
155
- // These are Visual Studio Code settings that should apply to this particular repository
155
+ // These are Visual Studio Code settings that should apply to this particular repository.
156
156
  {
157
157
  "[javascript]": {
158
158
  "editor.codeActionsOnSave": ["source.fixAll.eslint"],
159
159
  "editor.defaultFormatter": "esbenp.prettier-vscode",
160
- "editor.formatOnSave": true
160
+ "editor.formatOnSave": true,
161
+ "editor.tabSize": 2
161
162
  },
162
163
 
163
164
  "[typescript]": {
164
165
  "editor.codeActionsOnSave": ["source.fixAll.eslint"],
165
166
  "editor.defaultFormatter": "esbenp.prettier-vscode",
166
- "editor.formatOnSave": true
167
+ "editor.formatOnSave": true,
168
+ "editor.tabSize": 2
167
169
  }
168
170
  }
169
171
  ```
@@ -172,7 +174,7 @@ Furthermore, you will probably want Prettier and ESLint to be run automatically
172
174
 
173
175
  You can also commit this file to your project's repository so that this behavior is automatically inherited by anyone who clones the project (and uses VSCode).
174
176
 
175
- ### `.vscode/extensions.json`
177
+ #### `.vscode/extensions.json`
176
178
 
177
179
  Optionally, you can also provide a hint to anyone cloning your repository that they should install the required extensions:
178
180
 
@@ -206,10 +208,9 @@ Optionally, you can also provide a hint to anyone cloning your repository that t
206
208
  - [`eslint-plugin-eslint-comments`](https://github.com/mysticatea/eslint-plugin-eslint-comments) - A plugin that provides rules relating to ESLint comments.
207
209
  - [`eslint-plugin-import`](https://github.com/benmosher/eslint-plugin-import) - Required as a peer dependency for `eslint-config-airbnb-base`.
208
210
  - [`eslint-plugin-jsdoc`](https://github.com/gajus/eslint-plugin-jsdoc) - A plugin that provides rules for [JSDoc](https://en.wikipedia.org/wiki/JSDoc).
209
- - [`eslint-plugin-no-implicit-map-set-loops`](https://github.com/Zamiell/eslint-plugin-no-implicit-map-set-loops) - A plugin that prevents unsafe iteration.
210
- - [`eslint-plugin-no-type-assertion`](https://github.com/Dremora/eslint-plugin-no-type-assertion) - A plugin that detects type assertions.
211
+ - [`eslint-plugin-no-type-assertion`](https://github.com/Dremora/eslint-plugin-no-type-assertion) - A plugin that detects type assertions. (In the standard config, these rules are not turned on automatically, but they are extremely useful in certain specific contexts.)
211
212
  - [`eslint-plugin-only-warn`](https://github.com/bfanger/eslint-plugin-only-warn) - A plugin that turns all errors to warnings.
212
- - [`eslint-plugin-sort-exports`](https://github.com/jrdrg/eslint-plugin-sort-exports) - A plugin that allows exports to be sorted alphabetically.
213
+ - [`eslint-plugin-sort-exports`](https://github.com/jrdrg/eslint-plugin-sort-exports) - A plugin that allows exports to be sorted alphabetically. (In the standard config, these rules are not turned on automatically, but they are extremely useful in certain specific contexts.)
213
214
  - [`prettier`](https://github.com/prettier/prettier) - This is the main code formatter, as explained above.
214
215
  - [`prettier-plugin-organize-imports`](https://github.com/simonhaenisch/prettier-plugin-organize-imports) - A plugin used because Prettier will not organize imports automatically. (It has no configuration and is automatically applied to Prettier if it is installed.)
215
216
  - [`ts-prune`](https://github.com/nadeesha/ts-prune) - A tool to look for unused exports, which catches bugs that the `import/no-unused-modules` rule cannot find.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "isaacscript-lint",
3
- "version": "4.1.1",
3
+ "version": "4.1.2",
4
4
  "description": "A linting dependency meta-package for IsaacScript and TypeScript projects.",
5
5
  "keywords": [
6
6
  "isaacscript",
@@ -28,7 +28,7 @@
28
28
  "eslint": "^8.21.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.0",
31
+ "eslint-config-isaacscript": "^3.1.1",
32
32
  "eslint-config-prettier": "^8.5.0",
33
33
  "eslint-plugin-eslint-comments": "^3.2.0",
34
34
  "eslint-plugin-import": "^2.26.0",