Skip to content

Improve detection of static description strings and ignore non-static descriptions in require-meta-docs-description rule #113

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

Merged
merged 1 commit into from
May 9, 2021
Merged

Improve detection of static description strings and ignore non-static descriptions in require-meta-docs-description rule #113

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
26 changes: 13 additions & 13 deletions lib/rules/require-meta-docs-description.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
'use strict';

const { getStaticValue } = require('eslint-utils');
const utils = require('../utils');

// ------------------------------------------------------------------------------
Expand All @@ -8,16 +9,6 @@ const utils = require('../utils');

const DEFAULT_PATTERN = new RegExp('^(enforce|require|disallow)');

/**
* Whether or not the node is a string literal
*
* @param {object} node
* @returns {boolean} whether or not the node is a string literal
*/
function isStringLiteral (node) {
return node.type === 'Literal' && typeof node.value === 'string';
}

module.exports = {
meta: {
docs: {
Expand Down Expand Up @@ -70,11 +61,20 @@ module.exports = {

if (!descriptionNode) {
context.report({ node: docsNode ? docsNode : metaNode, messageId: 'missing' });
} else if (!isStringLiteral(descriptionNode.value) || descriptionNode.value.value === '') {
return;
}

const staticValue = getStaticValue(descriptionNode.value, context.getScope());
if (!staticValue) {
// Ignore non-static values since we can't determine what they look like.
return;
}

if (typeof staticValue.value !== 'string' || staticValue.value === '') {
context.report({ node: descriptionNode.value, messageId: 'wrongType' });
} else if (descriptionNode.value.value !== descriptionNode.value.value.trim()) {
} else if (staticValue.value !== staticValue.value.trim()) {
context.report({ node: descriptionNode.value, messageId: 'extraWhitespace' });
} else if (!pattern.test(descriptionNode.value.value)) {
} else if (!pattern.test(staticValue.value)) {
context.report({
node: descriptionNode.value,
message: '`meta.docs.description` must match the regexp {{pattern}}.',
Expand Down
60 changes: 55 additions & 5 deletions tests/lib/rules/require-meta-docs-description.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,44 @@ ruleTester.run('require-meta-docs-description', rule, {
create(context) {}
};
`,
`
module.exports = {
meta: { docs: { description: generateRestOfDescription() } },
create(context) {}
};
`,
`
module.exports = {
meta: { docs: { description: \`enforce with template literal\` } },
create(context) {}
};
`,
`
module.exports = {
meta: { docs: { description: "enforce" + " " + "something" } },
create(context) {}
};
`,
`
module.exports = {
meta: { docs: { description: "enforce " + generateSomething() } },
create(context) {}
};
`,
`
const DESCRIPTION = 'require foo';
module.exports = {
meta: { docs: { description: DESCRIPTION } },
create(context) {}
};
`,
`
const DESCRIPTION = generateDescription();
module.exports = {
meta: { docs: { description: DESCRIPTION } },
create(context) {}
};
`,
{
code:
`
Expand Down Expand Up @@ -88,17 +126,18 @@ ruleTester.run('require-meta-docs-description', rule, {
{
code: `
module.exports = {
meta: { docs: { description: \`enforce with template literal\` } },
meta: { docs: { description: '' } },
create(context) {}
};
`,
output: null,
errors: [{ messageId: 'wrongType', type: 'TemplateLiteral' }],
errors: [{ messageId: 'wrongType', type: 'Literal' }],
},
{
code: `
const DESCRIPTION = true;
module.exports = {
meta: { docs: { description: SOME_DESCRIPTION } },
meta: { docs: { description: DESCRIPTION } },
create(context) {}
};
`,
Expand All @@ -107,13 +146,14 @@ ruleTester.run('require-meta-docs-description', rule, {
},
{
code: `
const DESCRIPTION = 123;
module.exports = {
meta: { docs: { description: '' } },
meta: { docs: { description: DESCRIPTION } },
create(context) {}
};
`,
output: null,
errors: [{ messageId: 'wrongType', type: 'Literal' }],
errors: [{ messageId: 'wrongType', type: 'Identifier' }],
},
{
code: `
Expand All @@ -135,6 +175,16 @@ ruleTester.run('require-meta-docs-description', rule, {
output: null,
errors: [{ message: '`meta.docs.description` must match the regexp /^(enforce|require|disallow)/.', type: 'Literal' }],
},
{
code: `
module.exports = {
meta: { docs: { description: 'foo' + ' ' + 'bar' } },
create(context) {}
};
`,
output: null,
errors: [{ message: '`meta.docs.description` must match the regexp /^(enforce|require|disallow)/.', type: 'BinaryExpression' }],
},
{
code: `
module.exports = {
Expand Down