eslint-config-isaacscript 3.7.2 → 4.0.0

package/README.md

@@ -2,34 +2,6 @@
 
 [![npm version](https://img.shields.io/npm/v/eslint-config-isaacscript.svg)](https://www.npmjs.com/package/eslint-config-isaacscript)
 
-This is a sharable configuration for ESLint that is intended to be used in TypeScript and IsaacScript projects.
+This is a sharable configuration for [ESLint](https://eslint.org/) that is intended to be used in TypeScript projects.
 
-This package is consumed by the [`isaacscript-lint`](https://github.com/IsaacScript/isaacscript/tree/main/packages/isaacscript-lint) meta-linting package. It is recommended that instead of consuming this package directly, you instead list `isaacscript-lint` as a dependency, as it includes all of the corresponding plugins and so on.
-
-For TypeScript projects, set up your `.eslintrc.cjs` file to extend from the config like this:
-
-```js
-// This is the configuration file for ESLint, the TypeScript linter:
-// https://eslint.org/docs/user-guide/configuring
-module.exports = {
-  extends: [
-    // The linter base is the shared IsaacScript config:
-    // https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js
-    "eslint-config-isaacscript/base",
-  ],
-
-  // Don't bother linting the compiled output.
-  ignorePatterns: ["**/dist/**"],
-
-  parserOptions: {
-    // ESLint needs to know about the project's TypeScript settings in order for TypeScript-specific
-    // things to lint correctly. We do not point this at "./tsconfig.json" because certain files
-    // (such at this file) should be linted but not included in the actual project output.
-    project: "./tsconfig.eslint.json",
-  },
-
-  rules: {},
-};
-```
-
-Please see the [IsaacScript webpage](https://isaacscript.github.io/) for more information.
+Please see the [docs](https://isaacscript.github.io/eslint-config-isaacscript) for more information.

package/base-eslint-comments.js

@@ -0,0 +1,59 @@
+// This ESLint config only contains rules from `eslint-plugin-eslint-comments`:
+// https://github.com/mysticatea/eslint-plugin-eslint-comments
+
+// Rules are separated into categories:
+// 1) Best Practices
+// 2) Stylistic Issues
+
+/** @type {import("eslint").Linter.RulesRecord} */
+const BEST_PRACTICES = {
+  /**
+   * The `allowWholeFile` option is enabled because it is common practice to use "eslint-disable"
+   * comments for a whole file.
+   */
+  "eslint-comments/disable-enable-pair": [
+    "error",
+    {
+      allowWholeFile: true,
+    },
+  ],
+
+  "eslint-comments/no-aggregating-enable": "error",
+  "eslint-comments/no-duplicate-disable": "error",
+
+  /**
+   * Disabled because if a line breaks three or more ESLint rules, then it is useful to use a single
+   * "eslint-disable" comment to make things more concise.
+   */
+  "eslint-comments/no-unlimited-disable": "off",
+
+  "eslint-comments/no-unused-disable": "error",
+  "eslint-comments/no-unused-enable": "error",
+};
+
+/** @type {import("eslint").Linter.RulesRecord} */
+const STYLISTIC_ISSUES = {
+  /**
+   * Disabled because it is only useful in projects that want to prevent disabling specific ESLint
+   * rules.
+   */
+  "eslint-comments/no-restricted-disable": "off",
+
+  /** Disabled because we want to allow disabling ESLint rules where appropriate. */
+  "eslint-comments/no-use": "off",
+
+  /** Disabled because requiring descriptions for every ESLint disable would be too cumbersome. */
+  "eslint-comments/require-description": "off",
+};
+
+/** @type {import("eslint").Linter.Config} */
+const config = {
+  plugins: ["eslint-comments"],
+
+  rules: {
+    ...BEST_PRACTICES,
+    ...STYLISTIC_ISSUES,
+  },
+};
+
+module.exports = config;