forked from gajus/eslint-plugin-jsdoc
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(
require-file-overview
): add rule for every file to have a `fil…
…e` tag; fixes gajus#55
- Loading branch information
Showing
9 changed files
with
428 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
### `require-file-overview` | ||
|
||
Requires that all files have a `@file`, `@fileoverview`, or `@overview` tag. | ||
|
||
#### Fixer | ||
|
||
The fixer for `require-example` will add an empty `@file`. Note that if you | ||
need to report a missing description for `file`, you can add `file` on | ||
the `tags` option with `match-description` (and the `contexts` option | ||
set to "any"). | ||
|
||
||| | ||
|---|---| | ||
|Context|Everywhere| | ||
|Tags|`file`| | ||
|Aliases|`fileoverview`, `overview`| | ||
|
||
<!-- assertions requireFileOverview --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
import iterateJsdoc from '../iterateJsdoc'; | ||
|
||
export default iterateJsdoc(({ | ||
state, | ||
utils, | ||
}) => { | ||
if (state.hasFileOverview) { | ||
return; | ||
} | ||
const targetTagName = utils.getPreferredTagName({tagName: 'file'}); | ||
|
||
// Can we somehow prevent repeating execution of this non-exiting | ||
// iterator instead of repeatedly checking the value above? | ||
state.hasFileOverview = targetTagName && utils.hasTag(targetTagName); | ||
}, { | ||
exit ({state, utils}) { | ||
if (state.hasFileOverview) { | ||
return; | ||
} | ||
const obj = utils.getPreferredTagNameObject({tagName: 'file'}); | ||
if (obj && obj.blocked) { | ||
utils.reportSettings( | ||
`\`settings.jsdoc.tagNamePreference\` cannot block @${obj.tagName} ` + | ||
'for the `require-file-overview` rule', | ||
); | ||
} else { | ||
utils.reportSettings(`Missing @${obj && obj.replacement || obj}`); | ||
} | ||
}, | ||
iterateAllJsdocs: true, | ||
meta: { | ||
fixable: 'code', | ||
type: 'suggestion', | ||
}, | ||
}); |
Oops, something went wrong.