@neolution-ch/eslint-config-neolution 1.0.0 → 1.2.0

package/CHANGELOG.md

@@ -7,12 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.0] - 2022-10-27
+
+### Added
+
+-   Added typescript to the import/resolver
+-   Added deprecated React types to the "ban-types" rule
+-   Added "complexity" rule with a maximum of 20
+-   Added "max-lines" rule with a maximum of 300 lines
+
+### Changed
+
+-   Updated "no-empty-function" rule to not allow any empty function
+-   Updated "quotes" rule by using the typescript version
+-   Updated "react/no-unstable-nested-components" rule to allow component creation inside component props
+
+## [1.1.0] - 2022-10-17
+
+### Added
+
+-   Added MIT license
+-   Enable react-hooks rules
+
 ## [1.0.0] - 2022-10-06
 
 ### Added
 
 -   Initial release 
 
-[Unreleased]: https://github.com/neolution-ch/eslint-config-neolution/compare/1.0.0...HEAD
+[Unreleased]: https://github.com/neolution-ch/eslint-config-neolution/compare/1.2.0...HEAD
+
+[1.2.0]: https://github.com/neolution-ch/eslint-config-neolution/compare/1.1.0...1.2.0
+
+[1.1.0]: https://github.com/neolution-ch/eslint-config-neolution/compare/1.0.0...1.1.0
 
 [1.0.0]: https://github.com/neolution-ch/eslint-config-neolution/compare/5f308ef87fa2a779e56cb6af4510baf6e2deeb23...1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Neolution AG
+
+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.

package/README.md

@@ -13,7 +13,7 @@ yarn add -D @neolution-ch/eslint-config-neolution
 
 Edit the `.eslintrc.js` of your project:
 
