1.4.0

SrBrahma · Jan 6, 2024 · b460e0d · b460e0d
1 parent 442c005
commit b460e0d
Show file tree

Hide file tree

Showing 11 changed files with 341 additions and 45 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -2,7 +2,7 @@
   "typescript.preferences.importModuleSpecifierEnding": "js",
   "typescript.tsdk": "node_modules/typescript/lib",
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": "explicit",
+    "source.fixAll.eslint": true,
     "source.organizeImports.biome": "explicit",
     "quickfix.biome": "explicit"
   },

diff --git a/ATTRIBUTION.md b/ATTRIBUTION.md
@@ -0,0 +1,26 @@
+Portions of this project include code from eslint-config-prettier, which is available under the MIT License.
+Source: https://github.com/prettier/eslint-config-prettier
+
+MIT License:
+
+The MIT License (MIT)
+
+Copyright (c) 2017, 2018, 2019, 2020, 2021, 2022, 2023 Simon Lydell and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.4.0
+
+- `eslint-config-prettier` is now added automatically. You can remove it from your dependencies and your eslint config.
+
+- Updated README so setup using .eslintrc.* suggests `"overrides"` instead of `"extends"`
+
 ## 1.3.0
 
 - Now relevant [TS Extension rules](https://typescript-eslint.io/rules/#extension-rules) are added automatically to the index.js. These were added:

diff --git a/LICENSE b/LICENSE
@@ -19,3 +19,5 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+For information on third-party code incorporated into this project, see the ATTRIBUTION.md file.
diff --git a/README.md b/README.md
@@ -23,14 +23,17 @@ simultaneous use of Biome and ESLint.
 npm install -D eslint-config-biome # or your preferred package manager ;)
 ```
 
-- `.eslintrc.*`: Add `"biome"` as the last item in the `extends` field.
+- `.eslintrc.*`: Add the following as the last item in the `"overrides"` array. Create it if necessary.
 
     ```json
     {
-      "extends": [
-        "other-configs",
-        "biome"
-      ]
+      "overrides": [
+        // other overrides,
+        {
+          files: ["*.ts", "*.js", "*.tsx", "*.jsx"],
+          extends: ["biome"],
+        }
+      ],
     }
     ```
 
@@ -40,40 +43,38 @@ npm install -D eslint-config-biome # or your preferred package manager ;)
     import eslintConfigBiome from "eslint-config-biome";
 
     export default [
-      otherConfigs,
+      // other configs,
       eslintConfigBiome,
     ];
     ```
 
 ## ℹ️ Info
 
-- In your .eslintrc, you can instead have this in `overrides`:
+- In VSCode, to apply Biome and ESLint on save, you should have these in your project's `.vscode/settings.json`:
 
-    ```
-    "overrides": [{
-      files: ["*.ts", "*.js", "*.tsx", "*.jsx"],
-      extends: ["biome"],
-    }],
+    ```json
+    {
+      "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": "explicit",
+        "source.organizeImports.biome": "explicit",
+        "quickfix.biome": "explicit"
+      },
+      "editor.defaultFormatter": "biomejs.biome"
+    }
     ```
 
-    - Being it the last item in the array, this makes other existing overrides to have this patch applied. This also overrides any rules that may lie in the root of your .eslintrc under `rules`.
+- For package.json scripts and CI, I recommend running `biome` before `eslint` for faster failure detection.
 
-- You should use it together with [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) so formatting rules are also disabled as Biome has almost 100% compatibility with prettier. It may eventually be integrated into this package, so you won't need to also install it.
-
-- In VSCode, to apply Biome and ESLint on save, you should have these in your settings.json:
-
-    ```json
-    "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": "explicit",
-      "source.organizeImports.biome": "explicit",
-      "quickfix.biome": "explicit"
-    },
-    "editor.defaultFormatter": "biomejs.biome"
-    ```
+  ```json
+  "scripts": {
+    "format:check": "biome check . && eslint .",
+    "format": "biome check --apply-unsafe . && eslint --fix",
+  }
+  ```
 
-- Soon there will be a npx tool to disable ESLint rules based on your biome config file, so non-recommended biome rules will also be considered.
+- Since v1.4.0, this package includes [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier), so formatting rules are also disabled as Biome has almost full compatibility with prettier. [Attribution](ATTRIBUTION.md). Its installation is no longer required and it can be removed from your project and your eslint config file.
 
-This package had its origin [in this discussion](https://github.com/biomejs/biome/discussions/3#discussioncomment-7876363). Thanks [DaniGuardiola
+This package had its origin [in this discussion](https://github.com/biomejs/biome/discussions/3#discussioncomment-7876363). Also, thanks [DaniGuardiola
 ](https://github.com/DaniGuardiola) for [your initial code](https://github.com/biomejs/biome/discussions/3#discussioncomment-7910787)!
 
 

diff --git a/biome.json b/biome.json
@@ -16,5 +16,5 @@
       "semicolons": "asNeeded"
     }
   },
-  "files": { "ignore": ["index.js"] }
+  "files": { "ignore": ["index.js", "eslint-config-prettier.js"] }
 }
diff --git a/eslint-config-prettier.js b/eslint-config-prettier.js
@@ -0,0 +1,225 @@
+/**
+ * eslint-config-prettier © 2017-2023 Simon Lydell and contributors
+ * https://github.com/prettier/eslint-config-prettier
+ *
+ * This code is licensed under the MIT License (MIT).
+ *
+ * File automatically created by scripts/index.ts.
+ */
+"use strict";
+
+const includeDeprecated = !process.env.ESLINT_CONFIG_PRETTIER_NO_DEPRECATED;
+
+const specialRule = 0;
+
+module.exports = {
+  rules: {
+    // The following rules can be used in some cases. See the README for more
+    // information. These are marked with `0` instead of `"off"` so that a
+    // script can distinguish them. Note that there are a few more of these
+    // in the deprecated section below.
+    "curly": specialRule,
+    "no-unexpected-multiline": specialRule,
+    "@typescript-eslint/lines-around-comment": specialRule,
+    "@typescript-eslint/quotes": specialRule,
+    "babel/quotes": specialRule,
+    "unicorn/template-indent": specialRule,
+    "vue/html-self-closing": specialRule,
+    "vue/max-len": specialRule,
+
+    // The rest are rules that you never need to enable when using Prettier.
+    "@babel/object-curly-spacing": "off",
+    "@babel/semi": "off",
+    "@typescript-eslint/block-spacing": "off",
+    "@typescript-eslint/brace-style": "off",
+    "@typescript-eslint/comma-dangle": "off",
+    "@typescript-eslint/comma-spacing": "off",
+    "@typescript-eslint/func-call-spacing": "off",
+    "@typescript-eslint/indent": "off",
+    "@typescript-eslint/key-spacing": "off",
+    "@typescript-eslint/keyword-spacing": "off",
+    "@typescript-eslint/member-delimiter-style": "off",
+    "@typescript-eslint/no-extra-parens": "off",
+    "@typescript-eslint/no-extra-semi": "off",
+    "@typescript-eslint/object-curly-spacing": "off",
+    "@typescript-eslint/semi": "off",
+    "@typescript-eslint/space-before-blocks": "off",
+    "@typescript-eslint/space-before-function-paren": "off",
+    "@typescript-eslint/space-infix-ops": "off",
+    "@typescript-eslint/type-annotation-spacing": "off",
+    "babel/object-curly-spacing": "off",
+    "babel/semi": "off",
+    "flowtype/boolean-style": "off",
+    "flowtype/delimiter-dangle": "off",
+    "flowtype/generic-spacing": "off",
+    "flowtype/object-type-curly-spacing": "off",
+    "flowtype/object-type-delimiter": "off",
+    "flowtype/quotes": "off",
+    "flowtype/semi": "off",
+    "flowtype/space-after-type-colon": "off",
+    "flowtype/space-before-generic-bracket": "off",
+    "flowtype/space-before-type-colon": "off",
+    "flowtype/union-intersection-spacing": "off",
+    "react/jsx-child-element-spacing": "off",
+    "react/jsx-closing-bracket-location": "off",
+    "react/jsx-closing-tag-location": "off",
+    "react/jsx-curly-newline": "off",
+    "react/jsx-curly-spacing": "off",
+    "react/jsx-equals-spacing": "off",
+    "react/jsx-first-prop-new-line": "off",
+    "react/jsx-indent": "off",
+    "react/jsx-indent-props": "off",
+    "react/jsx-max-props-per-line": "off",
+    "react/jsx-newline": "off",
+    "react/jsx-one-expression-per-line": "off",
+    "react/jsx-props-no-multi-spaces": "off",
+    "react/jsx-tag-spacing": "off",
+    "react/jsx-wrap-multilines": "off",
+    "standard/array-bracket-even-spacing": "off",
+    "standard/computed-property-even-spacing": "off",
+    "standard/object-curly-even-spacing": "off",
+    "unicorn/empty-brace-spaces": "off",
+    "unicorn/no-nested-ternary": "off",
+    "unicorn/number-literal-case": "off",
+    "vue/array-bracket-newline": "off",
+    "vue/array-bracket-spacing": "off",
+    "vue/array-element-newline": "off",
+    "vue/arrow-spacing": "off",
+    "vue/block-spacing": "off",
+    "vue/block-tag-newline": "off",
+    "vue/brace-style": "off",
+    "vue/comma-dangle": "off",
+    "vue/comma-spacing": "off",
+    "vue/comma-style": "off",
+    "vue/dot-location": "off",
+    "vue/func-call-spacing": "off",
+    "vue/html-closing-bracket-newline": "off",
+    "vue/html-closing-bracket-spacing": "off",
+    "vue/html-end-tags": "off",
+    "vue/html-indent": "off",
+    "vue/html-quotes": "off",
+    "vue/key-spacing": "off",
+    "vue/keyword-spacing": "off",
+    "vue/max-attributes-per-line": "off",
+    "vue/multiline-html-element-content-newline": "off",
+    "vue/multiline-ternary": "off",
+    "vue/mustache-interpolation-spacing": "off",
+    "vue/no-extra-parens": "off",
+    "vue/no-multi-spaces": "off",
+    "vue/no-spaces-around-equal-signs-in-attribute": "off",
+    "vue/object-curly-newline": "off",
+    "vue/object-curly-spacing": "off",
+    "vue/object-property-newline": "off",
+    "vue/operator-linebreak": "off",
+    "vue/quote-props": "off",
+    "vue/script-indent": "off",
+    "vue/singleline-html-element-content-newline": "off",
+    "vue/space-in-parens": "off",
+    "vue/space-infix-ops": "off",
+    "vue/space-unary-ops": "off",
+    "vue/template-curly-spacing": "off",
+
+    ...(includeDeprecated && {
+      // Removed in version 0.10.0.
+      // https://eslint.org/docs/latest/rules/space-unary-word-ops
+      "space-unary-word-ops": "off",
+
+      // Removed in version 1.0.0.
+      // https://github.com/eslint/eslint/issues/1898
+      "generator-star": "off",
+      "no-comma-dangle": "off",
+      "no-reserved-keys": "off",
+      "no-space-before-semi": "off",
+      "no-wrap-func": "off",
+      "space-after-function-name": "off",
+      "space-before-function-parentheses": "off",
+      "space-in-brackets": "off",
+
+      // Removed in version 2.0.0.
+      // https://github.com/eslint/eslint/issues/5032
+      "no-arrow-condition": "off",
+      "space-after-keywords": "off",
+      "space-before-keywords": "off",
+      "space-return-throw-case": "off",
+
+      // Deprecated since version 3.3.0.
+      // https://eslint.org/docs/rules/no-spaced-func
+      "no-spaced-func": "off",
+
+      // Deprecated since version 4.0.0.
+      // https://github.com/eslint/eslint/pull/8286
+      "indent-legacy": "off",
+
+      // Deprecated since version 8.53.0.
+      // https://eslint.org/blog/2023/10/deprecating-formatting-rules/
+      "array-bracket-newline": "off",
+      "array-bracket-spacing": "off",
+      "array-element-newline": "off",
+      "arrow-parens": "off",
+      "arrow-spacing": "off",
+      "block-spacing": "off",
+      "brace-style": "off",
+      "comma-dangle": "off",
+      "comma-spacing": "off",
+      "comma-style": "off",
+      "computed-property-spacing": "off",
+      "dot-location": "off",
+      "eol-last": "off",
+      "func-call-spacing": "off",
+      "function-call-argument-newline": "off",
+      "function-paren-newline": "off",
+      "generator-star-spacing": "off",
+      "implicit-arrow-linebreak": "off",
+      "indent": "off",
+      "jsx-quotes": "off",
+      "key-spacing": "off",
+      "keyword-spacing": "off",
+      "linebreak-style": "off",
+      "lines-around-comment": specialRule,
+      "max-len": specialRule,
+      "max-statements-per-line": "off",
+      "multiline-ternary": "off",
+      "new-parens": "off",
+      "newline-per-chained-call": "off",
+      "no-confusing-arrow": specialRule,
+      "no-extra-parens": "off",
+      "no-extra-semi": "off",
+      "no-floating-decimal": "off",
+      "no-mixed-operators": specialRule,
+      "no-mixed-spaces-and-tabs": "off",
+      "no-multi-spaces": "off",
+      "no-multiple-empty-lines": "off",
+      "no-tabs": specialRule,
+      "no-trailing-spaces": "off",
+      "no-whitespace-before-property": "off",
+      "nonblock-statement-body-position": "off",
+      "object-curly-newline": "off",
+      "object-curly-spacing": "off",
+      "object-property-newline": "off",
+      "one-var-declaration-per-line": "off",
+      "operator-linebreak": "off",
+      "padded-blocks": "off",
+      "quote-props": "off",
+      "quotes": specialRule,
+      "rest-spread-spacing": "off",
+      "semi": "off",
+      "semi-spacing": "off",
+      "semi-style": "off",
+      "space-before-blocks": "off",
+      "space-before-function-paren": "off",
+      "space-in-parens": "off",
+      "space-infix-ops": "off",
+      "space-unary-ops": "off",
+      "switch-colon-spacing": "off",
+      "template-curly-spacing": "off",
+      "template-tag-spacing": "off",
+      "wrap-iife": "off",
+      "wrap-regex": "off",
+      "yield-star-spacing": "off",
+
+      // Deprecated since version 7.0.0.
+      // https://github.com/yannickcr/eslint-plugin-react/blob/master/CHANGELOG.md#700---2017-05-06
+      "react/jsx-space-before-closing": "off",
+    }),
+  },
+};
diff --git a/index.js b/index.js
@@ -4,6 +4,7 @@
  * These are ESLint rules that have corresponding and recommended Biome rules.
  */
 module.exports = {
+  extends: ["./eslint-config-prettier.js"],
   rules: {
     "constructor-super": "off",
     "default-case-last": "off",

diff --git a/package.json b/package.json
@@ -1,11 +1,11 @@
 {
   "name": "eslint-config-biome",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Disables ESLint rules that have a recommended and equivalent Biome rule",
   "main": "index.js",
   "scripts": {
-    "format:check": "eslint . && biome check .",
-    "format": "eslint --fix biome check --apply-unsafe .",
+    "format:check": "biome check . && eslint .",
+    "format": "biome check --apply-unsafe . && eslint --fix",
     "tsw": "tsc --watch --noEmit",
     "typecheck": "tsc --noEmit",
     "pre-commit": "bun format:check && bun typecheck && bun test",