eslint-plugin-comment-length
Version:
An ESLint plugin that provides rules that limit the line length of your comments
30 lines (27 loc) • 1.06 kB
JavaScript
import { ESLintUtils } from '@typescript-eslint/utils';
import { reportMessages } from '../../const.message-ids.js';
import { defaultOptions, optionsSchema } from '../../typings.options.js';
import { resolveDocsRoute } from '../../utils/resolve-docs-route.js';
import { limitSingleLineComments } from './root.js';
const createRule = ESLintUtils.RuleCreator(resolveDocsRoute);
const limitSingleLineCommentsRule = createRule({
name: "limit-single-line-comments",
defaultOptions,
meta: {
type: "layout",
fixable: "whitespace",
messages: reportMessages,
docs: {
description: "Reflows single-line comments to ensure that blocks never exceed the configured length"
},
schema: optionsSchema
},
create: (ruleContext, [options]) => {
const sourceCode = ruleContext.sourceCode;
const comments = sourceCode.getAllComments().filter((it) => it.type === "Line");
limitSingleLineComments(ruleContext, options, comments);
return {};
}
});
export { limitSingleLineCommentsRule };
//# sourceMappingURL=rule.js.map