eslint-plugin-comment-length/lib/mjs/rules/limit-multi-line-comments/rule.js

An ESLint plugin that provides rules that limit the line length of your comments

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 { limitMultiLineComments } from './root.js';

const createRule = ESLintUtils.RuleCreator(resolveDocsRoute);
const limitMultiLineCommentsRule = createRule({
  name: "limit-multi-line-comments",
  defaultOptions,
  meta: {
    type: "layout",
    fixable: "whitespace",
    messages: reportMessages,
    docs: {
      description: "Reflows multi-line comments to ensure that blocks never exceed the configured length"
    },
    schema: optionsSchema
  },
  create: (ruleContext, [options]) => {
    const sourceCode = ruleContext.sourceCode;
    const comments = sourceCode.getAllComments();
    limitMultiLineComments(ruleContext, options, comments);
    return {};
  }
});

export { limitMultiLineCommentsRule };
//# sourceMappingURL=rule.js.map