@wildpastry/eslint-config 1.6.1 → 1.6.3

package/.eslintrc

@@ -291,7 +291,7 @@
     // Other
     "line-comment-position": 1, // enforce position of line comments // DONE
     "lines-between-class-members": 0, // require or disallow an empty line between class members // DONE - OFF
-    "max-len": [1, { "code": 80, "ignoreUrls": true, "ignorePattern": "^import .*" }], // enforce a maximum line length // DONE - CUSTOMISED
+    "max-len": [1, { "code": 80, "ignoreUrls": true, "ignoreComments": true, "ignorePattern": "^import .*" }], // enforce a maximum line length // DONE - CUSTOMISED
     "max-statements-per-line": 1, // enforce a maximum number of statements allowed per line // DONE
     "padding-line-between-statements": 1, // require or disallow padding lines between statements // DONE
     "no-cond-assign": 1, // disallow assignment in conditional expressions // DONE

package/README.md

@@ -1,22 +1,26 @@
 # ESLintConfig
-Shareable ESLint configuration settings. No errors, only warnings.
+Shareable ESLint configuration settings linked with Prettier. ESLint formatting rules are disabled, then re-enabled through the eslint-prettier plugin. This way the formatting rules still get applied and Prettier formatting won't conflict with ESLint linting.
+
+No errors, only warnings.
 
 ## Prerequisites
+- NodeJS and NPM installed
+- Project set up with NodeJS and a package.json
 - Navigate to the root directory of your project
 
 ## Installation and usage
 
-### Install eslint and prettier
+### Install eslint and prettier core packages
 ```
 npm i eslint@latest prettier@latest
 ```
 
-### Install eslint and plugins
+### Install eslint plugins
 ```
 npm i @typescript-eslint/eslint-plugin@latest eslint-plugin-react@latest eslint-plugin-prettier@latest
 ```
 
-### Install eslint config
+### Install @wildpastry custom eslint config
 ```
 npm i @wildpastry/eslint-config@latest
 ```
@@ -32,6 +36,7 @@ add { "extends": "@wildpastry/eslint-config" } into .eslintrc and save
 ```
 
 ### Add these optional scripts to package.json
+These scripts will check/fix linting and formatting. Not everything can be automatically fixed.
 ```
 "scripts": {
   "lint": "eslint \"**/*.{js,jsx,ts,tsx}\"",

package/index.js

@@ -280,7 +280,7 @@ module.exports = {
   // Other
   "line-comment-position": 1, // enforce position of line comments // DONE
   "lines-between-class-members": 0, // require or disallow an empty line between class members // DONE - OFF
-  "max-len": [1, { "code": 80, "ignoreUrls": true, "ignorePattern": "^import .*" }], // enforce a maximum line length // DONE - CUSTOMISED
+  "max-len": [1, { "code": 80, "ignoreUrls": true, "ignoreComments": true, "ignorePattern": "^import .*" }], // enforce a maximum line length // DONE - CUSTOMISED
   "max-statements-per-line": 1, // enforce a maximum number of statements allowed per line // DONE
   "padding-line-between-statements": 1, // require or disallow padding lines between statements // DONE
   "no-cond-assign": 1, // disallow assignment in conditional expressions // DONE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildpastry/eslint-config",
-  "version": "1.6.1",
+  "version": "1.6.3",
   "description": "ESLint configuration file",
   "main": "index.js",
   "scripts": {