Skip to content

Commit 57e86aa

Browse files
authored
Merge pull request #234 from brettz9/hyphen-param-pref
`require-hyphen-before-param-description` and `tagNamePreference` setting
2 parents a52bb86 + a6b5173 commit 57e86aa

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/rules/requireHyphenBeforeParamDescription.js

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,29 @@ export default iterateJsdoc(({
1010
}) => {
1111
let always;
1212

13+
const targetTagName = utils.getPreferredTagName('param');
14+
1315
if (_.has(context.options, 0)) {
1416
always = context.options[0] === 'always';
1517
} else {
1618
always = true;
1719
}
1820

19-
utils.forEachTag('param', (jsdocTag) => {
21+
utils.forEachTag(targetTagName, (jsdocTag) => {
2022
if (!jsdocTag.description) {
2123
return;
2224
}
2325

2426
if (always) {
2527
if (!jsdocTag.description.startsWith('-')) {
26-
report('There must be a hyphen before @param description.', (fixer) => {
28+
report('There must be a hyphen before @' + targetTagName + ' description.', (fixer) => {
2729
const replacement = sourceCode.getText(jsdocNode).replace(jsdocTag.description, '- ' + jsdocTag.description);
2830

2931
return fixer.replaceText(jsdocNode, replacement);
3032
}, jsdocTag);
3133
}
3234
} else if (jsdocTag.description.startsWith('-')) {
33-
report('There must be no hyphen before @param description.', (fixer) => {
35+
report('There must be no hyphen before @' + targetTagName + ' description.', (fixer) => {
3436
const [unwantedPart] = /-\s*/.exec(jsdocTag.description);
3537

3638
const replacement = sourceCode

0 commit comments

Comments
 (0)