This rule enforce header comment for JavaScript / TypeScript source code file.
The header comment must be JSDoc style and must include the @author and @license tags.
IMPORTANT
If you are sure that you want to write the header comment before the code itself, you have to insert a line. Otherwise, the comment written immediately before the code itself will be recognized as JSDoc for that code.
@kazupon/enforce-header-comment
Rule Details
This rule enforce header comment for JavaScript / TypeScript source code file.
The header comment must be JSDoc style and must include the
@authorand@licensetags.IMPORTANT
If you are sure that you want to write the header comment before the code itself, you have to insert a line. Otherwise, the comment written immediately before the code itself will be recognized as JSDoc for that code.
Fail
Some examples of incorrect code for this rule:
Pass
Some examples of correct code for this rule:
Options
Nothing.
Related rules
Nothing.
Version
This rule was introduced in
@kazupon/eslint-pluginv0.1.0Implementation