chore: quiet context.fix API deprecation warnings

package.json

@@ -84,6 +84,7 @@
     "eslint-config-airbnb-typescript": "^12.0.0",
     "eslint-config-prettier": "^8.1.0",
     "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jest": "^24.7.0",
     "eslint-plugin-prettier": "^3.1.4",
     "eslint-plugin-tsdoc": "^0.2.7",
     "husky": "^6.0.0",

src/index.ts

@@ -26,6 +26,9 @@ import defaults, {
   IgnoreValue,
   RegExpString,
 } from './defaults';
+import unsafeQuietStylelintDeprecationWarning from './unsafe-quiet-stylelint-deprecation-warning';
+
+unsafeQuietStylelintDeprecationWarning();
 
 const { utils } = stylelint;
 const meta: RuleMeta = {

src/unsafe-quiet-stylelint-deprecation-warning.ts

@@ -0,0 +1,34 @@
+import process from 'node:process';
+import { ruleName } from './defaults';
+
+// internal warning code
+// @see: https://github.com/stylelint/stylelint/blob/3a903800248fcccd4968e8e0dc4a76a4d8b88ff4/lib/utils/emitDeprecationWarning.mjs#L3-L11
+const STYLELINT_DEPRECATION_WARNING_PREFIX = 'stylelint:';
+
+type Warning = Error & {
+  code: string;
+};
+
+/**
+ * Quiet all stylelint related deprecation warnings like `context.fix` or `utils.report` API.
+ */
+export default function unsafeQuietStylelintDeprecationWarning(): void {
+  const original = process.emitWarning;
+  process.emitWarning = function emitWarning(...args) {
+    const [message, options] = args;
+
+    if (
+      message &&
+      typeof message === 'string' &&
+      message?.includes(ruleName) &&
+      options &&
+      typeof options === 'object' &&
+      options?.type === 'DeprecationWarning' &&
+      options?.code?.startsWith(STYLELINT_DEPRECATION_WARNING_PREFIX)
+    ) {
+      return;
+    }
+
+    original.apply(process, args);
+  };
+}

test/.eslintrc.json

@@ -1,4 +1,8 @@
 {
+  "plugins": ["jest"],
+  "env": {
+    "jest/globals": true
+  },
   "globals": {
     "testRule": "readonly",
     "testCustomAutoFixMessage": "readonly"

test/unsafe-quiet-stylelint-deprecation-warning.js

@@ -0,0 +1,49 @@
+import process from 'node:process';
+import unsafeQuietStylelintDeprecationWarning from '../src/unsafe-quiet-stylelint-deprecation-warning';
+import { ruleName } from '../src/defaults';
+
+describe('quietContextFixDeprecationWarning', () => {
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it('quiets context.fix dewprecation warnings', () => {
+    const emitWarningSpy = jest.spyOn(process, 'emitWarning');
+
+    unsafeQuietStylelintDeprecationWarning();
+
+    process.emitWarning(ruleName, {
+      type: 'DeprecationWarning',
+      code: 'stylelint:005',
+    });
+
+    expect(emitWarningSpy).not.toHaveBeenCalled();
+  });
+
+  it('quiets utils.report dewprecation warnings', () => {
+    const emitWarningSpy = jest.spyOn(process, 'emitWarning');
+
+    unsafeQuietStylelintDeprecationWarning();
+
+    process.emitWarning(ruleName, {
+      type: 'DeprecationWarning',
+      code: 'stylelint:007',
+    });
+
+    expect(emitWarningSpy).not.toHaveBeenCalled();
+  });
+
+  it('re-emits unrelated warnings', () => {
+    const emitWarningSpy = jest.spyOn(process, 'emitWarning');
+
+    unsafeQuietStylelintDeprecationWarning();
+
+    process.emitWarning('foo', {
+      type: 'DeprecationWarning',
+      code: 'bar',
+    });
+
+    expect(emitWarningSpy).toHaveBeenCalled();
+    expect(emitWarningSpy).toHaveBeenCalledTimes(1);
+  });
+});