@odg/eslint-config 1.15.1 → 1.16.0

package/README.md

@@ -527,6 +527,7 @@
   - [No Collection Size Mischeck](#no-collection-size-mischeck)
   - [No Gratuitous Expressions](#no-gratuitous-expressions)
   - [No Unused Collection](#no-unused-collection)
+  - [No Inconsistent Docblock](#no-inconsistent-docblock)
 - [YAML / JSON](#yaml-json)
 
 ## Introduction
@@ -554,7 +555,7 @@ Add script in your `package.json` file
 ```json
 {
     "scripts": {
-        "lint": "eslint --ext .js,.jsx,.ts,.tsx,.json,.jsonc,.json5,.yml,.yaml,.xml,.txt,.svg,.properties,.gradle,.java,.cpp,.c,.cs,.html,.css,.groovy,.gitignore,.npmignore,.toml,.env,.example,.sample,.ini,.php,.bat,.powershell,.ps1,.sh,.bash",
+        "lint": "eslint --ext .js,.jsx,.ts,.tsx,.json,.jsonc,.json5,.yml,.yaml,.xml,.txt,.svg,.properties,.gradle,.java,.cpp,.c,.cs,.html,.css,.groovy,.gitignore,.npmignore,.toml,.env,.example,.sample,.ini,.php,.bat,.powershell,.ps1,.sh,.bash,.eslintrc",
     }
 }
 ```
@@ -20118,6 +20119,58 @@ function getLength(a, b, c) {
 }
 ```
 
+### No Inconsistent Docblock
+
+----------
+
+Check a valid typescript and docblock
+
+<https://github.com/ODGodinho/ODGEslintPlugin#no-inconsistent-docblock>
+
+👍 Examples of correct code
+
+```typescript
+/**
+ * Valid Param
+ *
+ * @param {string} param
+ */
+function name(param: string) {
+
+}
+
+/**
+ * Valid return
+ *
+ * @returns {string}
+ */
+function name2(): string {
+
+}
+```
+
+👎 Examples of incorrect code
+
+```typescript
+/**
+ * Valid Param
+ *
+ * @param {number} param
+ */
+function name(param: string) {
+
+}
+
+/**
+ * Valid return
+ *
+ * @returns {number}
+ */
+function name2(): string {
+
+}
+```
+
 ## Yaml Json
 
 add suport yaml and json files

package/index.js

@@ -11,6 +11,7 @@ module.exports = {
         "sonar",
         "sonarjs",
         "security",
+        "@odg",
     ],
     extends: [
         "./rules/global/base.js",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@odg/eslint-config",
-    "version": "1.15.1",
+    "version": "1.16.0",
     "description": "Linter for JavaScript And Typescript project",
     "main": "index.js",
     "author": "Dragons Gamers <https://www.linkedin.com/in/victor-alves-odgodinho>",
@@ -22,6 +22,7 @@
     },
     "dependencies": {
         "@babel/core": "*",
+        "@odg/eslint-plugin": "*",
         "@typescript-eslint/eslint-plugin": "*",
         "@typescript-eslint/parser": "*",
         "any-eslint-parser": "^1.0.1",

package/rules/typescript/possible-errors.js

@@ -26,5 +26,6 @@ module.exports = {
         "@typescript-eslint/brace-style": [ "error" ], // Força formatação {}
         "sonarjs/no-extra-arguments": [ "off" ], // Argumentos extra ja é tratado por typescript
         "sonarjs/no-use-of-empty-return-value": [ "off" ], // Não atribua void em uma variável
+        "@odg/no-inconsistent-docblock": [ "error" ], // Valida Docblock @param e @return com tipagem
     },
 };