Blame view

node_modules/eslint/lib/rules/no-inline-comments.js 1.99 KB
f7563de62   Palak Handa   first commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
  /**
   * @fileoverview Enforces or disallows inline comments.
   * @author Greg Cochard
   */
  "use strict";
  
  const astUtils = require("../ast-utils");
  
  //------------------------------------------------------------------------------
  // Rule Definition
  //------------------------------------------------------------------------------
  
  module.exports = {
      meta: {
          docs: {
              description: "disallow inline comments after code",
              category: "Stylistic Issues",
              recommended: false
          },
  
          schema: []
      },
  
      create(context) {
          const sourceCode = context.getSourceCode();
  
          /**
           * Will check that comments are not on lines starting with or ending with code
           * @param {ASTNode} node The comment node to check
           * @private
           * @returns {void}
           */
          function testCodeAroundComment(node) {
  
              // Get the whole line and cut it off at the start of the comment
              const startLine = String(sourceCode.lines[node.loc.start.line - 1]);
              const endLine = String(sourceCode.lines[node.loc.end.line - 1]);
  
              const preamble = startLine.slice(0, node.loc.start.column).trim();
  
              // Also check after the comment
              const postamble = endLine.slice(node.loc.end.column).trim();
  
              // Check that this comment isn't an ESLint directive
              const isDirective = astUtils.isDirectiveComment(node);
  
              // Should be empty if there was only whitespace around the comment
              if (!isDirective && (preamble || postamble)) {
                  context.report({ node, message: "Unexpected comment inline with code." });
              }
          }
  
          //--------------------------------------------------------------------------
          // Public
          //--------------------------------------------------------------------------
  
          return {
  
              LineComment: testCodeAroundComment,
              BlockComment: testCodeAroundComment
  
          };
      }
  };