-```json
+```js
 module.exports = {
   ...
   extends: ["@neolution-ch/eslint-config-neolution"],
@@ -25,7 +25,7 @@ module.exports = {
 
 For React project you might need to adjust the "@typescript-eslint/naming-convention" rule to allow PascalCase for component names.
 
-```json
+```js
 module.exports = {
   ...
   rules: {
@@ -42,3 +42,7 @@ module.exports = {
   ...
 }
 ```
+
+## License
+
+[MIT](LICENSE.md)

package/index.js

@@ -5,6 +5,7 @@ module.exports = {
     "./rules/import",
     "./rules/jsdoc",
     "./rules/react",
+    "./rules/react-hooks",
     "./rules/next",
   ].map(require.resolve)
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neolution-ch/eslint-config-neolution",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "This package provides Neolution's .eslintrc as an extensible shared config.",
   "homepage": "https://github.com/neolution-ch/eslint-config-neolution",
   "main": "index.js",

package/rules/eslint.js

@@ -4,18 +4,22 @@ module.exports = {
   ].map(require.resolve),
 
   // View link below for eslint rules documentation
-  // https://eslint.org/docs/latest/rules/
+  // https://eslint.org/docs/rules/
   rules: {
     // The airbnb config enforce that class methods use "this", but requires changing how you call the method
-    // https://eslint.org/docs/latest/rules/class-methods-use-this
+    // https://eslint.org/docs/rules/class-methods-use-this
     "class-methods-use-this": "off",
 
+    // The airbnb config disables the complexity, but we want to limit it
+    // https://eslint.org/docs/rules/complexity
+    complexity: ["error", 20],
+
     // The airbnb config enforces consistent return, but we got problems with some external libraries, TypeScript enforces this anyway
-    // https://eslint.org/docs/latest/rules/consistent-return
+    // https://eslint.org/docs/rules/consistent-return
     "consistent-return": "off",
 
     // The airbnb config forces unix style, but somebody also works on windows
-    // https://eslint.org/docs/latest/rules/linebreak-style
+    // https://eslint.org/docs/rules/linebreak-style
     "linebreak-style": "off",
 
     // The airbnb config limits to 100 ignoring some lines, instad we allow 160 but don't ignore lines
@@ -29,12 +33,20 @@ module.exports = {
       ignoreRegExpLiterals: false,
     }],
 
+    // The airbnb disables the max lines, but we want to limit it
+    // https://eslint.org/docs/rules/max-lines
+    "max-lines": ["error", {
+      max: 300,
+      skipBlankLines: true,
+      skipComments: true
+    }],
+
     // The airbnb config disallow await inside of loops, but it cannot always be avoided
     // https://eslint.org/docs/rules/no-await-in-loop
     "no-await-in-loop": "off",
 
     // The airbnb config disallow use of the continue statement, but it's ok to have it
-    // https://eslint.org/docs/latest/rules/no-continue
+    // https://eslint.org/docs/rules/no-continue
     "no-continue": "off",
 
     // The airbnb config disallow use of unary operators (++ and --), but it's ok to have them
@@ -42,7 +54,7 @@ module.exports = {
     "no-plusplus": "off",
 
     // The airbnb config also restrict ForOfStatement, but we want to use it
-    // https://eslint.org/docs/latest/rules/no-restricted-syntax
+    // https://eslint.org/docs/rules/no-restricted-syntax
     "no-restricted-syntax": [
       "error",
       {
@@ -59,9 +71,5 @@ module.exports = {
         message: "`with` is disallowed in strict mode because it makes code impossible to predict and optimize.",
       },
     ],
-
-    // The airbnb config forces single quote, but we prefer double quote
-    // https://eslint.org/docs/latest/rules/quotes
-    quotes: ["error", "double", { avoidEscape: true }],
   },
 };

package/rules/import.js

@@ -10,8 +10,11 @@ module.exports = {
   settings: {
     "import/resolver": {
       node: {
-        extensions: [".js", ".jsx", ".ts", ".tsx"]
-      }
+        extensions: [".js", ".jsx", ".ts", ".tsx"],
+      },
+      typescript: {
+        alwaysTryTypes: true,
+      },
     },
   },
 

package/rules/react-hooks.js

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: [
+    "eslint-config-airbnb/hooks",
+  ].map(require.resolve),
+
+  // View link below for react-hooks rules documentation
+  // https://reactjs.org/docs/hooks-rules.html
+  rules: {
+  },
+};

package/rules/react.js

@@ -21,6 +21,10 @@ module.exports = {
     // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-one-expression-per-line.md
     "react/jsx-one-expression-per-line": "off",
 
+    // The airbnb config didn't allow component creation inside component props, but we want to allow it
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-unstable-nested-components.md
+    "react/no-unstable-nested-components": ["error", { allowAsProps: true }],
+
     // The airbnb config forces a defaultProps definition for every prop, but we don't want it
     // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/require-default-props.md
     "react/require-default-props": "off",

package/rules/typescript.js

@@ -16,6 +16,18 @@ module.exports = {
   // View link below for typescript rules documentation
   // https://typescript-eslint.io/rules/
   rules: {
+    // Disallow certain types
+    // https://typescript-eslint.io/rules/ban-types/
+    "@typescript-eslint/ban-types": ["error",{
+      types: {
+        "React.StatelessComponent": { message: "Deprecated: Do not use.", fixWith: "React.ReactElement" },
+        StatelessComponent: { message: "Deprecated: Do not use.", fixWith: "ReactElement" },
+        "React.FC": { message: "Please use ReactElement + PropsWithChildren", fixWith: "ReactElement" },
+        FC: { message: "Please use ReactElement + PropsWithChildren", fixWith: "ReactElement" },
+      },
+      extendDefaults: true,
+    }],
+
     // Enforce one true brace style (same as eslint-config-airbnb-base)
     // https://typescript-eslint.io/rules/brace-style
     "@typescript-eslint/brace-style": ["error", "1tbs", { allowSingleLine: true }],
@@ -108,14 +120,10 @@ module.exports = {
       format: ["PascalCase"],
     }],
 
-    // Disallow empty functions, except for standalone funcs/arrows (same as eslint-config-airbnb-base)
+    // Disallow empty functions
     // https://typescript-eslint.io/rules/no-empty-function
     "@typescript-eslint/no-empty-function": ["error", {
-      allow: [
-        "arrowFunctions",
-        "functions",
-        "methods",
-      ]
+      allow: [],
     }],
 
     // Disallow unnecessary parentheses (same as eslint-config-airbnb-base)
@@ -172,6 +180,11 @@ module.exports = {
     // https://typescript-eslint.io/rules/prefer-readonly-parameter-types
     "@typescript-eslint/prefer-readonly-parameter-types": "off",
 
+    // Enforce the consistent use of double quotes, but allow single quotes so long as the
+    // string contains a quote that would have to be escaped otherwise
+    // https://typescript-eslint.io/rules/quotes
+    "@typescript-eslint/quotes": ["error", "double", { avoidEscape: true }],
+
     // Require `await` in `async function` (note: this is a horrible rule that should never be used) (same as eslint-config-airbnb-base)
     // https://typescript-eslint.io/rules/require-await
     "@typescript-eslint/require-await": "off",