72 lines
1.8 KiB
JavaScript
72 lines
1.8 KiB
JavaScript
|
/**
|
||
|
|
* @fileoverview Comments inside children section of tag should be placed inside braces.
|
||
|
|
* @author Ben Vinegar
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
const docsUrl = require('../util/docsUrl');
|
||
|
|
const getText = require('../util/eslint').getText;
|
||
|
|
const report = require('../util/report');
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
// Rule Definition
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
const messages = {
|
||
|
|
putCommentInBraces: 'Comments inside children section of tag should be placed inside braces',
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param {Context} context
|
||
|
|
* @param {ASTNode} node
|
||
|
|
* @returns {void}
|
||
|
|
*/
|
||
|
|
function checkText(context, node) {
|
||
|
|
// since babel-eslint has the wrong node.raw, we'll get the source text
|
||
|
|
const rawValue = getText(context, node);
|
||
|
|
if (/^\s*\/(\/|\*)/m.test(rawValue)) {
|
||
|
|
// inside component, e.g. <div>literal</div>
|
||
|
|
if (
|
||
|
|
node.parent.type !== 'JSXAttribute'
|
||
|
|
&& node.parent.type !== 'JSXExpressionContainer'
|
||
|
|
&& node.parent.type.indexOf('JSX') !== -1
|
||
|
|
) {
|
||
|
|
report(context, messages.putCommentInBraces, 'putCommentInBraces', {
|
||
|
|
node,
|
||
|
|
});
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/** @type {import('eslint').Rule.RuleModule} */
|
||
|
|
module.exports = {
|
||
|
|
meta: {
|
||
|
|
docs: {
|
||
|
|
description: 'Disallow comments from being inserted as text nodes',
|
||
|
|
category: 'Possible Errors',
|
||
|
|
recommended: true,
|
||
|
|
url: docsUrl('jsx-no-comment-textnodes'),
|
||
|
|
},
|
||
|
|
|
||
|
|
messages,
|
||
|
|
|
||
|
|
schema: [],
|
||
|
|
},
|
||
|
|
|
||
|
|
create(context) {
|
||
|
|
// --------------------------------------------------------------------------
|
||
|
|
// Public
|
||
|
|
// --------------------------------------------------------------------------
|
||
|
|
|
||
|
|
return {
|
||
|
|
Literal(node) {
|
||
|
|
checkText(context, node);
|
||
|
|
},
|
||
|
|
JSXText(node) {
|
||
|
|
checkText(context, node);
|
||
|
|
},
|
||
|
|
};
|
||
|
|
},
|
||
|
|
};
|