You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
95 lines
2.9 KiB
95 lines
2.9 KiB
/** |
|
* @fileoverview A rule to ensure consistent quotes used in jsx syntax. |
|
* @author Mathias Schreck <https://github.com/lo1tuma> |
|
*/ |
|
|
|
"use strict"; |
|
|
|
//------------------------------------------------------------------------------ |
|
// Requirements |
|
//------------------------------------------------------------------------------ |
|
|
|
const astUtils = require("./utils/ast-utils"); |
|
|
|
//------------------------------------------------------------------------------ |
|
// Constants |
|
//------------------------------------------------------------------------------ |
|
|
|
const QUOTE_SETTINGS = { |
|
"prefer-double": { |
|
quote: "\"", |
|
description: "singlequote", |
|
convert(str) { |
|
return str.replace(/'/gu, "\""); |
|
} |
|
}, |
|
"prefer-single": { |
|
quote: "'", |
|
description: "doublequote", |
|
convert(str) { |
|
return str.replace(/"/gu, "'"); |
|
} |
|
} |
|
}; |
|
|
|
//------------------------------------------------------------------------------ |
|
// Rule Definition |
|
//------------------------------------------------------------------------------ |
|
|
|
/** @type {import('../shared/types').Rule} */ |
|
module.exports = { |
|
meta: { |
|
type: "layout", |
|
|
|
docs: { |
|
description: "Enforce the consistent use of either double or single quotes in JSX attributes", |
|
recommended: false, |
|
url: "https://eslint.org/docs/rules/jsx-quotes" |
|
}, |
|
|
|
fixable: "whitespace", |
|
|
|
schema: [ |
|
{ |
|
enum: ["prefer-single", "prefer-double"] |
|
} |
|
], |
|
messages: { |
|
unexpected: "Unexpected usage of {{description}}." |
|
} |
|
}, |
|
|
|
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.includes(setting.quote) || astUtils.isSurroundedBy(node.raw, setting.quote); |
|
} |
|
|
|
return { |
|
JSXAttribute(node) { |
|
const attributeValue = node.value; |
|
|
|
if (attributeValue && astUtils.isStringLiteral(attributeValue) && !usesExpectedQuotes(attributeValue)) { |
|
context.report({ |
|
node: attributeValue, |
|
messageId: "unexpected", |
|
data: { |
|
description: setting.description |
|
}, |
|
fix(fixer) { |
|
return fixer.replaceText(attributeValue, setting.convert(attributeValue.raw)); |
|
} |
|
}); |
|
} |
|
} |
|
}; |
|
} |
|
};
|
|
|