Require meta.docs.url in every rule

.neutrinorc.js

@@ -6,7 +6,11 @@ module.exports = {
 				plugins: ['self'],
 				rules: {
 					'self/latin-var-name-only': 'warn',
-					'self/no-rerely-used-words': 'warn'
+					'self/no-rerely-used-words': 'warn',
+					// 'self/no-special-in-object-members': 'warn',
+					'eslint-plugin/require-meta-docs-url': ['warn', {
+						'pattern': 'https://github.com/atomspace/eslint-plugin-naming-convention/blob/master/docs/rules/{{name}}.md'
+					 }]
 				}
 			}
 		}], 

package.json

@@ -20,7 +20,7 @@
   },
   "homepage": "https://github.com/atomspace/eslint-plugin-naming-convention#readme",
   "devDependencies": {
-    "@atomspace/eslint": "3.1.0",
+    "@atomspace/eslint": "3.3.0",
     "@neutrinojs/jest": "8.3.0",
     "@neutrinojs/node": "8.3.0",
     "neutrino": "8.3.0",

src/rules/latin-var-name-only/index.js

@@ -0,0 +1 @@
+module.exports = require('./latin-var-name-only');

src/rules/latin-var-name-only-rule/index.js → src/rules/latin-var-name-only/latin-var-name-only.js

@@ -6,17 +6,20 @@ let findClosestLatinToCyrrilicCharSimilarity = require('./closest-latin-to-cyrri
 module.exports = {
 	meta: {
 		type: 'problem',
+		docs: {
+			url: 'https://github.com/atomspace/eslint-plugin-naming-convention/blob/master/docs/rules/latin-var-name-only.md'
+		},
 		fixable: 'code'
 	},
-	create(context) {
+	create (context) {
 		return {
-			Identifier(node) {
+			Identifier (node) {
 				let varNameHasNonLatinSymbol = NOT_LATIN_SYMBOL_REGEXP.test(node.name);
 
 				if (varNameHasNonLatinSymbol) {
 					context.report({
 						node,
-						message: 'Variable name contains non-latin character',
+						message: 'Variable name contains non-latin character.',
 						fix: fixer => {
 							let member = node.name;
 

src/rules/no-rerely-used-words/index.js

@@ -1,26 +1 @@
-let checkRerelyUsedWords = require('./check-rerely-used-words');
-
-module.exports = {
-	meta: {
-		messages: {
-			noRerelyUsedWords: 'Avoid using rerely used words in identifiers'
-		}
-	},
-	create (context) {
-		return {
-			Identifier (node) {
-				let isRerelyUsedWord = checkRerelyUsedWords(node.name);
-
-				if (isRerelyUsedWord) {
-					context.report({
-						node,
-						messageId: 'noRerelyUsedWords',
-						data: {
-							name: node.name
-						}
-					});
-				}
-			}
-		};
-	}
-};
+module.exports = require('./no-rerely-used-words');

src/rules/no-rerely-used-words/no-rerely-used-words.js

@@ -0,0 +1,29 @@
+let checkRerelyUsedWords = require('./check-rerely-used-words');
+
+module.exports = {
+	meta: {
+		docs: {
+			url: 'https://github.com/atomspace/eslint-plugin-naming-convention/blob/master/docs/rules/no-rerely-used-words.md'
+		},
+		messages: {
+			noRerelyUsedWords: 'Avoid using rerely used words in identifiers.'
+		}
+	},
+	create (context) {
+		return {
+			Identifier (node) {
+				let isRerelyUsedWord = checkRerelyUsedWords(node.name);
+
+				if (isRerelyUsedWord) {
+					context.report({
+						node,
+						messageId: 'noRerelyUsedWords',
+						data: {
+							name: node.name
+						}
+					});
+				}
+			}
+		};
+	}
+};

src/rules/no-special-in-object-members.js

@@ -3,28 +3,31 @@ const SPECIAL_SYMBOLS_REGEXP = /[!#%&()*+/=@^_]/;
 module.exports = {
 	meta: {
 		type: 'problem',
+		docs: {
+			url: 'https://github.com/atomspace/eslint-plugin-naming-convention/blob/master/docs/rules/no-special-in-object-members.md'
+		},
 		messages: {
-			errorMessage: `The object member has special symbols: {{ listOfSpecialSymbolsInObjectMember }}`
+			errorMessage: `The object member has special symbols: {{ listOfSpecialSymbolsInObjectMember }}.`
 		}
 	},
-	create(context) {
+	create (context) {
 		return {
-			VariableDeclaration(node) {
+			VariableDeclaration (node) {
 				let objectProperties = node.declarations[0].init.properties;
 
 				objectProperties.forEach(property => {
-
 					let objectMemeber = property.key.value;
 					let specialSymbolInObjectMember = objectMemeber.match(SPECIAL_SYMBOLS_REGEXP);
 
 
 					if (specialSymbolInObjectMember) {
 						let listOfSpecialSymbolsInObjectMember = specialSymbolInObjectMember.join('');
+
 						context.report({
-							node: node,
+							node,
 							messageId: 'errorMessage',
 							data: {
-								listOfSpecialSymbolsInObjectMember: listOfSpecialSymbolsInObjectMember
+								listOfSpecialSymbolsInObjectMember
 							}
 						});
 					}

test/latin-var-name-only.test.js

@@ -1,4 +1,4 @@
-const latinVarNameOnly = require('../src/rules/latin-var-name-only-rule');
+const latinVarNameOnly = require('../src/rules/latin-var-name-only');
 
 let RuleTester = require('eslint').RuleTester;