V2.0.1- Add and modify rules (#8)

* modify rules * add array-element-newline rule * modify comma dangle rule * add space-infix-ops rule * add space-before-blocks rule * add newline-per-chained-call rule * added @typescript-eslint/no-explicit-any rule * update README * update README --------- Co-authored-by: nishant.kohli <[email protected]>
nishkohli96 · Apr 11, 2024 · 5b3e305 · 5b3e305
1 parent c3d6037
commit 5b3e305
Show file tree

Hide file tree

Showing 7 changed files with 70 additions and 10 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -1,5 +1,17 @@
 # **What's changed?**
 
+## [2.0.1](https://github.com/nishkohli96/eslint-config/tree/v2.0.1)
+
+**Released - 11 Apr, 2024**
+
+- Add the following rules in `js` config
+  - [@typescript-eslint/no-explicit-any](https://typescript-eslint.io/rules/no-explicit-any/)
+  - [array-element-newline](https://eslint.style/rules/default/array-element-newline)
+  - [newline-per-chained-call](https://eslint.style/rules/default/newline-per-chained-call)
+  - [space-before-blocks](https://eslint.style/rules/default/space-before-blocks)
+  - [space-infix-ops](https://eslint.style/rules/default/sace-infix-ops)
+- Modify [comma-dangle](https://eslint.style/rules/default/comma-dangle) config.
+
 ## [2.0.0](https://github.com/nishkohli96/eslint-config/tree/v2.0.0)
 
 **Released - 10 Apr, 2024**

diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ This config extends the following plugins and parsers -
 
 ## Installation
 
-You'll first need to install [ESLint](https://eslint.org/). If you project is a monorepo, add a `-W` flag to each of the commands below.
+You'll first need to install [ESLint](https://eslint.org/). If you project is a monorepo, consider creating a separate eslint-config for each package.
 
 ```
 npm i eslint --save-dev
@@ -74,7 +74,7 @@ To add a new rule, turn off or modify the existing list of rules, append the `ru
 }
 ```
 
-To disable one or more rules throughout the file,
+To disable one or more rules throughout the file, add this at the top of your file.
 ```
 /* eslint-disable  @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any */
 ```
@@ -108,7 +108,7 @@ npm run lint
 yarn lint
 ```
 
-For formatting non-js like `.css, .html` files you can use prettier alongside eslint. Prettier configuration, prettierignore and usage of eslint with prettier in `pre-commit` hook can be referenced from my [react-node-ts-monorepo](https://github.com/nishkohli96/react-node-ts-monorepo/tree/main).
+For formatting non-js like `.css, .html` files you can use prettier alongside eslint. Prettier configuration, prettierignore and usage of eslint with prettier in `pre-commit` hook can be referenced from my [react-node-ts-monorepo](https://github.com/nishkohli96/react-node-ts-monorepo/blob/main/package.json).
 
 ---
 
@@ -133,11 +133,12 @@ All rule names start with `@stylistic/` prefix.
 |-|-|
 |[array-bracket-newline](https://eslint.style/rules/default/array-bracket-newline)| { multiline: true, minItems: 4 } |
 |[array-bracket-spacing](https://eslint.style/rules/default/array-bracket-spacing)||
+|[array-element-newline](https://eslint.style/rules/default/array-element-newline)| { multiline: true, minItems: 4 } |
 |[arrow-parens](https://eslint.style/rules/default/arrow-parens)| as-needed |
 |[arrow-spacing](https://eslint.style/rules/default/arrow-spacing)||
 |[block-spacing](https://eslint.style/rules/default/block-spacing)||
 |[brace-style](https://eslint.style/rules/default/brace-style)||
-|[comma-dangle](https://eslint.style/rules/default/comma-dangle)||  always-multiline |
+|[comma-dangle](https://eslint.style/rules/default/comma-dangle)| { arrays: 'always', objects: 'always', imports: 'never', exports: 'never' functions: 'never' } |
 |[comma-spacing](https://eslint.style/rules/default/comma-spacing)||
 |[eol-last](https://eslint.style/rules/default/eol-last)||
 |[function-call-argument-newline](https://eslint.style/rules/default/function-call-argument-newline)| consistent |
@@ -146,6 +147,7 @@ All rule names start with `@stylistic/` prefix.
 |[indent-binary-ops](https://eslint.style/rules/default/indent-binary-ops)| 2 |
 |[key-spacing](https://eslint.style/rules/default/key-spacing)||
 |[linebreak-style](https://eslint.style/rules/default/linebreak-style)||
+|[newline-per-chained-call](https://eslint.style/rules/default/newline-per-chained-call)||
 |[no-extra-semi](https://eslint.style/rules/default/no-extra-semi)||
 |[no-floating-decimal](https://eslint.style/rules/default/no-floating-decimal)||
 |[no-mixed-spaces-and-tabs](https://eslint.style/rules/default/no-mixed-spaces-and-tabs)||
@@ -158,8 +160,10 @@ All rule names start with `@stylistic/` prefix.
 |[operator-linebreak](https://eslint.style/rules/default/operator-linebreak)| before |
 |[quotes](https://eslint.style/rules/default/quotes)| single |
 |[rest-spread-spacing](https://eslint.style/rules/default/rest-spread-spacing)||
-|[space-unary-ops](https://eslint.style/rules/default/sace-unary-ops)||
 |[semi-spacing](https://eslint.style/rules/default/semi-spacing)||
+|[space-before-blocks](https://eslint.style/rules/default/space-before-blocks)| { functions: 'always', classes: 'always', keywords: 'never' } |
+|[space-infix-ops](https://eslint.style/rules/default/space-infix-ops)||
+|[space-unary-ops](https://eslint.style/rules/default/space-unary-ops)||
 |[spaced-comment](https://eslint.style/rules/default/spaced-comment)||
 |[switch-colon-spacing](https://eslint.style/rules/default/switch-colon-spacing)||
 |[template-curly-spacing](https://eslint.style/rules/default/template-curly-spacing)||
@@ -212,6 +216,7 @@ The eslint rule(s) listed below will give an error and will have to be manually
 
 | Rule Name | Status |
 |-|-|
+|[@typescript-eslint/no-explicit-any](https://typescript-eslint.io/rules/no-explicit-any/) | warn |
 |[no-unused-vars](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/ban-ts-comment.md) | warn |
 |[no-this-alias](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-this-alias.mdx) | off |
 
@@ -262,7 +267,7 @@ You will need to manually add them in the `rules` of your .eslintrc, if needed.
 |-|-|
 |[jsx-first-prop-new-line](https://eslint.style/rules/default/jsx-first-prop-new-line)| |
 |[@stylistic/lines-around-comment](https://eslint.style/rules/default/lines-around-comment)| Sometimes reqd, when writing block comments above functions, but don't need when writing block comment between 2 lines of code |
-|[@typescript-eslint/ban-ts-comment](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/ban-ts-comment.mdx) |
+|[@typescript-eslint/ban-ts-comment](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/ban-ts-comment.mdx) | A good developer will avoid writing ts-comments, except in extreme cases. Let's not cause them trouble to write one more line |
 |[@typescript-eslint/no-this-alias](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-this-alias.md) | sometimes `this` is reqd in fn context. eg. MongooseSchema.pre() |
 |[id-denylist](https://eslint.org/docs/latest/rules/id-denylist) | use if required. eg. "id-denylist": ["warn", "e", "cb", 'callback']|
 [id-length](https://eslint.org/docs/latest/rules/id-length)| warning when using `_` for unused vars |

diff --git a/__tests__/bad-js.js b/__tests__/bad-js.js
@@ -1,13 +1,32 @@
 var st = "122"
 
+var tryq = '2463'
+tryq.toLowerCase().replace('1','8')
+tryq.toLowerCase().replace('1','8').split('').map(el => `-${el}-`)
+
 const func = (e) => console.log('some function');
 
 
 
 const obj = { name: 'john', age: 36}
 
-function someFN(var1,var2,var3) {return var1-var2+var3}
+const res = a?b:c
+
+function a(){}
+function someFN(var1,var2,var3){return var1-var2+var3}
+
+class Foo{
+  constructor(){}
+}
+
+for (;;) {
+  // ...
+}
+
+let arr = [2,42,42,33,23,67,234,2323]
+arr.forEach(ele => ele+=1)
 
+var arr2 = ['raj', 'rajesh', 'rajesh kumar']
 
 // const element = () => {
 // 	return (

diff --git a/__tests__/bad-jsx.js b/__tests__/bad-jsx.js
@@ -1,3 +1,4 @@
+import { Button, Grid, Radio, FormControl } from '@mui/material';
 const element = () => {
 	return (
 		<div>

diff --git a/lib/js/index.js b/lib/js/index.js
@@ -24,11 +24,21 @@ module.exports = {
       { multiline: true, minItems: 4 },
     ],
     '@stylistic/array-bracket-spacing': 'warn',
+    '@stylistic/array-element-newline': [
+      'warn',
+      { multiline: true, minItems: 4 },
+    ],
     '@stylistic/arrow-parens': ['warn', 'as-needed'],
     '@stylistic/arrow-spacing': 'warn',
     '@stylistic/block-spacing': 'warn',
     '@stylistic/brace-style': 'warn',
-    '@stylistic/comma-dangle': ['warn', 'always-multiline'],
+    '@stylistic/comma-dangle': ['warn', {
+      arrays: 'always',
+      objects: 'always',
+      imports: 'never',
+      exports: 'never',
+      functions: 'never'
+    }],
     '@stylistic/comma-spacing': 'warn',
     '@stylistic/eol-last': 'warn',
     '@stylistic/function-call-argument-newline': ['warn', 'consistent'],
@@ -37,6 +47,7 @@ module.exports = {
     '@stylistic/indent-binary-ops': ['warn', 2],
     '@stylistic/key-spacing': 'warn',
     '@stylistic/linebreak-style': 'warn',
+    '@stylistic/newline-per-chained-call': 'warn',
     '@stylistic/no-extra-semi': 'warn',
     '@stylistic/no-floating-decimal': 'warn',
     '@stylistic/no-mixed-operators': 'error',
@@ -51,21 +62,28 @@ module.exports = {
     '@stylistic/quotes': ['warn', 'single'],
     '@stylistic/rest-spread-spacing': 'warn',
     '@stylistic/semi-spacing': 'warn',
-    '@stylistic/spaced-comment': 'warn',
+    '@stylistic/space-before-blocks': ['warn', {
+      functions: 'always',
+      classes: 'always',
+      keywords: 'never'
+    }],
+    '@stylistic/space-infix-ops': 'warn',
     '@stylistic/space-unary-ops': [
       'warn',
       {
         words: true,
         nonwords: false,
       },
     ],
+    '@stylistic/spaced-comment': 'warn',
     '@stylistic/switch-colon-spacing': 'warn',
     '@stylistic/template-curly-spacing': 'warn',
     '@stylistic/type-annotation-spacing': 'warn',
     '@stylistic/type-generic-spacing': 'warn',
     '@stylistic/type-named-tuple-spacing': 'warn',
     '@stylistic/wrap-regex': 'warn',
     '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-explicit-any': 'warn',
     '@typescript-eslint/no-unused-vars': 'warn',
     '@typescript-eslint/no-this-alias': 'off',
     'array-callback-return': 'warn',

diff --git a/lib/react/index.js b/lib/react/index.js
@@ -47,8 +47,13 @@ module.exports = {
         return: 'parens-new-line',
       },
     ],
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-explicit-any': 'warn',
+    '@typescript-eslint/no-this-alias': 'off',
+    '@typescript-eslint/no-unused-vars': 'warn',
     'jsx-a11y/anchor-ambiguous-text': 'error',
     'jsx-a11y/control-has-associated-label': 'error',
+    'no-mixed-spaces-and-tabs': 'off',
     'react/react-in-jsx-scope': 'off',
     'react/jsx-uses-vars': 'error',
     'react/jsx-filename-extension': [

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nish1896/eslint-config",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "eslint and stylistic rules to help you focus more on the code logic, while they take care of the code formatting",
   "author": "Nishant Kohli",
   "exports": {