/** * @fileoverview Enforces or disallows inline comments. * @author Greg Cochard */ "use strict"; var astUtils = require("../ast-utils"); //------------------------------------------------------------------------------ // Rule Definition //------------------------------------------------------------------------------ module.exports = { meta: { docs: { description: "disallow inline comments after code", category: "Stylistic Issues", recommended: false }, schema: [] }, create: function(context) { /** * 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 var startLine = String(context.getSourceLines()[node.loc.start.line - 1]); var endLine = String(context.getSourceLines()[node.loc.end.line - 1]); var preamble = startLine.slice(0, node.loc.start.column).trim(); // Also check after the comment var postamble = endLine.slice(node.loc.end.column).trim(); // Check that this comment isn't an ESLint directive var isDirective = astUtils.isDirectiveComment(node); // Should be empty if there was only whitespace around the comment if (!isDirective && (preamble || postamble)) { context.report(node, "Unexpected comment inline with code."); } } //-------------------------------------------------------------------------- // Public //-------------------------------------------------------------------------- return { LineComment: testCodeAroundComment, BlockComment: testCodeAroundComment }; } };