Skip to content

Update prefer-message-ids to check for missing or unused messageIds #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update prefer-message-ids to check for missing or unused messageIds #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 33 additions & 5 deletions lib/rules/prefer-message-ids.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,19 @@ module.exports = {
fixable: null,
schema: [],
messages: {
foundMessage: 'Use `messageId` instead of `message`.',
messagesMissing:
'`meta.messages` must contain at least one violation message.',
foundMessage: 'Use `messageId` instead of `message`.',
missingMessage: '`meta.messages` is missing this messageId.',
unusedMessage: 'This messageId was never used.',
},
},

create(context) {
const sourceCode = context.getSourceCode();
const info = utils.getRuleInfo(sourceCode);

const messageIdsUsed = new Set();
let contextIdentifiers;

// ----------------------------------------------------------------------
Expand Down Expand Up @@ -83,6 +86,18 @@ module.exports = {
});
}
},

'Program:exit'() {
for (const messageIdNode of utils
.getMessageIdNodes(info)
.filter((node) => !messageIdsUsed.has(node.key.name))) {
context.report({
node: messageIdNode,
messageId: 'unusedMessage',
});
}
},

CallExpression(node) {
if (
node.callee.type === 'MemberExpression' &&
Expand All @@ -95,15 +110,28 @@ module.exports = {
return;
}

const reportMessagesAndDataArray = utils
.collectReportViolationAndSuggestionData(reportInfo)
.filter((obj) => obj.message);
for (const { message } of reportMessagesAndDataArray) {
const reportMessagesAndDataArray =
utils.collectReportViolationAndSuggestionData(reportInfo);

for (const { message } of reportMessagesAndDataArray.filter(
(obj) => obj.message
)) {
context.report({
node: message.parent,
messageId: 'foundMessage',
});
}

for (const { messageId } of reportMessagesAndDataArray.filter(
(obj) => obj.messageId && obj.messageId.type === 'Literal'
)) {
messageIdsUsed.add(messageId.value);
if (!utils.getMessageById(info, messageId.value))
context.report({
node: messageId,
messageId: 'missingMessage',
});
}
}
},
};
Expand Down
37 changes: 37 additions & 0 deletions lib/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -762,4 +762,41 @@ module.exports = {
return [property];
});
},

getMessageIdNodes(ruleInfo) {
if (!ruleInfo) {
return [];
}
const metaNode = ruleInfo.meta;
const messagesNode =
metaNode &&
metaNode.properties &&
metaNode.properties.find(
(p) => p.type === 'Property' && this.getKeyName(p) === 'messages'
);

return messagesNode && messagesNode.value.type === 'ObjectExpression'
? messagesNode.value.properties
: [];
},

getMessageById(ruleInfo, messageId) {
const metaNode = ruleInfo.meta;
const messagesNode =
metaNode &&
metaNode.properties &&
metaNode.properties.find(
(p) => p.type === 'Property' && this.getKeyName(p) === 'messages'
);

const correspondingMessage =
messagesNode &&
messagesNode.value.properties &&
messagesNode.value.properties.find(
(p) => p.type === 'Property' && this.getKeyName(p) === messageId
);
if (correspondingMessage) {
return correspondingMessage;
}
},
};
30 changes: 30 additions & 0 deletions tests/lib/rules/prefer-message-ids.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ ruleTester.run('prefer-message-ids', rule, {
module.exports = {
meta: { messages: { foo: 'hello world' } },
create(context) {
context.report({ node, messageId: 'foo' });
context.report({ node, message: 'foo' });
}
};
Expand All @@ -142,6 +143,7 @@ ruleTester.run('prefer-message-ids', rule, {
module.exports = {
meta: { messages: { foo: 'hello world' } },
create(context) {
context.report({ node, messageId: 'foo' });
context.report({ node, suggest: [{desc:'foo'}] });
}
};
Expand All @@ -154,6 +156,7 @@ ruleTester.run('prefer-message-ids', rule, {
export default {
meta: { messages: { foo: 'hello world' } },
create(context) {
context.report({ node, messageId: 'foo' });
context.report({ node, message: 'foo' });
}
};
Expand All @@ -168,6 +171,7 @@ ruleTester.run('prefer-message-ids', rule, {
module.exports = {
meta: { messages: { foo: 'hello world' } },
create(context) {
context.report({ node, messageId: 'foo' });
context.report({
node,
message: MESSAGE
Expand All @@ -183,6 +187,7 @@ ruleTester.run('prefer-message-ids', rule, {
module.exports = {
meta: { messages: { foo: 'hello world' } },
create(context) {
context.report({ node, messageId: 'foo' });
context.report({
node,
message: foo + ' is bad.'
Expand Down Expand Up @@ -270,5 +275,30 @@ ruleTester.run('prefer-message-ids', rule, {
{ messageId: 'foundMessage', type: 'Property' },
],
},
{
// messageId missing
code: `
module.exports = {
meta: { messages: { foo: 'hello world' } },
create(context) {
context.report({ node, messageId: 'foo' });
context.report({ node, messageId: 'bar' });
}
};
`,
errors: [{ messageId: 'missingMessage', type: 'Literal' }],
},
{
// messageId unused
code: `
module.exports = {
meta: { messages: { foo: 'hello world', bar: 'hello world 2' } },
create(context) {
context.report({ node, messageId: 'foo' });
}
};
`,
errors: [{ messageId: 'unusedMessage', type: 'Property' }],
},
],
});