chore(dev-deps): add eslint-plugin-eslint-plugin and eslint-plugin-node

Author: bmish

.eslintrc.js

@@ -1,6 +1,11 @@
 module.exports = {
   root: true,
-  extends: ['eslint:recommended', 'plugin:prettier/recommended'],
+  extends: [
+    'eslint:recommended',
+    'plugin:eslint-plugin/recommended',
+    'plugin:node/recommended',
+    'plugin:prettier/recommended',
+  ],
   env: {
     es2017: true,
     node: true,

lib/index.js

@@ -1,14 +1,11 @@
 'use strict';
 
+const requireIndex = require('requireindex');
+
 //------------------------------------------------------------------------------
 // Plugin Definition
 //------------------------------------------------------------------------------
 
 module.exports = {
-  rules: {
-    'no-const-outside-module-scope': require('./rules/no-const-outside-module-scope'),
-    'no-empty-yuidoc-code-blocks': require('./rules/no-empty-yuidoc-code-blocks'),
-    'require-yuidoc-access': require('./rules/require-yuidoc-access'),
-    'require-yuidoc-code-block-type': require('./rules/require-yuidoc-code-block-type'),
-  },
+  rules: requireIndex(`${__dirname}/rules`),
 };

lib/rules/no-const-outside-module-scope.js

@@ -1,7 +1,12 @@
 'use strict';
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
-  meta: { fixable: 'code', schema: [] },
+  meta: {
+    type: 'suggestion',
+    fixable: 'code',
+    schema: [],
+  },
   create(context) {
     return {
       VariableDeclaration: function (node) {
@@ -43,5 +48,3 @@ module.exports = {
     };
   },
 };
-
-module.exports.schema = []; // no options

lib/rules/no-empty-yuidoc-code-blocks.js

@@ -8,27 +8,32 @@ function hasEmptyCodeBlock(comment) {
   return comment.value.match(/(^```(js|javascript|.+\.js\s*)$)(\s)*?(```$)/gm);
 }
 
-module.exports = function (context) {
-  var sourceCode = context.getSourceCode();
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    schema: [],
+  },
+  create: function (context) {
+    var sourceCode = context.getSourceCode();
 
-  sourceCode.getAllComments().forEach(function (comment) {
-    if (comment.type !== 'Block') {
-      return;
-    }
-    if (!isDocComment(comment)) {
-      return;
-    }
-    if (!hasEmptyCodeBlock(comment)) {
-      return;
-    }
+    sourceCode.getAllComments().forEach(function (comment) {
+      if (comment.type !== 'Block') {
+        return;
+      }
+      if (!isDocComment(comment)) {
+        return;
+      }
+      if (!hasEmptyCodeBlock(comment)) {
+        return;
+      }
 
-    context.report({
-      loc: comment.loc.start,
-      message: 'Code blocks cannot be empty inside doc comments.',
+      context.report({
+        loc: comment.loc.start,
+        message: 'Code blocks cannot be empty inside doc comments.',
+      });
     });
-  });
 
-  return {};
+    return {};
+  },
 };
-
-module.exports.schema = []; // no options

lib/rules/require-yuidoc-access.js

@@ -12,31 +12,36 @@ function includesAccessDeclaration(comment) {
   return comment.value.match(/\r?\n\s*(@private|@public|@protected)\s/);
 }
 
-module.exports = function (context) {
-  var sourceCode = context.getSourceCode();
-
-  sourceCode.getAllComments().forEach(function (comment) {
-    if (comment.type !== 'Block') {
-      return;
-    }
-    if (!isDocComment(comment)) {
-      return;
-    }
-    if (isModuleOnlyComment(comment)) {
-      return;
-    }
-    if (includesAccessDeclaration(comment)) {
-      return;
-    }
-
-    context.report({
-      loc: comment.loc.start,
-      message:
-        'Access declaration missing, you must supply `@public`, `@private`, or `@protected` for doc comments.',
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    schema: [],
+  },
+  create: function (context) {
+    var sourceCode = context.getSourceCode();
+
+    sourceCode.getAllComments().forEach(function (comment) {
+      if (comment.type !== 'Block') {
+        return;
+      }
+      if (!isDocComment(comment)) {
+        return;
+      }
+      if (isModuleOnlyComment(comment)) {
+        return;
+      }
+      if (includesAccessDeclaration(comment)) {
+        return;
+      }
+
+      context.report({
+        loc: comment.loc.start,
+        message:
+          'Access declaration missing, you must supply `@public`, `@private`, or `@protected` for doc comments.',
+      });
     });
-  });
 
-  return {};
+    return {};
+  },
 };
-
-module.exports.schema = []; // no options

lib/rules/require-yuidoc-code-block-type.js

@@ -21,30 +21,35 @@ function getEmptyCodeBlocks(comment) {
   return empty;
 }
 
-module.exports = function (context) {
-  var sourceCode = context.getSourceCode();
-
-  sourceCode.getAllComments().forEach(function (comment) {
-    if (comment.type !== 'Block') {
-      return;
-    }
-    if (!isDocComment(comment)) {
-      return;
-    }
-    var emptyCodeBlocks = getEmptyCodeBlocks(comment);
-    if (!emptyCodeBlocks || !emptyCodeBlocks.length) {
-      return;
-    }
-
-    emptyCodeBlocks.forEach(function (block) {
-      context.report({
-        loc: block.loc,
-        message: 'Code blocks require a type, like `javascript`, for doc comments.',
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    schema: [],
+  },
+  create: function (context) {
+    var sourceCode = context.getSourceCode();
+
+    sourceCode.getAllComments().forEach(function (comment) {
+      if (comment.type !== 'Block') {
+        return;
+      }
+      if (!isDocComment(comment)) {
+        return;
+      }
+      var emptyCodeBlocks = getEmptyCodeBlocks(comment);
+      if (!emptyCodeBlocks || !emptyCodeBlocks.length) {
+        return;
+      }
+
+      emptyCodeBlocks.forEach(function (block) {
+        context.report({
+          loc: block.loc,
+          message: 'Code blocks require a type, like `javascript`, for doc comments.',
+        });
       });
     });
-  });
 
-  return {};
+    return {};
+  },
 };
-
-module.exports.schema = []; // no options

package.json

@@ -10,19 +10,24 @@
   "author": "Tobias Bieniek",
   "main": "lib/index.js",
   "scripts": {
-    "lint:fix": "yarn lint --fix",
-    "lint": "eslint .",
+    "lint": "npm-run-all \"lint:*\"",
+    "lint:js": "eslint .",
+    "lint:js:fix": "yarn lint:js --fix",
     "test": "mocha tests --recursive"
   },
   "dependencies": {
-    "line-column": "^1.0.2"
+    "line-column": "^1.0.2",
+    "requireindex": "^1.2.0"
   },
   "devDependencies": {
-    "eslint": "~7.10.0",
-    "eslint-config-prettier": "^6.12.0",
-    "eslint-plugin-prettier": "^3.1.4",
-    "mocha": "^8.1.3",
-    "prettier": "^2.1.2"
+    "eslint": "^7.0.0",
+    "eslint-config-prettier": "^7.0.0",
+    "eslint-plugin-eslint-plugin": "^3.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.0.0",
+    "mocha": "^8.0.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.0.0"
   },
   "license": "MIT",
   "directories": {

tests/lib/rules/require-yuidoc-code-block-type.js

@@ -21,16 +21,14 @@ ruleTester.run('require-yuidoc-code-block-type', rule, {
 
   invalid: [
     {
-      code:
-        '/**\nDummy method.\n```js\ntest1\n```\n\nhello\n\n```\ntest2\n```\nhello2\n\n```\ntest3\n```\n\n@method foo\n@return {String}\n*/',
+      code: '/**\nDummy method.\n```js\ntest1\n```\n\nhello\n\n```\ntest2\n```\nhello2\n\n```\ntest3\n```\n\n@method foo\n@return {String}\n*/',
       errors: [
         { message: 'Code blocks require a type, like `javascript`, for doc comments.' },
         { message: 'Code blocks require a type, like `javascript`, for doc comments.' },
       ],
     },
     {
-      code:
-        '/**\nDummy method.\n```app/users/route.js\ntest1\n```\n\nhello\n\n```\ntest2\n```\nhello2\n\n@method foo\n@return {String}\n*/',
+      code: '/**\nDummy method.\n```app/users/route.js\ntest1\n```\n\nhello\n\n```\ntest2\n```\nhello2\n\n@method foo\n@return {String}\n*/',
       errors: [{ message: 'Code blocks require a type, like `javascript`, for doc comments.' }],
     },
     {