Skip to content

Commit cd44885

Browse files
committed
testing(require-param): indicate absence of effect on destructuring
1 parent fc4d68e commit cd44885

File tree

2 files changed

+84
-0
lines changed

2 files changed

+84
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6377,6 +6377,27 @@ function quux (foo) {
63776377
}
63786378
// Settings: {"jsdoc":{"tagNamePreference":{"param":false}}}
63796379
// Message: Unexpected tag `@param`
6380+
6381+
/**
6382+
*
6383+
*/
6384+
function quux ({bar, baz}, foo) {
6385+
}
6386+
// Message: Missing JSDoc @param "foo" declaration.
6387+
6388+
/**
6389+
*
6390+
*/
6391+
function quux (foo, {bar, baz}) {
6392+
}
6393+
// Message: Missing JSDoc @param "foo" declaration.
6394+
6395+
/**
6396+
*
6397+
*/
6398+
function quux ([bar, baz], foo) {
6399+
}
6400+
// Message: Missing JSDoc @param "foo" declaration.
63806401
````
63816402

63826403
The following patterns are not considered problems:

test/rules/assertions/requireParam.js

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,69 @@ export default {
409409
},
410410
},
411411
},
412+
{
413+
code: `
414+
/**
415+
*
416+
*/
417+
function quux ({bar, baz}, foo) {
418+
}
419+
`,
420+
errors: [
421+
{
422+
message: 'Missing JSDoc @param "foo" declaration.',
423+
},
424+
],
425+
output: `
426+
/**
427+
* @param foo
428+
*/
429+
function quux ({bar, baz}, foo) {
430+
}
431+
`,
432+
},
433+
{
434+
code: `
435+
/**
436+
*
437+
*/
438+
function quux (foo, {bar, baz}) {
439+
}
440+
`,
441+
errors: [
442+
{
443+
message: 'Missing JSDoc @param "foo" declaration.',
444+
},
445+
],
446+
output: `
447+
/**
448+
* @param foo
449+
*/
450+
function quux (foo, {bar, baz}) {
451+
}
452+
`,
453+
},
454+
{
455+
code: `
456+
/**
457+
*
458+
*/
459+
function quux ([bar, baz], foo) {
460+
}
461+
`,
462+
errors: [
463+
{
464+
message: 'Missing JSDoc @param "foo" declaration.',
465+
},
466+
],
467+
output: `
468+
/**
469+
* @param foo
470+
*/
471+
function quux ([bar, baz], foo) {
472+
}
473+
`,
474+
},
412475
],
413476
valid: [
414477
{

0 commit comments

Comments
 (0)