chore: switch to @tony.ganchev/eslint-plugin-header

.eslintrc.js

@@ -62,7 +62,7 @@ module.exports = {
   plugins: [
     'react-compiler',
     'react-hooks',
-    'header',
+    '@tony.ganchev/header',
     'jest',
     '@typescript-eslint',
     'regexp',
@@ -219,17 +219,29 @@ module.exports = {
     'prefer-template': WARNING,
     yoda: WARNING,
 
-    'header/header': [
+    '@tony.ganchev/header/header': [
       ERROR,
-      'block',
-      [
-        '*',
-        ' * Copyright (c) Facebook, Inc. and its affiliates.',
-        ' *',
-        ' * This source code is licensed under the MIT license found in the',
-        ' * LICENSE file in the root directory of this source tree.',
-        ' ',
-      ],
+      {
+        header: {
+          commentType: 'block',
+          lines: [
+            '*',
+            ' * Copyright (c) Facebook, Inc. and its affiliates.',
+            ' *',
+            ' * This source code is licensed under the MIT license found in the',
+            ' * LICENSE file in the root directory of this source tree.',
+            ' ',
+          ],
+        },
+        leadingComments: {
+          comments: [
+            {
+              commentType: 'block',
+              lines: [/^\* @jest-environment \w+ $/]
+            }
+          ]
+        }
+      }
     ],
 
     'import/extensions': OFF,
@@ -483,7 +495,7 @@ module.exports = {
     {
       files: ['packages/create-docusaurus/templates/**/*.{js,ts,tsx}'],
       rules: {
-        'header/header': OFF,
+        '@tony.ganchev/header/header': OFF,
         'global-require': OFF,
         '@typescript-eslint/no-var-requires': OFF,
         '@docusaurus/no-untranslated-text': OFF,

CONTRIBUTING.md

@@ -202,7 +202,7 @@ By contributing to Docusaurus, you agree that your contributions will be license
  */
 ```
 
-This is also auto-fixable with the `header/header` ESLint rule.
+This is also auto-fixable with the `@tony.ganchev/header/header` ESLint rule.
 
 ### Contributor License Agreement (CLA)
 

package.json

@@ -83,6 +83,7 @@
     "@testing-library/dom": "^10.4.1",
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.2",
+    "@tony.ganchev/eslint-plugin-header": "^3.3.0",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^30.0.0",
     "@types/lodash": "^4.14.197",
@@ -98,7 +99,6 @@
     "eslint": "^8.45.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.9.0",
     "eslint-plugin-jsx-a11y": "^6.7.1",

packages/docusaurus-plugin-content-docs/src/client/__tests__/docsSidebar.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {renderHook} from '@testing-library/react';
 import {useDocsSidebar, DocsSidebarProvider} from '../docsSidebar';

packages/docusaurus-plugin-content-docs/src/client/__tests__/docsUtils.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {renderHook} from '@testing-library/react';
 import {StaticRouter} from 'react-router-dom';

packages/docusaurus-plugin-content-docs/src/client/__tests__/docsVersion.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {renderHook} from '@testing-library/react';
 import {useDocsVersion, DocsVersionProvider} from '../docsVersion';

packages/docusaurus-theme-classic/src/theme/Tabs/__tests__/index.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import type {PropsWithChildren, ReactNode} from 'react';
 import {render} from '@testing-library/react';

packages/docusaurus-theme-common/src/utils/__tests__/reactUtils.test.ts

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import {renderHook} from '@testing-library/react';
 import {usePrevious, useShallowMemoObject} from '../reactUtils';
 

packages/docusaurus-theme-common/src/utils/__tests__/tocUtils.test.ts

@@ -1,15 +1,11 @@
+/** @jest-environment jsdom */
 /**
- /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import {renderHook} from '@testing-library/react';
 import {useFilteredAndTreeifiedTOC, useTreeifiedTOC} from '../tocUtils';
 import type {TOCItem} from '@docusaurus/mdx-loader';

packages/docusaurus-theme-common/src/utils/__tests__/useAlternatePageUtils.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {renderHook} from '@testing-library/react';
 import {StaticRouter} from 'react-router-dom';

packages/docusaurus-theme-common/src/utils/__tests__/useLocalPathname.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {renderHook} from '@testing-library/react';
 import {StaticRouter} from 'react-router-dom';

packages/docusaurus-theme-common/src/utils/__tests__/usePluralForm.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import {jest} from '@jest/globals';
 import React from 'react';
 import {renderHook} from '@testing-library/react';

packages/docusaurus/src/client/__tests__/browserContext.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {renderHook} from '@testing-library/react';
 import {BrowserContextProvider} from '../browserContext';

packages/docusaurus/src/client/__tests__/docusaurusContext.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {renderHook} from '@testing-library/react';
 import {DocusaurusContextProvider} from '../docusaurusContext';

packages/docusaurus/src/client/__tests__/routeContext.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {renderHook} from '@testing-library/react';
 import {RouteContextProvider} from '../routeContext';

packages/docusaurus/src/client/exports/__tests__/BrowserOnly.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {render} from '@testing-library/react';
 import '@testing-library/jest-dom';

packages/docusaurus/src/client/exports/__tests__/Head.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {render} from '@testing-library/react';
 import '@testing-library/jest-dom';

packages/docusaurus/src/client/exports/__tests__/Interpolate.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {render} from '@testing-library/react';
 import '@testing-library/jest-dom';

packages/docusaurus/src/client/exports/__tests__/Link.test.tsx

@@ -1,15 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-/* eslint-disable jsx-a11y/anchor-is-valid */
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React, {type ReactNode} from 'react';
 import {render as renderRTL} from '@testing-library/react';
 import '@testing-library/jest-dom';

packages/docusaurus/src/client/exports/__tests__/Translate.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {render} from '@testing-library/react';
 import '@testing-library/jest-dom';

packages/docusaurus/src/client/exports/__tests__/useBaseUrl.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {renderHook} from '@testing-library/react';
 import {fromPartial} from '@total-typescript/shoehorn';

packages/docusaurus/src/client/exports/__tests__/useGlobalData.test.tsx

@@ -1,14 +1,11 @@
+/** @jest-environment jsdom */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment jsdom
  */
 
-// Jest doesn't allow pragma below other comments. https://github.com/facebook/jest/issues/12573
-// eslint-disable-next-line header/header
 import React from 'react';
 import {renderHook} from '@testing-library/react';
 import useGlobalData, {