@guardian/eslint-config 1.0.2 → 2.0.0

package/.eslintrc.js

@@ -8,10 +8,7 @@ module.exports = {
 		'eslint:recommended',
 		'plugin:import/errors',
 		'plugin:import/warnings',
-
-		// this works for all possible configs in v8
-		// https://github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md#version-800-2021-02-21
-		'plugin:prettier/recommended',
+		'prettier',
 	],
 	plugins: ['eslint-comments'],
 	rules: {

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @guardian/eslint-config
 
+## 2.0.0
+
+### Major Changes
+
+- 0f0888d: _tl;dr_
+
+  - linting for conformance with our `prettier` config is slow
+  - to speed up linting, we will stop doing that
+  - you should use `prettier` directly
+
+  ### Before
+
+  We extended `plugin:prettier/recommended` which
+
+  1. used `eslint-config-prettier` to disable any white-space formatting rules that would conflict with our prettier config
+  2. used `eslint-plugin-prettier` to lint for formatting errors that did not match our prettier config
+
+  This is quite expensive, and although it means you could use `--fix` to apply prettier, it's not as fast as using prettier directly.
+
+  ### After
+
+  We still use `eslint-config-prettier` to avoid conflicts with our `prettier` config, but we no longer lint for errors (and therefore also don't fix them).
+
+  ### Recommendations
+
+  Use `prettier` directly, e.g.
+
+  - via [editor integration](https://prettier.io/docs/en/editors.html)
+  - via a [pre-commit hook](https://prettier.io/docs/en/precommit.html)
+
+  If you prefer the way this used to work, add the [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) manually to your ESLint config.
+
 ## 1.0.2
 
 ### Patch Changes

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@guardian/eslint-config",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "ESLint config for Guardian JavaScript projects",
-  "homepage": "https://github.com/guardian/csnx/tree/main/libs/eslint-config#readme",
+  "homepage": "https://github.com/guardian/csnx/tree/main/packages/eslint-config#readme",
   "bugs": {
     "url": "https://github.com/guardian/csnx/issues"
   },
@@ -15,8 +15,7 @@
   "dependencies": {
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-eslint-comments": "3.2.0",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-prettier": "4.0.0"
+    "eslint-plugin-import": "2.26.0"
   },
   "peerDependencies": {
     "eslint": "^8.0.0"
@@ -25,5 +24,5 @@
     "access": "public"
   },
   "readme": "ERROR: No README data found!",
-  "_id": "@guardian/eslint-config@1.0.2"
+  "_id": "@guardian/eslint-config@2.0.0"
 }