chore: adopt new deprecated: DeprecatedInfo meta rule option (#378)

error-four-o-four · JounQin · web-flow · commit cdb95ba7799f · 2025-06-08T19:21:36.000+02:00
Co-authored-by: JounQin &lt;admin@1stg.me&gt;
diff --git a/.changeset/grumpy-ligers-destroy.md b/.changeset/grumpy-ligers-destroy.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": patch
+---
+
+chore: adopt new `deprecated: DeprecatedInfo` meta rule option
diff --git a/src/rules/imports-first.ts b/src/rules/imports-first.ts
@@ -1,4 +1,4 @@
-import { createRule } from '../utils/index.js'
+import { createRule, docsUrl } from '../utils/index.js'
 
 import first from './first.js'
 
@@ -7,7 +7,17 @@ export default createRule({
   name: 'imports-first',
   meta: {
     ...first.meta,
-    deprecated: true,
+    deprecated: {
+      message: 'Replaced by `import-x/first`.',
+      url: 'https://github.com/import-js/eslint-plugin-import/blob/main/CHANGELOG.md#changed-24',
+      deprecatedSince: '2.0.0',
+      replacedBy: [
+        {
+          message: 'Replaced by `import-x/first`.',
+          rule: { name: 'first', url: docsUrl('first') },
+        },
+      ],
+    },
     docs: {
       category: 'Style guide',
       description: 'Replaced by `import-x/first`.',
diff --git a/test/package.spec.ts b/test/package.spec.ts
@@ -62,7 +62,27 @@ describe('package', () => {
   })
 
   it('marks deprecated rules in their metadata', () => {
-    expect(module.rules!['imports-first'].meta.deprecated).toBe(true)
+    expect(module.rules!['imports-first'].meta.deprecated).toBeDefined()
     expect(module.rules!.first.meta.deprecated).not.toBe(true)
   })
+
+  it('provides information about deprecated rules', () => {
+    expect(module.rules!['imports-first'].meta).not.toHaveProperty('replacedBy')
+    expect(module.rules!['imports-first'].meta.deprecated).toEqual(
+      expect.objectContaining<TSESLint.DeprecatedInfo>({
+        message: expect.any(String),
+        url: expect.any(String),
+        deprecatedSince: expect.any(String),
+        replacedBy: [
+          {
+            message: expect.any(String),
+            rule: {
+              name: expect.any(String),
+              url: expect.any(String),
+            },
+          },
+        ],
+      }),
+    )
+  })
 })

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"eslint-plugin-import-x": patch
 +---
++
 +chore: adopt new `deprecated: DeprecatedInfo` meta rule option