Files
331ce34c2a docs: fix broken anchor links from gerund heading updates (#20449)
* Initial plan

* Update gerund headings to imperative forms in maintain, extend, and contribute directories

Co-authored-by: nzakas <[email protected]>

* Update gerund headings to imperative forms in use directory

Co-authored-by: nzakas <[email protected]>

* Update remaining gerund headings to imperative forms in configuration files and rules

Co-authored-by: nzakas <[email protected]>

* Update cross-references to use non-gerund heading anchors

Co-authored-by: nzakas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Amaresh  S M  <[email protected]>

* Fix anchor links and revert Caching heading per review feedback

Co-authored-by: nzakas <[email protected]>

* Fix broken documentation links found by lint:links

Co-authored-by: nzakas <[email protected]>

---------

Co-authored-by: nzakas <[email protected]>
Co-authored-by: Nicholas C. Zakas <[email protected]>
Co-authored-by: Amaresh  S M <[email protected]>

Co-authored-by: Hanzo Dev <[email protected]>
2026-01-29 16:06:21 -07:00

132 lines
3.9 KiB
JavaScript

/**
* @fileoverview Unit tests for the WarningService class.
* @author Francesco Trotta
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const { WarningService } = require("../../../lib/services/warning-service");
const assert = require("node:assert");
const sinon = require("sinon");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
describe("WarningService", () => {
/** @type {WarningService} */
let warningService;
describe("should call `process.emitWarning` in Node.js", () => {
if (typeof process !== "object") {
return; // Skip tests if not in Node.js
}
beforeEach(() => {
sinon.stub(process, "emitWarning");
warningService = new WarningService();
});
afterEach(() => {
sinon.restore();
});
it("emitCircularFixesWarning", () => {
const filename = "/project/file.js";
warningService.emitCircularFixesWarning(filename);
assert(
process.emitWarning.calledOnceWithExactly(
`Circular fixes detected while fixing ${filename}. It is likely that you have conflicting rules in your configuration.`,
"ESLintCircularFixesWarning",
),
"Expected process.emitWarning to be called with the correct arguments",
);
});
it("emitEmptyConfigWarning", () => {
const configFilePath = "/project/eslint.config.js";
warningService.emitEmptyConfigWarning(configFilePath);
assert(
process.emitWarning.calledOnceWithExactly(
`Running ESLint with an empty config (from ${configFilePath}). Please double-check that this is what you want. If you want to run ESLint with an empty config, export [{}] to remove this warning.`,
"ESLintEmptyConfigWarning",
),
"Expected process.emitWarning to be called with the correct arguments",
);
});
it("emitESLintIgnoreWarning", () => {
warningService.emitESLintIgnoreWarning();
assert(
process.emitWarning.calledOnceWithExactly(
'The ".eslintignore" file is no longer supported. Switch to using the "ignores" property in "eslint.config.js": https://eslint.org/docs/latest/use/configure/migration-guide#ignore-files',
"ESLintIgnoreWarning",
),
"Expected process.emitWarning to be called with the correct arguments",
);
});
it("emitInactiveFlagWarning", () => {
const flag = "unstable_foo_bar";
const message = `Lorem ipsum ${flag}.`;
warningService.emitInactiveFlagWarning(flag, message);
assert(
process.emitWarning.calledOnceWithExactly(
message,
`ESLintInactiveFlag_${flag}`,
),
"Expected process.emitWarning to be called with the correct arguments",
);
});
it("emitPoorConcurrencyWarning", () => {
const notice = "use a different concurrency setting";
warningService.emitPoorConcurrencyWarning(notice);
assert(
process.emitWarning.calledOnceWithExactly(
`You may ${notice} to improve performance.`,
"ESLintPoorConcurrencyWarning",
),
"Expected process.emitWarning to be called with the correct arguments",
);
});
});
describe("should not throw an error when `process` is not defined", () => {
if (globalThis.process) {
const originalProcess = process;
beforeEach(() => {
globalThis.process = void 0;
warningService = new WarningService();
});
afterEach(() => {
globalThis.process = originalProcess;
});
}
// Only methods used by the Linter are tested here.
it("emitCircularFixesWarning", () => {
const filename = "/project/file.js";
warningService.emitCircularFixesWarning(filename);
});
it("emitInactiveFlagWarning", () => {
const flag = "unstable_foo_bar";
const message = `Lorem ipsum ${flag}.`;
warningService.emitInactiveFlagWarning(flag, message);
});
});
});