Skip to content

Commit 1a13d8e

Browse files
committed
fix(check-tag-names, check-types, no-undefined-types): ensure bad settings are reported as line 1
1 parent 8f8431d commit 1a13d8e

File tree

7 files changed

+19
-6
lines changed

7 files changed

+19
-6
lines changed

src/iterateJsdoc.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,18 @@ const getUtils = (
208208
});
209209
};
210210

211+
utils.reportSettings = (message) => {
212+
context.report({
213+
loc: {
214+
start: {
215+
column: 1,
216+
line: 1
217+
}
218+
},
219+
message
220+
});
221+
};
222+
211223
return utils;
212224
};
213225

src/rules/checkTagNames.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export default iterateJsdoc(({
2828
return undefined;
2929
}
3030
if (typeof preferredTag !== 'object') {
31-
report(
31+
utils.reportSettings(
3232
'Invalid `settings.jsdoc.tagNamePreference`. Values must be falsy, a string, or an object.'
3333
);
3434
}

src/rules/checkTypes.js

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,8 @@ export default iterateJsdoc(({
154154
_.get(preferredSetting, 'message')
155155
]);
156156
} else {
157-
report(
158-
'Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.',
159-
null,
160-
jsdocTag
157+
utils.reportSettings(
158+
'Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.'
161159
);
162160

163161
return;

src/rules/noUndefinedTypes.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export default iterateJsdoc(({
4141
return undefined;
4242
}
4343
if (typeof preferredType !== 'object') {
44-
report(
44+
utils.reportSettings(
4545
'Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.'
4646
);
4747
}

test/rules/assertions/checkTagNames.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,7 @@ export default {
295295
`,
296296
errors: [
297297
{
298+
line: 1,
298299
message: 'Invalid `settings.jsdoc.tagNamePreference`. Values must be falsy, a string, or an object.'
299300
},
300301
{

test/rules/assertions/checkTypes.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ export default {
1111
`,
1212
errors: [
1313
{
14+
line: 1,
1415
message: 'Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.'
1516
}
1617
],

test/rules/assertions/noUndefinedTypes.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ export default {
1111
`,
1212
errors: [
1313
{
14+
line: 1,
1415
message: 'Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.'
1516
},
1617
{

0 commit comments

Comments
 (0)