f44969a5ab
We have been stalled on ESLint 3.8.0 for some time. Current ESLint is 3.13.0. We have been unable to upgrade because of more aggressive reporting on some rules, including indentation. ESLint configuration options and bugfixes are now such that we can reasonably upgrade. PR-URL: https://github.com/nodejs/node/pull/10561 Reviewed-By: Teddy Katz <teddy.katz@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
89 lines
2.7 KiB
JavaScript
89 lines
2.7 KiB
JavaScript
/**
|
|
* @fileoverview A rule to ensure consistent quotes used in jsx syntax.
|
|
* @author Mathias Schreck <https://github.com/lo1tuma>
|
|
*/
|
|
|
|
"use strict";
|
|
|
|
//------------------------------------------------------------------------------
|
|
// Requirements
|
|
//------------------------------------------------------------------------------
|
|
|
|
const astUtils = require("../ast-utils");
|
|
|
|
//------------------------------------------------------------------------------
|
|
// Constants
|
|
//------------------------------------------------------------------------------
|
|
|
|
const QUOTE_SETTINGS = {
|
|
"prefer-double": {
|
|
quote: "\"",
|
|
description: "singlequote",
|
|
convert(str) {
|
|
return str.replace(/'/g, "\"");
|
|
}
|
|
},
|
|
"prefer-single": {
|
|
quote: "'",
|
|
description: "doublequote",
|
|
convert(str) {
|
|
return str.replace(/"/g, "'");
|
|
}
|
|
}
|
|
};
|
|
|
|
//------------------------------------------------------------------------------
|
|
// Rule Definition
|
|
//------------------------------------------------------------------------------
|
|
|
|
module.exports = {
|
|
meta: {
|
|
docs: {
|
|
description: "enforce the consistent use of either double or single quotes in JSX attributes",
|
|
category: "Stylistic Issues",
|
|
recommended: false
|
|
},
|
|
|
|
fixable: "whitespace",
|
|
|
|
schema: [
|
|
{
|
|
enum: ["prefer-single", "prefer-double"]
|
|
}
|
|
]
|
|
},
|
|
|
|
create(context) {
|
|
const quoteOption = context.options[0] || "prefer-double",
|
|
setting = QUOTE_SETTINGS[quoteOption];
|
|
|
|
/**
|
|
* Checks if the given string literal node uses the expected quotes
|
|
* @param {ASTNode} node - A string literal node.
|
|
* @returns {boolean} Whether or not the string literal used the expected quotes.
|
|
* @public
|
|
*/
|
|
function usesExpectedQuotes(node) {
|
|
return node.value.indexOf(setting.quote) !== -1 || astUtils.isSurroundedBy(node.raw, setting.quote);
|
|
}
|
|
|
|
return {
|
|
JSXAttribute(node) {
|
|
const attributeValue = node.value;
|
|
|
|
if (attributeValue && astUtils.isStringLiteral(attributeValue) && !usesExpectedQuotes(attributeValue)) {
|
|
context.report({
|
|
node: attributeValue,
|
|
message: "Unexpected usage of {{description}}.",
|
|
data: {
|
|
description: setting.description
|
|
},
|
|
fix(fixer) {
|
|
return fixer.replaceText(attributeValue, setting.convert(attributeValue.raw));
|
|
}
|
|
});
|
|
}
|
|
}
|
|
};
|
|
}
|
|
};
|