isaacscript-lint 4.12.0 → 4.12.1

package/README.md

@@ -2,21 +2,15 @@
 
 [![npm version](https://img.shields.io/npm/v/isaacscript-lint.svg)](https://www.npmjs.com/package/isaacscript-lint)
 
-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.
+This is a helper/meta package to install all of the dependencies necessary for [Prettier](https://prettier.io/) + [ESLint](https://eslint.org/) to work with a typical TypeScript project.
 
 <br>
 
-## For Use in a TypeScript / TypeScriptToLua Project
+## Why This Package Is Useful
 
 `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`.
 
-See the [installation instructions](#installation-instructions-for-typescript-projects) below.
-
-<br>
-
-## For Use in an Isaacscript Mod
-
-Use the `isaacscript init` tool to automatically set up a new mod that has `isaacscript-lint` as a dependency and a starting `eslintrc.cjs` config file.
+If you are ready to start, see the [installation instructions](#installation-instructions-for-typescript-projects) below.
 
 <br>
 
@@ -65,7 +59,14 @@ It should have a `package.json` file, a `tsconfig.json` file, and so on.
 ### Step 1 - Install the Dependency
 
 ```sh
+# If you use npm:
 npm install isaacscript-lint --save-dev
+
+# If you use yarn:
+yarn install isaacscript-lint --dev
+
+# If you use pnpm:
+pnpm install isaacscript-lint --save-dev
 ```
 
 (It should be a development dependency because it is only used to lint your code pre-production.)
@@ -76,7 +77,7 @@ Create a `eslintrc.cjs` file in the root of your repository:
 
 ```js
 // This is the configuration file for ESLint, the TypeScript linter:
-// https://eslint.org/docs/latest/user-guide/configuring
+// https://eslint.org/docs/latest/use/configure/
 module.exports = {
   extends: [
     // The linter base is the shared IsaacScript config:
@@ -91,8 +92,9 @@ module.exports = {
     project: "./tsconfig.eslint.json",
   },
 
-  // We modify the linting rules from the base for some specific things.
-  rules: {},
+  rules: {
+    // Insert changed or disabled rules here, if necessary.
+  },
 };
 ```
 
@@ -102,31 +104,48 @@ Create a `tsconfig.eslint.json` file in the root of your repository:
 
 <!-- cspell:ignore Gruntfile -->
 
-```jsonc
+```ts
 // A special TypeScript configuration file, used by ESLint only.
 {
   "extends": "./tsconfig.json",
 
-  // A list of the TypeScript files to compile:
+  // We want to lint every file in the repository, regardless of whether it is actually bundled into
+  // the TypeScript output or not. Two entries for each file extension are needed because TypeScript
+  // will exclude files that begin with a period from an asterisk glob by default.
   "include": [
-    // This must match the "include" setting in the main "tsconfig.json" file.
-    "./src/**/*.ts",
-
-    // These are ESLint-only inclusions. Usually, this includes any files that are outside of your
-    // "src" directory, such as "webpack.config.js", "jest.config.js", "Gruntfile.js", and so forth.
-    "./.eslintrc.cjs"
-  ]
+    "./**/*.js",
+    "./**/.*.js",
+    "./**/*.cjs",
+    "./**/.*.cjs",
+    "./**/*.mjs",
+    "./**/.*.mjs",
+    "./**/*.jsx",
+    "./**/.*.jsx",
+    "./**/*.ts",
+    "./**/.*.ts",
+    "./**/*.cts",
+    "./**/.*.cts",
+    "./**/*.mts",
+    "./**/.*.mts",
+    "./**/*.tsx",
+    "./**/.*.tsx"
+  ],
 }
 ```
 
+### Step 4 - Enabling Auto-Fix on Save
+
+- You will probably want to set up your code editor such that both Prettier and ESLint are automatically run every time the file is saved.
+- If you see VSCode, see [the VSCode section below](#integration-with-vscode).
+- It's also possible to set this up in other editors such as [Webstorm](https://www.jetbrains.com/webstorm/) and [Neovim](https://neovim.io/), but we don't provide detailed instructions for that here.
+
 <br>
 
 ## Adding or Removing Rules
 
-You can add extra rules (or ignore existing rules) by editing the `rules` section of your `eslintrc.cjs` file. For example:
+You can add extra ESLint rules (or ignore existing ESLint rules) by editing the `rules` section of your `eslintrc.cjs` file. For example:
 
 ```js
-  // We modify the linting rules from the base for some specific things.
   rules: {
     "@typescript-eslint/no-unused-vars": "off",
   },
@@ -151,22 +170,22 @@ In order for the linter to work inside of VSCode, you will have to install the f
 
 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:
 
-```jsonc
+```ts
 // These are Visual Studio Code settings that should apply to this particular repository.
 {
   "[javascript]": {
     "editor.codeActionsOnSave": ["source.fixAll.eslint"],
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true,
-    "editor.tabSize": 2
+    "editor.tabSize": 2,
   },
 
   "[typescript]": {
     "editor.codeActionsOnSave": ["source.fixAll.eslint"],
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true,
-    "editor.tabSize": 2
-  }
+    "editor.tabSize": 2,
+  },
 }
 ```
 
@@ -178,15 +197,15 @@ You can also commit this file to your project's repository so that this behavior
 
 Optionally, you can also provide a hint to anyone cloning your repository that they should install the required extensions:
 
-```jsonc
+```ts
 // These are Visual Studio Code extensions that are intended to be used with this particular
 // repository: https://go.microsoft.com/fwlink/?LinkId=827846
 {
   "recommendations": [
     "esbenp.prettier-vscode", // The TypeScript formatter
     "dbaeumer.vscode-eslint", // The TypeScript linter
-    "streetsidesoftware.code-spell-checker" // A spell-checker extension based on CSpell
-  ]
+    "streetsidesoftware.code-spell-checker", // A spell-checker extension based on CSpell
+  ],
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-lint",
-  "version": "4.12.0",
+  "version": "4.12.1",
   "description": "A linting dependency meta-package for IsaacScript and TypeScript projects.",
   "keywords": [
     "isaacscript",
@@ -30,7 +30,7 @@
     "eslint": "^8.34.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-config-isaacscript": "^3.5.0",
+    "eslint-config-isaacscript": "^3.5.1",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.27.5",