Merge pull request #20 from gynzy/YETI-977

Linting improvements for unicorn repos

README.md

@@ -1,5 +1,7 @@
 # Gynzy Conventions
-This is the conventions repository. Aside from documenting code conventions used at Gynzy, this repository also holds common ESLint configurations used in our services.
+This is the conventions repository, describing code conventions and provides ESLint configurations used in unicorn services.
+
+[Conventions Wiki](https://github.com/gynzy/gynzy-conventions/wiki)
 
 ## ESLint Installation
 To install this package:
@@ -45,8 +47,3 @@ root/
 +-- .eslintrc.js	(extends .eslintrc.js)
 +-- .prettierrc.js	(requires .prettierrc)
 ```
-
-## Documentation
-[Conventions Wiki](https://github.com/gynzy/gynzy-conventions/wiki)
-
-[Ember styleguide](./ember-styleguide.md)

configs/.eslintrc.js

@@ -7,28 +7,17 @@ module.exports = {
 		es6: true,
 		node: true,
 	},
-	extends: ['eslint:recommended', 'plugin:prettier/recommended'],
+	extends: ['eslint:recommended', 'plugin:prettier/recommended', 'plugin:jsdoc/recommended'],
 	parserOptions: {
 		sourceType: 'module',
-		ecmaVersion: 9
+		ecmaVersion: 9,
 	},
 	rules: {
 		'linebreak-style': ['error', 'unix'],
-		'valid-jsdoc': ['error'],
-		'require-jsdoc': [
-			'error',
-			{
-				require: {
-					FunctionDeclaration: true,
-					MethodDefinition: true,
-					ClassDeclaration: true,
-				},
-			},
-		],
-		'max-statements': ['error', 20],
-		complexity: ['error', 10],
-		'max-depth': ['error', 5],
-		'max-params': ['error', 5],
+		'max-statements': ['warn', 20],
+		complexity: ['warn', 10],
+		'max-depth': ['warn', 5],
+		'max-params': ['warn', 5],
 		'require-await': ['error'],
 		'prefer-arrow-callback': ['error'],
 		'no-param-reassign': ['error'],
@@ -40,6 +29,8 @@ module.exports = {
 			},
 		],
 		'one-var-declaration-per-line': ['error'],
-		'no-return-await': ['error']
+		'no-return-await': ['error'],
+		'jsdoc/no-undefined-types': 'off',
+		'jsdoc/check-types': 'off',
 	},
 };

configs/.eslintrc.test.js

@@ -2,6 +2,7 @@
  * ESLint config for test modules like ava.
  */
 module.exports = {
+	root: true,
 	env: {
 		es6: true,
 		node: true,