update rule no-commented-out-code: remove deprecated eslint functions

Author: Manu1400

lib/rules/no-commented-out-code.js

@@ -1,102 +1,58 @@
-/**
- * from https://github.com/bahmutov/eslint-rules
-*/
 const { parse } = require('espree');
-const quote = require('quote');
-
-//function isJshint(text) {
-//  return /^jshint\ /.test(text);
-//}
 
 const isSingleWord = function (text) {
   return /^[\w-]*$/.test(text);
 }
 
-const isValidCode = function (text) {
-  if (isSingleWord(text)) { // || isJshint(text)
-    return false;
-  }
-  // string used to disable Flow typing for the next line
-  if (text.trim() === "$FlowFixMe") { //TODO: add this string as a new option
+const isValidCode = function (text, MAX_LENGTH = 10) {
+  if (text.length <= MAX_LENGTH) {
     return false
   }
-  // $FlowFixMe: suppressing this error until we can refactor
-  if (/^\$FlowFixMe/.test(text)) {
-    return false
+
+  if (text === " $FlowFixMe" || isSingleWord(text) ) {
+    return false;
   }
-  if (/^\$FlowTODO/.test(text)) {
+  if (/^\$FlowFixMe/.test(text) || /^\$FlowTODO/.test(text)) {
     return false
   }
-  //todo: read .flowconfig file
-  // see https://flow.org/en/docs/config/options/#suppress_comment-regex-
-
-  //TODO: put max length value as option, in rule "no-commented-out-code"
-  const MAX_LENGTH = 10
-  //if (text.length <= MAX_LENGTH) {
-  //  return false
-  //}
-
-  //TODO: put this as an rule option
-  const options = {
-    ecmaVersion: 6,
-  }
 
   try {
-    const ast = parse(text, options);
-    // check EmptyStatement -> if EmptyStatement exist return false
+    const ast = parse(text, {
+      ecmaVersion: 6,
+    });
     return Boolean(ast);
-  } catch (err) {
-    //console.error(err)
+  } catch (error) {
     return false;
   }
 }
 
-const firstLine = function (str) {
-  return str.split('\n')[0];
-}
-
-const cutStr = function (str) {
-  const MAX_LENGTH = 20;
-
-  var line = firstLine(str);
-  if (line.length > MAX_LENGTH) {
-    line = line.substr(0, MAX_LENGTH) + ' ...';
+const create = function (context) {
+  const sourceCode = context.getSourceCode()
+  const comments = sourceCode.getAllComments()
+
+  return {
+    'Program': node => {
+      comments.forEach(function (comment) {
+        if (isValidCode(comment.value)) {
+          context.report({
+            node: comments[0],
+            message: 'commented out code ',
+            // eslint-disable-next-line id-blacklist
+            data: {
+              nbComments: comments.length
+            }
+          })
+        }
+      })
+    },
   }
-  return line;
-}
-
-/**
- * @return array
- */
-const getCommentsWithCode = function(context) {
-  // deprecated:  Use sourceCode.getAllComments() instead.
-  var comments = context.getAllComments();
-
-  //TODO: array -> use map ?
-  //TODO: can move to a function
-  // eslint-disable-next-line no-useless-assign/no-useless-assign
-  comments = comments.filter(function (comment) {
-    return isValidCode(comment.value.trim());
-  })
-  return comments
 }
 
-module.exports = function (context) {
-  const comments = getCommentsWithCode(context)
-  
-  comments.forEach(function (commentedCode) {
-    const code = cutStr(commentedCode.value.trim()); //TODO: duplicate code : trim
-    const lines = commentedCode.loc.end.line - commentedCode.loc.start.line + 1;
-    const linesMsg = '(' + lines + ' line' + (lines === 1 ? '' : 's') + ')';
-
-    //TODO: support --fix in no-commented-out-code rule
-    context.report({
-      loc: commentedCode.loc
-    }, 'commented out code ' //+ quote(code) + ' ' + linesMsg //TODO: update BIS
-    );
-  });
-
-  return {}
-};
-
-// TODO: add recommanded: false
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: "Detect commented code"
+    },
+  }
+}

tests/lib/rules/no-commented-out-code.js

@@ -8,7 +8,7 @@ ruleTester.run("no-commented-out-code", rule, {
 
     valid: [
       {
-        code: "// this is a long comment about nothing",
+        code: "var a = 0;",
       },
       {
         code: "//this is a long comment about nothing",
@@ -28,9 +28,6 @@ ruleTester.run("no-commented-out-code", rule, {
       {
         code: "// please don't call method getElement()",
       },
-      {
-        code: "/*\n\n\n\n\n\n\n\n\n\n\n\n*/",
-      },
       {
         code: "//TODO",
       },
@@ -67,6 +64,9 @@ ruleTester.run("no-commented-out-code", rule, {
       {
         code: "/*flow-include\ntype Foo = {\nfoo: number\n};\n*/",
       },
+      {
+        code: "//; test",
+      },
     ],
 
     invalid: [
@@ -82,12 +82,6 @@ ruleTester.run("no-commented-out-code", rule, {
                 message: 'commented out code '
             }]
         },
-        {
-            code: "//; test",
-            errors: [{
-                message: 'commented out code '
-            }]
-        },
         {
             code: "// var a = 0 / 1",
             errors: [{
@@ -104,26 +98,32 @@ ruleTester.run("no-commented-out-code", rule, {
         {
             code: "/* var a = 1; \n const b = 2; \n var c = 3; */",
             errors: [{
-                message: 'commented out code '
+                message: 'commented out code ',
+                type: "Block"
             }]
         },
         {
             code: "//'use strict'",
             errors: [{
-                message: 'commented out code ' //`commented out code "'use strict'" (1 line)`
+                message: 'commented out code '
             }]
         },
         {
-            code: "// var a = 1",
+            code: "// var aaaaaaaaaaaaaaaa = 1",
             errors: [{
-                message: 'commented out code ' //`commented out code "var a = 1" (1 line)`
+                message: 'commented out code '
             }]
         },
         {
             code: "// const a = 1",
             errors: [{
-                message: 'commented out code ' //`commented out code "const a = 1" (1 line)`
+                message: 'commented out code '
             }]
+        }, {
+          code: "/*\n\n\n\n\n\n\n\n\n\n\n\n var a = 0 */",
+          errors: [{
+            message: 'commented out code '
+          }]
         },
     ]
 });