eslint-plugin-comment-length/src/rules/limit-multi-line-comments/tests/_tests.ts

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

import { getCode } from "../../../utils/testing.get-code";

import { limitMultiLineCommentsRule } from "../rule";
import { defaultOptions, Options } from "../../../typings.options";
import { MessageIds } from "../../../const.message-ids";
import { RuleTester } from "@typescript-eslint/rule-tester";

const ruleTester = new RuleTester();

ruleTester.run("limit-multi-line-comments", limitMultiLineCommentsRule, {
  valid: [
    getCode(__dirname, "valid.basic", defaultOptions),
    getCode(__dirname, "valid.jsdoc", defaultOptions),
    getCode(__dirname, "valid.oneline-jsdoc", defaultOptions),
    getCode(__dirname, "valid.oneline-jsdoc", [
      {
        ...defaultOptions[0],
        mode: "compact",
      },
    ] as const),
    getCode(__dirname, "valid.jsdoc-compact", [
      {
        ...defaultOptions[0],
        mode: "compact",
      },
    ] as const),
    getCode(__dirname, "valid.backticks", defaultOptions),
    getCode(__dirname, "valid.semantic", defaultOptions),
    getCode(__dirname, "valid.exactly-80", defaultOptions),
    getCode(__dirname, "valid.comment-within-comment", defaultOptions),
    getCode(__dirname, "option.code-within", [
      {
        ...defaultOptions[0],
        ignoreCommentsWithCode: true,
      },
    ] as const),
    getCode(__dirname, "option.no-urls", defaultOptions),
    getCode(__dirname, "option.compact", [
      {
        ...defaultOptions[0],
        mode: "compact-on-overflow",
      },
    ] as const),
    getCode(__dirname, "option.compact.valid", [
      {
        ...defaultOptions[0],
        mode: "compact",
      },
    ] as const),
    getCode(__dirname, "option.semantic", [
      {
        ...defaultOptions[0],
        semanticComments: ["my-custom-semantic"],
      } as Options,
    ] as const),
  ],
  invalid: [
    getCode(
      __dirname,
      "invalid.basic-overflow",
      defaultOptions,
      MessageIds.EXCEEDS_MAX_LENGTH,
    ),
    getCode(
      __dirname,
      "invalid.indentation",
      defaultOptions,
      MessageIds.EXCEEDS_MAX_LENGTH,
    ),
    getCode(
      __dirname,
      "invalid.single-line",
      defaultOptions,
      MessageIds.EXCEEDS_MAX_LENGTH,
    ),
    getCode(
      __dirname,
      "invalid.multiple-lines",
      defaultOptions,
      MessageIds.EXCEEDS_MAX_LENGTH,
    ),
    getCode(
      __dirname,
      "invalid.malformed",
      defaultOptions,
      MessageIds.EXCEEDS_MAX_LENGTH,
    ),
    getCode(
      __dirname,
      "invalid.final-line",
      defaultOptions,
      MessageIds.EXCEEDS_MAX_LENGTH,
    ),
    getCode(
      __dirname,
      "option.max-length20",
      [
        {
          ...defaultOptions[0],
          maxLength: 20,
        },
      ] as const,
      MessageIds.EXCEEDS_MAX_LENGTH,
    ),
    getCode(
      __dirname,
      "option.code-within",
      [
        {
          ...defaultOptions[0],
          ignoreCommentsWithCode: false,
        },
      ] as const,
      MessageIds.EXCEEDS_MAX_LENGTH,
    ),
    getCode(
      __dirname,
      "option.no-urls",
      [
        {
          ...defaultOptions[0],
          ignoreUrls: false,
        },
      ] as const,
      MessageIds.EXCEEDS_MAX_LENGTH,
    ),
    getCode(
      __dirname,
      "option.compact",
      [
        {
          ...defaultOptions[0],
          mode: "compact",
        },
      ] as const,
      MessageIds.CAN_COMPACT,
    ),
    getCode(
      __dirname,
      "option.logical-wrap",
      [
        {
          ...defaultOptions[0],
          logicalWrap: true,
        },
      ] as const,
      MessageIds.EXCEEDS_MAX_LENGTH,
    ),
  ],
});