Merge pull request #6 from namics/develop

v2.2.0
merkle-open · Mar 2, 2017 · 3c23a07 · 3c23a07
2 parents 104791b + f23cbe9
commit 3c23a07
Show file tree

Hide file tree

Showing 6 changed files with 116 additions and 4 deletions.
diff --git a/documentation/es6.md b/documentation/es6.md
@@ -506,6 +506,48 @@ const str = `Hello, ${name}!`;
 
 
 
+### [Require jsdoc](http://eslint.org/docs/rules/require-jsdoc)
+
+> do not require jsdoc
+
+
+&#10003; Enabled (error)
+
+```javascript
+
+// BAD
+/*
+class Test {
+
+	constructor() {
+		this.test = '12';
+	}
+}
+*/
+
+// GOOD
+/**
+ * @constructor Test
+ */
+class Test {
+
+	/**
+	 * @returns {void}
+	 */
+	constructor() {
+		this.test = '12';
+	}
+}
+
+// OKAY
+const testArrow = () => 'testArrow';
+
+
+```
+<br />
+
+
+
 ### [Require yield](http://eslint.org/docs/rules/require-yield)
 
 > disallow generator functions that do not have yield

diff --git a/documentation/style.md b/documentation/style.md
@@ -706,6 +706,24 @@ function good() {
 
 &#10003; Enabled (error)
 
+```javascript
+
+// BAD
+/*
+function test() {
+	return 'test';
+}
+*/
+
+// GOOD
+/**
+ * @returns {string} - something
+ */
+function test() {
+	return 'test';
+}
+
+```
 <br />
 
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@namics/eslint-config",
-	"version": "2.1.0",
+	"version": "2.2.0",
 	"description": "Default configurations for eslint",
 	"author": "Simon Mollweide <simon.mollweide@namics.com>",
 	"license": "MIT",
@@ -18,7 +18,7 @@
 	"main": "configurations/es6-browser.js",
 	"scripts": {
 		"lint": "npm run lint:js",
-		"lint:js": "node_modules/.bin/eslint **/*.jsx **/*.js",
+		"lint:js": "node_modules/.bin/eslint test/**/*.jsx test/**/*.js",
 		"test": "npm run lint"
 	},
 	"keywords": [
@@ -40,7 +40,7 @@
 	},
 	"dependencies": {
 		"eslint-find-rules": "^1.14.3",
-		"eslint-plugin-jsx-a11y": "^3.0.1",
-		"eslint-plugin-react": "^6.7.1"
+		"eslint-plugin-jsx-a11y": "^4.0.0",
+		"eslint-plugin-react": "^6.10.0"
 	}
 }
diff --git a/rules/style.js b/rules/style.js
@@ -238,6 +238,7 @@ module.exports = {
 				FunctionDeclaration: true,
 				MethodDefinition: true,
 				ClassDeclaration: true,
+				ArrowFunctionExpression: false,
 			},
 		}],
 		// [08.07.2016] enabled

diff --git a/test/es5/rules/style/require-jsdoc.js b/test/es5/rules/style/require-jsdoc.js
@@ -2,7 +2,22 @@
 // DESCRIPTION = do not require jsdoc
 // STATUS = 2
 
+/* eslint no-unused-vars: 0*/
+
 // <!START
+// BAD
+/*
+function test() {
+	return 'test';
+}
+*/
 
+// GOOD
+/**
+ * @returns {string} - something
+ */
+function test() {
+	return 'test';
+}
 // END!>
 document.window.append('', null);
diff --git a/test/es6/rules/es6/require-jsdoc.js b/test/es6/rules/es6/require-jsdoc.js
@@ -0,0 +1,36 @@
+
+// DESCRIPTION = do not require jsdoc
+// STATUS = 2
+
+/* eslint no-unused-vars: 0*/
+
+// <!START
+// BAD
+/*
+class Test {
+
+	constructor() {
+		this.test = '12';
+	}
+}
+*/
+
+// GOOD
+/**
+ * @constructor Test
+ */
+class Test {
+
+	/**
+	 * @returns {void}
+	 */
+	constructor() {
+		this.test = '12';
+	}
+}
+
+// OKAY
+const testArrow = () => 'testArrow';
+
+// END!>
+document.window.append('', null);