eslint-plugin-comment-length
This plugin provides ESLint rules that limit the line length of your comments. Furthermore, an automatic fix is included such that you can save time manually formatting your comments. As such it is recommended to apply this rule every time a file is saved in order to avoid the hassle of manually formatting comments.
This project aims to ease the process of writing long comments where each line needs to be cropped to a specific line length. This is similar to the max-len ESLint rule. The primary difference is that this plugin can automatically fix violations.
NB: There are several cases wherein the rules will not attempt to automatically format comments. This is to accomodate cases where it is not desired to break a comment into multiple lines. Examples include comments that:
- are not on their own lines.
- include
eslint-[enable|disable]-*,stylelint-[enable|disable]-*,tslint:[enable|disable]. - are wrapped within backticks, as it normally indicate code-snippets within comments. (e.g. ```some-comment```)
- are part of JSDoc-like comments. (i.e. multi-line comment lines that starts with '@')
Specific cases will be expanded upon in the example sections below.
Installation
Yarn:
yarn add --dev eslint-plugin-comment-lengthNPM:
npm i --save-dev eslint-plugin-comment-lengthUsage
Add the following to your .eslint.config.js configuration:
import eslintPluginCommentLength from "eslint-plugin-comment-length";
const eslintConfig = [
eslintPluginCommentLength.configs["flat/recommended"],
// ...
]
export default eslintConfigOR add the following to your .eslintrc configuration:
{
"extends": [
"plugin:comment-length/recommended"
]
}Tagged Template Literals
In case you want to detect and fix overflow of JavaScript comments within tagged template literals, e.g. when using CSS-in-JS, you need to add the following rule to your configuration object:
{
"rules": {
"comment-length/limit-tagged-template-literal-comments": ["warn", {
"tags": ["css"] // will perform comment analysis on all tagged template literals named `css`
}]
}
}See comment-length/limit-tagged-template-literal-comments for additional information.
Configuration
Both rules accept the same set of configuration options, as described by the provided TypeScript type declaration.
Please refer to the individual rules for examples of how to apply these configurations in your ESLint config.
type Options = {
/**
* specifies how the auto-fix wrapping mechanism functions.
*
* - "overflow-only" ensures that only overflowing lines are reflowed to new
* lines,
*
* - whereas "compact" tries to produce as compact blocks as possible,
* potentially merging multiple nearby lines even though no overflow was
* occuring on the lines.
*
* - Finally, "compact-on-overflow" attempts to produce as compact blocks as
* possible, however only when overflow within a block has been detected.
*
* @default overflow-only
*/
mode: "overflow-only" | "compact-on-overflow" | "compact";
/**
* specifies the maxmium length that a comment is allowed to take
*
* @default 80
*/
maxLength: number;
/**
* attempts to wrap at logical pauses in comments based on where punctuation
* is found.
*
* This will often wrap the text sooner than if this was disabled,
* but it potentially makes it easier to read comments.
*
* @default false
*/
logicalWrap: boolean;
/**
* in case you are using tabs to indent your code, then this plugin needs to
* know the configured tab size, in order to properly determine when a comment
* exceeds the configured max length.
*
* If you are using VSCode, then this option should match the
* `editor.tabSize` option.
*
* @default 2
*/
tabSize: number;
/**
* if set to true, then overflow lines including URLs will be ignored
*
* @default true
*/
ignoreUrls: boolean;
/**
* attempts to avoid reflowing comments that contains code as this may break
* the semantic meaning of the code.
*
* NB: This option causes ESLint to be run on comment content in an attempt
* to see if the code inside is parsable.
*
* @default true
*/
ignoreCommentsWithCode: boolean;
};Rules
comment-length/limit-single-line-comments
Locates single-line commments, i.e. // comment, and ensures that each line never exceeds the configured length.
If a line violates this rule, the auto-fixer will attempt to combine logical groups of single-line comments and reformat those to ensure that each line is below the configured max length.
// this is one logical comment block. It will be automatically split into multiple lines if fixed. Especially if the content is very very very very very very long.
// This is the second line of the block.
// This is considered as a new block since the line above does not overflow.
// This line is also considered as a singular block.Which will be transformed into:
// this is one logical comment block. It will be automatically split into
// multiple lines if fixed. Especially if the content is very very very very
// very very long. This is the second line of the block.
// This is considered as a new block since the line above does not overflow.
// This line is also considered as a singular block.Options
{
"comment-length/limit-single-line-comments": [
"warn",
{
"mode": "overflow-only" | "compact-on-overflow" | "compact",
"maxLength": 80,
"logicalWrap": true,
"ignoreUrls": true,
"ignoreCommentsWithCode": true,
"tabSize": 2
}
]
}Examples
Basic
// this is one logical comment block. It will be automatically split into multiple lines if fixed. Especially if the content is very very very very very very long.Will be fixed into:
// this is one logical comment block. It will be automatically split into
// multiple lines if fixed. Especially if the content is very very very very
// very very long.Indentation
When fixing this comment-block, then the leading whitespace on the following line will currently be discarded. This may change in the future.
As an example:
// When fixing this comment-block, then the leading whitespace on the following line will be discarded.
// white-space will be discarded when fixing.Will be fixed into:
// When fixing this comment-block, then the leading whitespace on the following
// line will be discarded. white-space will be discarded when fixing.Must not be a comment with special semantics
The comments below will NOT be automatically fixable (as this will break functionality).
// eslint-disable-next-line comment-length/limit-single-line-comments, comment-length/limit-multi-line-comments
// styleline-disable-next-line some-css-plugin/some-css-rule, ...
// tslint:disable ...Must be on own line
The comment below will NOT be automatically fixable (as it is not on its own line). This has been done as there is rarely much space available when a comment shares a line with actual code.
const myVariable = Math.max(0, Math.min(1, window.someValue)); // clamps the external value between 0 and 1.Includes a comment within the comment
The comment below will NOT be automatically fixable as it includes a comment within itself.
The rationale behind this decision is that developers at times will have to out-comment snippets of code when debugging. When this happens comments may also be commented out (perhaps accidentally). In this case we would like to preserve the structure of the original comment, such that when it is commented back in it follows the original layout.
/** Here is my comment which // includes a very very long comment within itself. */Includes a code snippet
The comment below will NOT be automatically fixable as it includes a comment within itself.
The rationaly is essentially the same as above. In particular we wish to avoid breaking lines when code is out-commented during debugging.
// const myVariableWhichDefinitelyOverflows = window.getComputedStyle(document.body).accentColor;comment-length/limit-multi-line-comments
Locates multi-line comments, i.e. /* comment */ and ensures that each line in the comment never exceeds the configured length.
If a line violates this rule, the auto-fixer will attempt to combine logical groups of lines inside the comment and reformat those to ensure that each line is below the configured max length.
As an example the comment below, which combines several comments from the ESLint source code, is perfectly valid:
/*
* NOTE: The CLI object should *not* call process.exit() directly. It should
* only return exit codes. This allows other programs to use the CLI object and
* still control when the program exits.
*
* @property {("directive" | "problem" | "suggestion" | "layout")[]} [fixType] Specify the types of fixes to apply (directive, problem, suggestion, layout)
*
* @example
* ```tsx
* const someValueAfterProcessing = process(value, (node) => ({
* ...node,
* newProp: 2, // @TODO, insert the correct value of newProp once available here. Do note that I overflow, but do not trigger an automatic fix.
* }));
* ```
*/But the following would be considered as a violation:
/**
* NOTE: The CLI object should *not* call process.exit() directly. It should only return exit codes. This allows other programs to use the CLI object and still control when the program exits.
*/Which will be transformed into the snippet below when applying the automatic fix:
/*
* NOTE: The CLI object should *not* call process.exit() directly. It should
* only return exit codes. This allows other programs to use the CLI object and
* still control when the program exits.
*/Options
{
"comment-length/limit-multi-line-comments": [
"warn",
{
"mode": "overflow-only" | "compact-on-overflow" | "compact",
"maxLength": 80,
"logicalWrap": true,
"ignoreUrls": true,
"ignoreCommentsWithCode": true,
"tabSize": 2
}
]
}Examples
Basic
/**
* This is a single block.
* This is another block which violates the maximum length. This block will as such be automatically fixed.
* This is part of the previous block.
*
* This is a third block.
*//**
* This is a single block.
* This is another block which violates the maximum length. This block will as
* such be automatically fixed. This is part of the previous block.
*
* This is a third block.
*/JSDoc
In order to preserve semantics of JSDoc-like comments the automatic fix will not apply to lines that seems to be part of a JSDoc comment (i.e. starting with the character "@").
At times, when JSDoc declarations (e.g. @example) span multiple lines, then it may be desired to combine with the backtick escape-hatch described below.
/**
* @example Here is my JSDoc-comment which will not be automatically fixable in order to avoid altering semantics.
*/Backticks
Backticks inside a multi-line comment acts as an escape hatch for the automatic fix. In other words, all content within backticks will never be considered as a block that can be automatically fixed.
/**
* @example
* ```ts
* Everything within backticks will not be automatically formatted. They essientially acts as an escape-hatch for the automatic fix.
* ```
*/Indentation
When capturing logical blocks within a multi-line comment the rule will consider indentation levels. If two lines do not share the same indentation level, then they will never be considered as part of the same block.
This is illustrated with the following example:
/**
* This is a single block which overflows the default maximum line-length (80 characters).
* Since this line has a different indentation level it will be considered as a separate block (which also overflows!)
*/Will be fixed into:
/**
* This is a single block which overflows the default maximum line-length (80
* characters).
* Since this line has a different indentation level it will be considered
* as a separate block (which also overflows!)
*/Single-line
/** In case a multi-line comment is on a single line and it violates the configured max-length, then it will be split into multiple lines automatically. */Will be fixed into:
/**
* In case a multi-line comment is on a single line and it violates the
* configured max-length, then it will be split into multiple lines
* automatically.
*/Must not be a comment with special semantics
The comments below will NOT be automatically fixable (as this will break functionality).
/** eslint-disable comment-length/limit-single-line-comments, comment-length/limit-multi-line-comments */Includes a comment within the comment
The comment below will NOT be automatically fixable as it includes a comment within itself.
The rationale behind this decision is that developers at times will have to out-comment snippets of code when debugging. When this happens comments may also be commented out (perhaps accidentally). In this case we would like to preserve the structure of the original comment, such that when it is commented back in it follows the original layout.
/** Here is my comment which // includes a very very long comment within itself. */Includes a code snippet
The comment below will NOT be automatically fixable as it includes a comment within itself.
The rationaly is essentially the same as above. In particular we wish to avoid breaking lines when code is out-commented during debugging.
/**
* const myVariableWhichDefinitelyOverflows = window.getComputedStyle(document.body).accentColor;
*/comment-length/limit-tagged-template-literal-comments
Locates javascript comments, i.e. /* comment */ or // comment within tagged template literals and ensures that each line in the comment never exceeds the configured length.
If a line violates this rule, the auto-fixer will attempt to combine logical groups of lines inside the comment and reformat those to ensure that each line is below the configured max length.
NB This rule is a basic wrapper on top of the rules comment-length/limit-single-line-comments and comment-length/limit-multi-line-comments that parses comments within tagged template literals and then forwards these comments to the other rules.
This rule is especially intended for CSS-in-JS wherein comments may be used. As an example consider the snippet below:
const myCss = css`
/** we have decided to use this color due to its unique qualities etc. Unfortunately this line is far too long, and tedious to fix manually. */
color: green;
`;Normally the comment within the tagged template literal will not be automatically fixed. However, when this rule is included, then the snippet above will be transformed into the following:
const myCss = css`
/**
* we have decided to use this color due to its unique qualities etc.
* Unfortunately this line is far too long, and tedious to fix manually.
*/
color: green;
`;Options
{
"comment-length/limit-multi-line-comments": [
"warn",
{
"tags": ["css"], // include names of all tags that comment detection should be performed on.
// the configurations below will be propagated to the other rules that this rule extends.
"mode": "overflow-only" | "compact-on-overflow" | "compact",
"maxLength": 80,
"logicalWrap": true,
"ignoreUrls": true,
"ignoreCommentsWithCode": true,
"tabSize": 2
}
]
}