node/tools/eslint-rules/prefer-util-format-errors.js
Jon Moss 85e34b0c73 tools: add docs for prefer-util-format-errors rule
I had a little trouble understanding what the rule was trying to say, so
am documenting what would pass/fail.

PR-URL: https://github.com/nodejs/node/pull/17376
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2017-11-30 16:49:37 -05:00

45 lines
1.4 KiB
JavaScript

'use strict';
const errMsg = 'Please use a printf-like formatted string that util.format' +
' can consume.';
function isArrowFunctionWithTemplateLiteral(node) {
return node.type === 'ArrowFunctionExpression' &&
node.body.type === 'TemplateLiteral';
}
function isDefiningError(node) {
return node.expression &&
node.expression.type === 'CallExpression' &&
node.expression.callee &&
node.expression.callee.name === 'E';
}
module.exports = {
create: function(context) {
return {
ExpressionStatement: function(node) {
if (!isDefiningError(node))
return;
const msg = node.expression.arguments[1];
if (!isArrowFunctionWithTemplateLiteral(msg))
return;
// Checks to see if order of arguments to function is the same as the
// order of them being concatenated in the template string. The idea is
// that if both match, then you can use `util.format`-style args.
// Would pass rule: (a, b) => `${b}${a}`.
// Would fail rule: (a, b) => `${a}${b}`, and needs to be rewritten.
const { expressions } = msg.body;
const hasSequentialParams = msg.params.every((param, index) => {
const expr = expressions[index];
return expr && expr.type === 'Identifier' && param.name === expr.name;
});
if (hasSequentialParams)
context.report(msg, errMsg);
}
};
}
};