Files
eslint/tests/lib/rules/multiline-comment-style.js
Josh Goldberg ✨andGitHub 36a353c719 chore: formatted files with Prettier via trunk fmt (#19355)
* chore: remove formatting-related lint rules internally

* chore: formatted files with Prettier via trunk fmt

* rm .prettierrc.json

* chore: correct comment directives and formatting

* Apply introduced fmt changes post-merge

* Also disable MD010 and MD030 in preparation for 19355

* Also disable MD013 in preparation for 19355

* Updated tools/update-rule-type-headers.js to print tabs

* Fix introduced issues from the main merge

* Manually format conf/*.json

* Switch conf/*.json files back to two spaces, per prettier config

* chore: empty commit to hopefully unblock GitHub
2025-03-19 11:18:08 -04:00

1452 lines
30 KiB
JavaScript

/**
* @fileoverview enforce a particular style for multiline comments
* @author Teddy Katz
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const rule = require("../../../lib/rules/multiline-comment-style");
const RuleTester = require("../../../lib/rule-tester/rule-tester");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
const ruleTester = new RuleTester();
ruleTester.run("multiline-comment-style", rule, {
valid: [
`
/*
* this is
* a comment
*/
`,
`
/**
* this is
* a JSDoc comment
*/
`,
`
/* eslint semi: [
"error"
] */
`,
`
// this is a single-line comment
`,
`
/* foo */
`,
`
// this is a comment
foo();
// this is another comment
`,
`
/*
* Function overview
* ...
*/
// Step 1: Do the first thing
foo();
`,
`
/*
* Function overview
* ...
*/
/*
* Step 1: Do the first thing.
* The first thing is foo().
*/
foo();
`,
"\t\t/**\n\t\t * this comment\n\t\t * is tab-aligned\n\t\t */",
"/**\r\n * this comment\r\n * uses windows linebreaks\r\n */",
"/**\u2029 * this comment\u2029 * uses paragraph separators\u2029 */",
`
foo(/* this is an
inline comment */);
`,
`
// The following line comment
// contains '*/'.
`,
{
code: `
// The following line comment
// contains '*/'.
`,
options: ["bare-block"],
},
{
code: `
/*
* this is
* a comment
*/
`,
options: ["starred-block"],
},
{
code: `
/**
* this is
* a JSDoc comment
*/
`,
options: ["starred-block"],
},
{
code: `
/* eslint semi: [
"error"
] */
`,
options: ["starred-block"],
},
{
code: `
// this is a single-line comment
`,
options: ["starred-block"],
},
{
code: `
/* foo */
`,
options: ["starred-block"],
},
{
code: `
/*
* foo
*/
`,
options: ["starred-block"],
},
{
code: `
/* foo */
`,
options: ["bare-block"],
},
{
code: `
/*
foo */
`,
options: ["bare-block"],
},
{
code: `
/*
foo
*/
`,
options: ["bare-block"],
},
{
code: `
/*
foo */
`,
options: ["bare-block"],
},
{
code: `
/*
foo
*/
`,
options: ["bare-block"],
},
{
code: `
// this is
// a comment
`,
options: ["separate-lines"],
},
{
code: `
/* this is
a comment */ foo;
`,
options: ["separate-lines"],
},
{
code: `
// a comment
// another comment
`,
options: ["separate-lines"],
},
{
code: `
// a comment
// another comment
`,
options: ["bare-block"],
},
{
code: `
// a comment
// another comment
`,
options: ["starred-block"],
},
{
code: `
/* eslint semi: "error" */
`,
options: ["separate-lines"],
},
{
code: `
/**
* This is
* a JSDoc comment
*/
`,
options: ["separate-lines"],
},
{
code: `
/**
* This is
* a JSDoc comment
*/
`,
options: ["starred-block"],
},
{
code: `
/**
* This is
* a JSDoc comment
*/
`,
options: ["bare-block"],
},
{
code: `
/* This is
a comment */
`,
options: ["bare-block"],
},
{
code: `
/* This is
a comment */
`,
options: ["bare-block"],
},
{
code: `
/* eslint semi: [
"error"
] */
`,
options: ["separate-lines"],
},
{
code: `
/* The value of 5
+ 4 is 9, and the value of 5
* 4 is 20. */
`,
options: ["bare-block"],
},
{
code: `
/*
* foo
* bar
* baz
* qux
*/
`,
options: ["starred-block"],
},
{
code: `
/* foo
* bar
* baz
* qux
*/
`,
options: ["bare-block"],
},
{
code: `
/**
* JSDoc blocks
* are
* ignored
* !
*/
`,
options: ["bare-block"],
},
{
code: `
/**
* JSDoc blocks
* are
* ignored
* !
*/
`,
options: ["starred-block"],
},
{
code: `
/**
* JSDoc blocks
* are
* ignored
* !
*/
`,
options: ["separate-lines"],
},
{
code: `
/*
* // a line comment
*some.code();
*/
`,
options: ["starred-block"],
},
],
invalid: [
{
code: `
// these are
// line comments
`,
output: `
/*
* these are
* line comments
*/
`,
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
//foo
///bar
`,
output: null,
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
// foo
// bar
// baz
// qux
`,
output: `
/*
* foo
* bar
*/
/*
* baz
* qux
*/
`,
errors: [
{ messageId: "expectedBlock", line: 2 },
{ messageId: "expectedBlock", line: 5 },
],
},
{
code: `
// foo
// bar
// baz
// qux
`,
output: `
/*
* foo
* bar
* baz
* qux
*/
`,
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
// foo
//
// baz
// qux
`,
output: `
/*
* foo
*${" "}
* baz
* qux
*/
`,
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
// foo
// bar
// baz
// qux
`,
output: `
/*
* foo
* bar
* baz
* qux
*/
`,
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
/* this block
* is missing a newline at the start
*/
`,
output: `
/*
* this block
* is missing a newline at the start
*/
`,
errors: [{ messageId: "startNewline", line: 2 }],
},
{
code: `
/** this JSDoc comment
* is missing a newline at the start
*/
`,
output: `
/**
* this JSDoc comment
* is missing a newline at the start
*/
`,
errors: [{ messageId: "startNewline", line: 2 }],
},
{
code: `
/*
* this block
* is missing a newline at the end*/
`,
output: `
/*
* this block
* is missing a newline at the end
*/
`,
errors: [{ messageId: "endNewline", line: 4 }],
},
{
code: `
/*
* the following line
is missing a '*' at the start
*/
`,
output: `
/*
* the following line
* is missing a '*' at the start
*/
`,
errors: [{ messageId: "missingStar", line: 4 }],
},
{
code: `
/*
* the following line
is missing a '*' at the start
*/
`,
output: `
/*
* the following line
* is missing a '*' at the start
*/
`,
errors: [{ messageId: "missingStar", line: 4 }],
},
{
code: `
/*
* the following line
is missing a '*' at the start
*/
`,
output: `
/*
* the following line
* is missing a '*' at the start
*/
`,
errors: [{ messageId: "missingStar", line: 4 }],
},
{
code: `
/*
* the following line
* has a '*' with the wrong offset at the start
*/
`,
output: `
/*
* the following line
* has a '*' with the wrong offset at the start
*/
`,
errors: [{ messageId: "alignment", line: 4 }],
},
{
code: `
/*
* the following line
* has a '*' with the wrong offset at the start
*/
`,
output: `
/*
* the following line
* has a '*' with the wrong offset at the start
*/
`,
errors: [{ messageId: "alignment", line: 4 }],
},
{
code: `
/*
* the last line of this comment
* is misaligned
*/
`,
output: `
/*
* the last line of this comment
* is misaligned
*/
`,
errors: [{ messageId: "alignment", line: 5 }],
},
{
code: `
/*
* the following line
*
* is blank
*/
`,
output: `
/*
* the following line
*
* is blank
*/
`,
errors: [{ messageId: "alignment", line: 4 }],
},
{
code: `
/*
* the following line
*
* is blank
*/
`,
output: `
/*
* the following line
*
* is blank
*/
`,
errors: [{ messageId: "alignment", line: 4 }],
},
{
code: `
/*
* the last line of this comment
* is misaligned
*/ foo
`,
output: `
/*
* the last line of this comment
* is misaligned
*/ foo
`,
errors: [{ messageId: "alignment", line: 5 }],
},
{
code: `
/*
* foo
* bar
*/
`,
output: `
// foo
// bar
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/**
* JSDoc
* Comment
*/
`,
output: `
// JSDoc
// Comment
`,
options: ["separate-lines", { checkJSDoc: true }],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/* foo
*bar
baz
qux*/
`,
output: `
// foo
// bar
// baz
// qux
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
// foo
// bar
`,
output: `
/* foo
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
// foo
//
// bar
`,
output: `
/* foo
${" ".repeat(3)}
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
//foo
//bar
`,
output: `
/* foo
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
// foo
// bar
`,
output: `
/* foo
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
// foo
// bar
`,
output: `
/* foo
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
// foo
// bar
// baz
// qux
`,
output: `
/* foo
bar
baz
qux */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
/*
* foo
* bar
*/
`,
output: `
/* foo
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBareBlock", line: 2 }],
},
{
code: `
/*
*foo
*bar
*/
`,
output: `
/* foo
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBareBlock", line: 2 }],
},
{
code: `
/*
* foo
* bar
*/
`,
output: `
/* foo
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBareBlock", line: 2 }],
},
{
code: `
/*
* foo
* bar
*/
`,
output: `
/* foo
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBareBlock", line: 2 }],
},
{
code: `
/*
* foo
* bar
* baz
* qux
*/
`,
output: `
/* foo
bar
baz
qux */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBareBlock", line: 2 }],
},
{
code: `
/*
{
"foo": 1,
"bar": 2
}
*/
`,
output: `
/*
*{
* "foo": 1,
* "bar": 2
*}
*/
`,
errors: [
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
{ messageId: "missingStar", line: 5 },
{ messageId: "missingStar", line: 6 },
{ messageId: "alignment", line: 7 },
],
},
{
code: `
/*
{
\t"foo": 1,
\t"bar": 2
}
*/
`,
output: `
/*
*{
*\t"foo": 1,
*\t"bar": 2
*}
*/
`,
errors: [
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
{ messageId: "missingStar", line: 5 },
{ messageId: "missingStar", line: 6 },
{ messageId: "alignment", line: 7 },
],
},
{
code: `
/*
{
\t "foo": 1,
\t "bar": 2
}
*/
`,
output: `
/*
*{
*\t "foo": 1,
*\t "bar": 2
*}
*/
`,
errors: [
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
{ messageId: "missingStar", line: 5 },
{ messageId: "missingStar", line: 6 },
{ messageId: "alignment", line: 7 },
],
},
{
code: `
/*
{
\t"foo": 1,
\t"bar": 2
}
*/
`,
output: `
/*
*{
*"foo": 1,
*"bar": 2
*}
*/
`,
errors: [
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
{ messageId: "missingStar", line: 5 },
{ messageId: "missingStar", line: 6 },
{ messageId: "alignment", line: 7 },
],
},
{
code: `
\t /*
\t {
\t "foo": 1,
\t "bar": 2
}
*/
`,
output: `
\t /*
\t *{
\t *"foo": 1,
\t *"bar": 2
\t *}
\t */
`,
errors: [
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
{ messageId: "missingStar", line: 5 },
{ messageId: "missingStar", line: 6 },
{ messageId: "alignment", line: 7 },
],
},
{
code: `
//{
// "foo": 1,
// "bar": 2
//}
`,
output: `
/*
* {
* "foo": 1,
* "bar": 2
* }
*/
`,
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
/*
* {
* "foo": 1,
* "bar": 2
* }
*/
`,
output: `
// {
// "foo": 1,
// "bar": 2
// }
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/*
*
* {
* "foo": 1,
* "bar": 2
* }
*
*/
`,
output: `
//${" "}
// {
// "foo": 1,
// "bar": 2
// }
//${" "}
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/*
*
* {
* "foo": 1,
* "bar": 2
* }
*
*/
`,
output: `
/*${" "}
{
"foo": 1,
"bar": 2
}
*/
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBareBlock", line: 2 }],
},
{
code: `
/*
*
*{
* "foo": 1,
* "bar": 2
*}
*
*/
`,
output: `
/*${" "}
{
"foo": 1,
"bar": 2
}
*/
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBareBlock", line: 2 }],
},
{
code: `
/*
*{
* "foo": 1,
* "bar": 2
*}
*/
`,
output: `
// {
// "foo": 1,
// "bar": 2
// }
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/*
* {
* "foo": 1,
* "bar": 2
* }
*/
`,
output: `
// {
// "foo": 1,
// "bar": 2
// }
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/*
*{
* "foo": 1,
* "bar": 2
*}
*/
`,
output: `
// {
// "foo": 1,
// "bar": 2
// }
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/*
* {
* "foo": 1,
* "bar": 2
*}
*/
`,
output: `
// {
// "foo": 1,
// "bar": 2
// }
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/*
{
"foo": 1,
"bar": 2
}
*/
`,
output: `
//${" "}
// {
// "foo": 1,
// "bar": 2
// }
//${" "}
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/* {
"foo": 1,
"bar": 2
} */
`,
output: `
// {
// "foo": 1,
// "bar": 2
// }${" "}
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/*
* foo
*
* bar
*/
`,
output: `
// foo
//${" "}
// bar
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/*
* foo
*${" "}
* bar
*/
`,
output: `
// foo
//${" "}
// bar
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/*
* foo
*
* bar
*/
`,
output: `
/* foo
${" "}
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBareBlock", line: 2 }],
},
{
code: `
/*
* foo
*${" "}
* bar
*/
`,
output: `
/* foo
${" "}
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBareBlock", line: 2 }],
},
{
code: `
// foo
//
// bar
`,
output: `
/*
* foo
*${" "}
* bar
*/
`,
options: ["starred-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
// foo
//${" "}
// bar
`,
output: `
/*
* foo
*${" "}
* bar
*/
`,
options: ["starred-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
// foo
//${" "}
// bar
`,
output: `
/* foo
${" "}
bar */
`,
options: ["bare-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
/* foo
bar */
`,
output: `
// foo
//${" "}
// bar${" "}
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/* foo
${" "}
bar */
`,
output: `
// foo
//${" "}
// bar${" "}
`,
options: ["separate-lines"],
errors: [{ messageId: "expectedLines", line: 2 }],
},
{
code: `
/* foo
bar */
`,
output: `
/*
* foo
*${" "}
* bar${" "}
*/
`,
options: ["starred-block"],
errors: [
{ messageId: "startNewline", line: 2 },
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
{ messageId: "endNewline", line: 4 },
],
},
{
code: `
/* foo
${" "}
bar */
`,
output: `
/*
* foo
*${" "}
* bar${" "}
*/
`,
options: ["starred-block"],
errors: [
{ messageId: "startNewline", line: 2 },
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
{ messageId: "endNewline", line: 4 },
],
},
{
code: `
/*foo
bar */
`,
output: `
/*
*foo
*
*bar${" "}
*/
`,
options: ["starred-block"],
errors: [
{ messageId: "startNewline", line: 2 },
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
{ messageId: "endNewline", line: 4 },
],
},
{
code: `
/*foo
${" "}
bar */
`,
output: `
/*
*foo
*${" "}
*bar${" "}
*/
`,
options: ["starred-block"],
errors: [
{ messageId: "startNewline", line: 2 },
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
{ messageId: "endNewline", line: 4 },
],
},
{
code: `
/*
// a line comment
some.code();
*/
`,
output: `
/*
* // a line comment
*some.code();
*/
`,
options: ["starred-block"],
errors: [
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
],
},
{
code: `
/*
// a line comment
* some.code();
*/
`,
output: `
/*
* // a line comment
* some.code();
*/
`,
options: ["starred-block"],
errors: [{ messageId: "missingStar", line: 3 }],
},
{
code: `
////This comment is in
//\`separate-lines\` format.
`,
output: null,
options: ["starred-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
// // This comment is in
// \`separate-lines\` format.
`,
output: null,
options: ["starred-block"],
errors: [{ messageId: "expectedBlock", line: 2 }],
},
{
code: `
/*
{
\t"foo": 1,
\t//"bar": 2
}
*/
`,
output: `
/*
*{
*\t"foo": 1,
*\t//"bar": 2
*}
*/
`,
options: ["starred-block"],
errors: [
{ messageId: "missingStar", line: 3 },
{ messageId: "missingStar", line: 4 },
{ messageId: "missingStar", line: 5 },
{ messageId: "missingStar", line: 6 },
{ messageId: "alignment", line: 7 },
],
},
],
});