mirror of
https://github.com/hanzoai/eslint.git
synced 2026-10-30 19:38:10 +00:00
* feat!: report `eslint-env` comments as errors * add migration instructions
1071 lines
23 KiB
JavaScript
1071 lines
23 KiB
JavaScript
/**
|
||
* @fileoverview enforce or disallow capitalization of the first letter of a comment
|
||
* @author Kevin Partington
|
||
*/
|
||
"use strict";
|
||
|
||
//------------------------------------------------------------------------------
|
||
// Requirements
|
||
//------------------------------------------------------------------------------
|
||
|
||
const rule = require("../../../lib/rules/capitalized-comments"),
|
||
RuleTester = require("../../../lib/rule-tester/rule-tester");
|
||
|
||
//------------------------------------------------------------------------------
|
||
// Tests
|
||
//------------------------------------------------------------------------------
|
||
|
||
const ruleTester = new RuleTester();
|
||
|
||
ruleTester.run("capitalized-comments", rule, {
|
||
valid: [
|
||
// No options: capitalization required
|
||
"//Uppercase",
|
||
"// Uppercase",
|
||
"/*Uppercase */",
|
||
"/* Uppercase */",
|
||
"/*\nUppercase */",
|
||
"/** Uppercase */",
|
||
"/**\nUppercase */",
|
||
"//\xDCber",
|
||
"//\u03A0",
|
||
"/* Uppercase\nsecond line need not be uppercase */",
|
||
|
||
// No options: Skips comments that only contain whitespace
|
||
"// ",
|
||
"//\t",
|
||
"/* */",
|
||
"/*\t*/",
|
||
"/*\n*/",
|
||
"/*\r*/",
|
||
"/*\r\n*/",
|
||
"/*\u2028*/",
|
||
"/*\u2029*/",
|
||
|
||
// No options: non-alphabetical is okay
|
||
"//123",
|
||
"// 123",
|
||
"/*123*/",
|
||
"/* 123 */",
|
||
"/**123 */",
|
||
"/** 123 */",
|
||
"/**\n123 */",
|
||
"/*\n123 */",
|
||
"/*123\nsecond line need not be uppercase */",
|
||
"/**\n * @fileoverview This is a file */",
|
||
|
||
// No options: eslint/istanbul/jshint/jscs/globals?/exported are okay
|
||
"// jscs: enable",
|
||
"// jscs:disable",
|
||
"// eslint-disable-line",
|
||
"// eslint-disable-next-line",
|
||
"/* eslint semi:off */",
|
||
"/* eslint-enable */",
|
||
"/* istanbul ignore next */",
|
||
"/* jshint asi:true */",
|
||
"/* jscs: enable */",
|
||
"/* global var1, var2 */",
|
||
"/* global var1:true, var2 */",
|
||
"/* globals var1, var2 */",
|
||
"/* globals var1:true, var2 */",
|
||
"/* exported myVar */",
|
||
|
||
// Ignores shebangs
|
||
"#!foo",
|
||
{ code: "#!foo", options: ["always"] },
|
||
{ code: "#!Foo", options: ["never"] },
|
||
"#!/usr/bin/env node",
|
||
{ code: "#!/usr/bin/env node", options: ["always"] },
|
||
{ code: "#!/usr/bin/env node", options: ["never"] },
|
||
|
||
// Using "always" string option
|
||
{ code: "//Uppercase", options: ["always"] },
|
||
{ code: "// Uppercase", options: ["always"] },
|
||
{ code: "/*Uppercase */", options: ["always"] },
|
||
{ code: "/* Uppercase */", options: ["always"] },
|
||
{ code: "/*\nUppercase */", options: ["always"] },
|
||
{ code: "/** Uppercase */", options: ["always"] },
|
||
{ code: "/**\nUppercase */", options: ["always"] },
|
||
{ code: "//\xDCber", options: ["always"] },
|
||
{ code: "//\u03A0", options: ["always"] },
|
||
{
|
||
code: "/* Uppercase\nsecond line need not be uppercase */",
|
||
options: ["always"],
|
||
},
|
||
|
||
// Using "always" string option: non-alphabetical is okay
|
||
{ code: "//123", options: ["always"] },
|
||
{ code: "// 123", options: ["always"] },
|
||
{ code: "/*123*/", options: ["always"] },
|
||
{ code: "/**123*/", options: ["always"] },
|
||
{ code: "/* 123 */", options: ["always"] },
|
||
{ code: "/** 123*/", options: ["always"] },
|
||
{ code: "/**\n123*/", options: ["always"] },
|
||
{ code: "/*\n123 */", options: ["always"] },
|
||
{
|
||
code: "/*123\nsecond line need not be uppercase */",
|
||
options: ["always"],
|
||
},
|
||
{
|
||
code: "/**\n @todo: foobar\n */",
|
||
options: ["always"],
|
||
},
|
||
{
|
||
code: "/**\n * @fileoverview This is a file */",
|
||
options: ["always"],
|
||
},
|
||
|
||
// Using "always" string option: eslint/istanbul/jshint/jscs/globals?/exported are okay
|
||
{ code: "// jscs: enable", options: ["always"] },
|
||
{ code: "// jscs:disable", options: ["always"] },
|
||
{ code: "// eslint-disable-line", options: ["always"] },
|
||
{ code: "// eslint-disable-next-line", options: ["always"] },
|
||
{ code: "/* eslint semi:off */", options: ["always"] },
|
||
{ code: "/* eslint-enable */", options: ["always"] },
|
||
{ code: "/* istanbul ignore next */", options: ["always"] },
|
||
{ code: "/* jshint asi:true */", options: ["always"] },
|
||
{ code: "/* jscs: enable */", options: ["always"] },
|
||
{ code: "/* global var1, var2 */", options: ["always"] },
|
||
{ code: "/* global var1:true, var2 */", options: ["always"] },
|
||
{ code: "/* globals var1, var2 */", options: ["always"] },
|
||
{ code: "/* globals var1:true, var2 */", options: ["always"] },
|
||
{ code: "/* exported myVar */", options: ["always"] },
|
||
|
||
// Using "never" string option
|
||
{ code: "//lowercase", options: ["never"] },
|
||
{ code: "// lowercase", options: ["never"] },
|
||
{ code: "/*lowercase */", options: ["never"] },
|
||
{ code: "/* lowercase */", options: ["never"] },
|
||
{ code: "/*\nlowercase */", options: ["never"] },
|
||
{ code: "//\xFCber", options: ["never"] },
|
||
{ code: "//\u03C0", options: ["never"] },
|
||
{
|
||
code: "/* lowercase\nSecond line need not be lowercase */",
|
||
options: ["never"],
|
||
},
|
||
|
||
// Using "never" string option: non-alphabetical is okay
|
||
{ code: "//123", options: ["never"] },
|
||
{ code: "// 123", options: ["never"] },
|
||
{ code: "/*123*/", options: ["never"] },
|
||
{ code: "/* 123 */", options: ["never"] },
|
||
{ code: "/*\n123 */", options: ["never"] },
|
||
{
|
||
code: "/*123\nsecond line need not be uppercase */",
|
||
options: ["never"],
|
||
},
|
||
{
|
||
code: "/**\n @TODO: foobar\n */",
|
||
options: ["never"],
|
||
},
|
||
{
|
||
code: "/**\n * @Fileoverview This is a file */",
|
||
options: ["never"],
|
||
},
|
||
|
||
// If first word in comment matches ignorePattern, don't warn
|
||
{
|
||
code: "// matching",
|
||
options: ["always", { ignorePattern: "match" }],
|
||
},
|
||
{
|
||
code: "// Matching",
|
||
options: ["never", { ignorePattern: "Match" }],
|
||
},
|
||
{
|
||
code: "// bar",
|
||
options: ["always", { ignorePattern: "foo|bar" }],
|
||
},
|
||
{
|
||
code: "// Bar",
|
||
options: ["never", { ignorePattern: "Foo|Bar" }],
|
||
},
|
||
|
||
// Inline comments are not warned if ignoreInlineComments: true
|
||
{
|
||
code: "foo(/* ignored */ a);",
|
||
options: ["always", { ignoreInlineComments: true }],
|
||
},
|
||
{
|
||
code: "foo(/* Ignored */ a);",
|
||
options: ["never", { ignoreInlineComments: true }],
|
||
},
|
||
|
||
// Inline comments can span multiple lines
|
||
{
|
||
code: "foo(/*\nignored */ a);",
|
||
options: ["always", { ignoreInlineComments: true }],
|
||
},
|
||
{
|
||
code: "foo(/*\nIgnored */ a);",
|
||
options: ["never", { ignoreInlineComments: true }],
|
||
},
|
||
|
||
// Tolerating consecutive comments
|
||
{
|
||
code: [
|
||
"// This comment is valid since it is capitalized,",
|
||
"// and this one is valid since it follows a valid one,",
|
||
"// and same with this one.",
|
||
].join("\n"),
|
||
options: ["always", { ignoreConsecutiveComments: true }],
|
||
},
|
||
{
|
||
code: [
|
||
"/* This comment is valid since it is capitalized, */",
|
||
"/* and this one is valid since it follows a valid one, */",
|
||
"/* and same with this one. */",
|
||
].join("\n"),
|
||
options: ["always", { ignoreConsecutiveComments: true }],
|
||
},
|
||
{
|
||
code: [
|
||
"/*",
|
||
" * This comment is valid since it is capitalized,",
|
||
" */",
|
||
"/* and this one is valid since it follows a valid one, */",
|
||
"/*",
|
||
" * and same with this one.",
|
||
" */",
|
||
].join("\n"),
|
||
options: ["always", { ignoreConsecutiveComments: true }],
|
||
},
|
||
{
|
||
code: [
|
||
"// This comment is valid since it is capitalized,",
|
||
"// and this one is valid since it follows a valid one,",
|
||
"foo();",
|
||
"// This comment now has to be capitalized.",
|
||
].join("\n"),
|
||
options: ["always", { ignoreConsecutiveComments: true }],
|
||
},
|
||
|
||
// Comments which start with URLs should always be valid
|
||
{
|
||
code: "// https://github.com",
|
||
options: ["always"],
|
||
},
|
||
{
|
||
code: "// HTTPS://GITHUB.COM",
|
||
options: ["never"],
|
||
},
|
||
|
||
// Using different options for line/block comments
|
||
{
|
||
code: [
|
||
"// Valid capitalized line comment",
|
||
"/* Valid capitalized block comment */",
|
||
"// lineCommentIgnorePattern",
|
||
"/* blockCommentIgnorePattern */",
|
||
].join("\n"),
|
||
options: [
|
||
"always",
|
||
{
|
||
line: {
|
||
ignorePattern: "lineCommentIgnorePattern",
|
||
},
|
||
block: {
|
||
ignorePattern: "blockCommentIgnorePattern",
|
||
},
|
||
},
|
||
],
|
||
},
|
||
],
|
||
|
||
invalid: [
|
||
// No options: capitalization required
|
||
{
|
||
code: "//lowercase",
|
||
output: "//Lowercase",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "// lowercase",
|
||
output: "// Lowercase",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*lowercase */",
|
||
output: "/*Lowercase */",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/* lowercase */",
|
||
output: "/* Lowercase */",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/** lowercase */",
|
||
output: "/** Lowercase */",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\nlowercase */",
|
||
output: "/*\nLowercase */",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/**\nlowercase */",
|
||
output: "/**\nLowercase */",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "//über",
|
||
output: "//Über",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "//π",
|
||
output: "//Π",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/* lowercase\nSecond line need not be lowercase */",
|
||
output: "/* Lowercase\nSecond line need not be lowercase */",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "// ꮳꮃꭹ",
|
||
output: "// Ꮳꮃꭹ",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/* 𐳡𐳡𐳡 */", // right-to-left-text
|
||
output: "/* 𐲡𐳡𐳡 */",
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
|
||
// Using "always" string option
|
||
{
|
||
code: "//lowercase",
|
||
output: "//Lowercase",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "// lowercase",
|
||
output: "// Lowercase",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*lowercase */",
|
||
output: "/*Lowercase */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/* lowercase */",
|
||
output: "/* Lowercase */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/** lowercase */",
|
||
output: "/** Lowercase */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/**\nlowercase */",
|
||
output: "/**\nLowercase */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "//über",
|
||
output: "//Über",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "//π",
|
||
output: "//Π",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/* lowercase\nSecond line need not be lowercase */",
|
||
output: "/* Lowercase\nSecond line need not be lowercase */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
|
||
// Using "never" string option
|
||
{
|
||
code: "//Uppercase",
|
||
output: "//uppercase",
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "// Uppercase",
|
||
output: "// uppercase",
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*Uppercase */",
|
||
output: "/*uppercase */",
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/* Uppercase */",
|
||
output: "/* uppercase */",
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\nUppercase */",
|
||
output: "/*\nuppercase */",
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "//Über",
|
||
output: "//über",
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "//Π",
|
||
output: "//π",
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/* Uppercase\nsecond line need not be uppercase */",
|
||
output: "/* uppercase\nsecond line need not be uppercase */",
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "// Გ", // Georgian Mtavruli Capital Letter Gan (U+1C92)
|
||
output: "// გ", // Georgian Letter Gan (U+10D2)
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "// 𑢢", // Warang Citi Capital Letter Wi (U+118A2)
|
||
output: "// 𑣂", // Warang Citi Small Letter Wi (U+118C2)
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
|
||
// Default ignore words should be warned if there are non-whitespace characters in the way
|
||
{
|
||
code: "//* jscs: enable",
|
||
output: "//* Jscs: enable",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "//* jscs:disable",
|
||
output: "//* Jscs:disable",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "//* eslint-disable-line",
|
||
output: "//* Eslint-disable-line",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "//* eslint-disable-next-line",
|
||
output: "//* Eslint-disable-next-line",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\n * eslint semi:off */",
|
||
output: "/*\n * Eslint semi:off */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\n * eslint-env node */",
|
||
output: "/*\n * Eslint-env node */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\n * istanbul ignore next */",
|
||
output: "/*\n * Istanbul ignore next */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\n * jshint asi:true */",
|
||
output: "/*\n * Jshint asi:true */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\n * jscs: enable */",
|
||
output: "/*\n * Jscs: enable */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\n * global var1, var2 */",
|
||
output: "/*\n * Global var1, var2 */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\n * global var1:true, var2 */",
|
||
output: "/*\n * Global var1:true, var2 */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\n * globals var1, var2 */",
|
||
output: "/*\n * Globals var1, var2 */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\n * globals var1:true, var2 */",
|
||
output: "/*\n * Globals var1:true, var2 */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "/*\n * exported myVar */",
|
||
output: "/*\n * Exported myVar */",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
|
||
// Inline comments should be warned if ignoreInlineComments is omitted or false
|
||
{
|
||
code: "foo(/* invalid */a);",
|
||
output: "foo(/* Invalid */a);",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 5,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "foo(/* invalid */a);",
|
||
output: "foo(/* Invalid */a);",
|
||
options: ["always", { ignoreInlineComments: false }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 5,
|
||
},
|
||
],
|
||
},
|
||
|
||
// ignoreInlineComments should only allow inline comments to pass
|
||
{
|
||
code: "foo(a, // not an inline comment\nb);",
|
||
output: "foo(a, // Not an inline comment\nb);",
|
||
options: ["always", { ignoreInlineComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 8,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "foo(a, /* not an inline comment */\nb);",
|
||
output: "foo(a, /* Not an inline comment */\nb);",
|
||
options: ["always", { ignoreInlineComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 8,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "foo(a,\n/* not an inline comment */b);",
|
||
output: "foo(a,\n/* Not an inline comment */b);",
|
||
options: ["always", { ignoreInlineComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 2,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "foo(a,\n/* not an inline comment */\nb);",
|
||
output: "foo(a,\n/* Not an inline comment */\nb);",
|
||
options: ["always", { ignoreInlineComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 2,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "foo(a, // Not an inline comment\nb);",
|
||
output: "foo(a, // not an inline comment\nb);",
|
||
options: ["never", { ignoreInlineComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 8,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "foo(a, /* Not an inline comment */\nb);",
|
||
output: "foo(a, /* not an inline comment */\nb);",
|
||
options: ["never", { ignoreInlineComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 8,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "foo(a,\n/* Not an inline comment */b);",
|
||
output: "foo(a,\n/* not an inline comment */b);",
|
||
options: ["never", { ignoreInlineComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 2,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "foo(a,\n/* Not an inline comment */\nb);",
|
||
output: "foo(a,\n/* not an inline comment */\nb);",
|
||
options: ["never", { ignoreInlineComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 2,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
|
||
// Comments which do not match ignorePattern are still warned
|
||
{
|
||
code: "// not matching",
|
||
output: "// Not matching",
|
||
options: ["always", { ignorePattern: "ignored?" }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "// Not matching",
|
||
output: "// not matching",
|
||
options: ["never", { ignorePattern: "ignored?" }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
|
||
// ignoreConsecutiveComments only applies to comments with no tokens between them
|
||
{
|
||
code: [
|
||
"// This comment is valid since it is capitalized,",
|
||
"// and this one is valid since it follows a valid one,",
|
||
"foo();",
|
||
"// this comment is now invalid.",
|
||
].join("\n"),
|
||
output: [
|
||
"// This comment is valid since it is capitalized,",
|
||
"// and this one is valid since it follows a valid one,",
|
||
"foo();",
|
||
"// This comment is now invalid.",
|
||
].join("\n"),
|
||
options: ["always", { ignoreConsecutiveComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 4,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
|
||
// Only the initial comment should warn if ignoreConsecutiveComments:true
|
||
{
|
||
code: [
|
||
"// this comment is invalid since it is not capitalized,",
|
||
"// but this one is ignored since it is consecutive.",
|
||
].join("\n"),
|
||
output: [
|
||
"// This comment is invalid since it is not capitalized,",
|
||
"// but this one is ignored since it is consecutive.",
|
||
].join("\n"),
|
||
options: ["always", { ignoreConsecutiveComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: [
|
||
"// This comment is invalid since it is not capitalized,",
|
||
"// But this one is ignored since it is consecutive.",
|
||
].join("\n"),
|
||
output: [
|
||
"// this comment is invalid since it is not capitalized,",
|
||
"// But this one is ignored since it is consecutive.",
|
||
].join("\n"),
|
||
options: ["never", { ignoreConsecutiveComments: true }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
|
||
// Consecutive comments should warn if ignoreConsecutiveComments:false
|
||
{
|
||
code: [
|
||
"// This comment is valid since it is capitalized,",
|
||
"// but this one is invalid even if it follows a valid one.",
|
||
].join("\n"),
|
||
output: [
|
||
"// This comment is valid since it is capitalized,",
|
||
"// But this one is invalid even if it follows a valid one.",
|
||
].join("\n"),
|
||
options: ["always", { ignoreConsecutiveComments: false }],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 2,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
|
||
// Comments are warned if URL is not at the start of the comment
|
||
{
|
||
code: "// should fail. https://github.com",
|
||
output: "// Should fail. https://github.com",
|
||
options: ["always"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedLowercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
code: "// Should fail. https://github.com",
|
||
output: "// should fail. https://github.com",
|
||
options: ["never"],
|
||
errors: [
|
||
{
|
||
messageId: "unexpectedUppercaseComment",
|
||
line: 1,
|
||
column: 1,
|
||
},
|
||
],
|
||
},
|
||
],
|
||
});
|