Skip to content

Commit

Permalink
docs(no-restricted-syntax): example to limit types on @type; fixes #…
Browse files Browse the repository at this point in the history 
…939
  • Loading branch information
@brettz9
brettz9 committed Jan 29, 2023
1 parent d6e2355 commit 42fd03b
Show file tree
Hide file tree
Showing 2 changed files with 126 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9680,6 +9680,18 @@ const MyComponent = ({ children }) => {
*/
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:not(*:has(JsdocTag[tag=see]))","context":"any","message":"@see required on each block"}]}]
// Message: @see required on each block

/**
* @type {{a: string}}
*/
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag[tag=type][parsedType.type!=JsdocTypeStringValue][parsedType.type!=JsdocTypeNumber][parsedType.type!=JsdocTypeName])","context":"any","message":"@type should be limited to numeric or string literals and names"},{"comment":"JsdocBlock:has(JsdocTag[tag=type][parsedType.type=JsdocTypeName]:not(*[parsedType.value=/^(true|false|null|undefined|boolean|number|string)$/]))","context":"any","message":"@type names should only be recognized primitive types or literals"}]}]
// Message: @type should be limited to numeric or string literals and names

/**
* @type {abc}
*/
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag[tag=type][parsedType.type!=JsdocTypeStringValue][parsedType.type!=JsdocTypeNumber][parsedType.type!=JsdocTypeName])","context":"any","message":"@type should be limited to numeric or string literals and names"},{"comment":"JsdocBlock:has(JsdocTag[tag=type][parsedType.type=JsdocTypeName]:not(*[parsedType.value=/^(true|false|null|undefined|boolean|number|string)$/]))","context":"any","message":"@type names should only be recognized primitive types or literals"}]}]
// Message: @type names should only be recognized primitive types or literals
````

The following patterns are not considered problems:
Expand Down Expand Up @@ -9750,6 +9762,16 @@ function foo(): string;
* @param sth Param text followed by newline
*/
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[descriptionStartLine=0][hasPreterminalTagDescription=1]","context":"any","message":"Requiring descriptive text on 0th line but no preterminal description"}]}]

/**
* @type {123}
*/
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag[tag=type][parsedType.type!=JsdocTypeStringValue][parsedType.type!=JsdocTypeNumber][parsedType.type!=JsdocTypeName])","context":"any","message":"@type should be limited to numeric or string literals and names"},{"comment":"JsdocBlock:has(JsdocTag[tag=type][parsedType.type=JsdocTypeName]:not(*[parsedType.value=/^(true|false|null|undefined|boolean|number|string)$/]))","context":"any","message":"@type names should only be recognized primitive types or literals"}]}]

/**
* @type {boolean}
*/
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag[tag=type][parsedType.type!=JsdocTypeStringValue][parsedType.type!=JsdocTypeNumber][parsedType.type!=JsdocTypeName])","context":"any","message":"@type should be limited to numeric or string literals and names"},{"comment":"JsdocBlock:has(JsdocTag[tag=type][parsedType.type=JsdocTypeName]:not(*[parsedType.value=/^(true|false|null|undefined|boolean|number|string)$/]))","context":"any","message":"@type names should only be recognized primitive types or literals"}]}]
````


Expand Down
104 changes: 104 additions & 0 deletions test/rules/assertions/noRestrictedSyntax.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,64 @@ export default {
},
],
},
{
code: `
/**
* @type {{a: string}}
*/
`,
errors: [
{
line: 2,
message: '@type should be limited to numeric or string literals and names',
},
],
options: [
{
contexts: [
{
comment: 'JsdocBlock:has(JsdocTag[tag=type][parsedType.type!=JsdocTypeStringValue][parsedType.type!=JsdocTypeNumber][parsedType.type!=JsdocTypeName])',
context: 'any',
message: '@type should be limited to numeric or string literals and names',
},
{
comment: 'JsdocBlock:has(JsdocTag[tag=type][parsedType.type=JsdocTypeName]:not(*[parsedType.value=/^(true|false|null|undefined|boolean|number|string)$/]))',
context: 'any',
message: '@type names should only be recognized primitive types or literals',
},
],
},
],
},
{
code: `
/**
* @type {abc}
*/
`,
errors: [
{
line: 2,
message: '@type names should only be recognized primitive types or literals',
},
],
options: [
{
contexts: [
{
comment: 'JsdocBlock:has(JsdocTag[tag=type][parsedType.type!=JsdocTypeStringValue][parsedType.type!=JsdocTypeNumber][parsedType.type!=JsdocTypeName])',
context: 'any',
message: '@type should be limited to numeric or string literals and names',
},
{
comment: 'JsdocBlock:has(JsdocTag[tag=type][parsedType.type=JsdocTypeName]:not(*[parsedType.value=/^(true|false|null|undefined|boolean|number|string)$/]))',
context: 'any',
message: '@type names should only be recognized primitive types or literals',
},
],
},
],
},
],
valid: [
{
Expand Down Expand Up @@ -675,5 +733,51 @@ export default {
},
],
},
{
code: `
/**
* @type {123}
*/
`,
options: [
{
contexts: [
{
comment: 'JsdocBlock:has(JsdocTag[tag=type][parsedType.type!=JsdocTypeStringValue][parsedType.type!=JsdocTypeNumber][parsedType.type!=JsdocTypeName])',
context: 'any',
message: '@type should be limited to numeric or string literals and names',
},
{
comment: 'JsdocBlock:has(JsdocTag[tag=type][parsedType.type=JsdocTypeName]:not(*[parsedType.value=/^(true|false|null|undefined|boolean|number|string)$/]))',
context: 'any',
message: '@type names should only be recognized primitive types or literals',
},
],
},
],
},
{
code: `
/**
* @type {boolean}
*/
`,
options: [
{
contexts: [
{
comment: 'JsdocBlock:has(JsdocTag[tag=type][parsedType.type!=JsdocTypeStringValue][parsedType.type!=JsdocTypeNumber][parsedType.type!=JsdocTypeName])',
context: 'any',
message: '@type should be limited to numeric or string literals and names',
},
{
comment: 'JsdocBlock:has(JsdocTag[tag=type][parsedType.type=JsdocTypeName]:not(*[parsedType.value=/^(true|false|null|undefined|boolean|number|string)$/]))',
context: 'any',
message: '@type names should only be recognized primitive types or literals',
},
],
},
],
},
],
};

0 comments on commit 42fd03b

Please sign in to comment.