Skip to content

chore: bump typescript-eslint to v7 #10271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+117 −110
Draft

chore: bump typescript-eslint to v7 #10271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6092db9
chore: bump typescript-eslint to v7
JoshuaKGoldberg Jul 5, 2024
1430700
Disable no-explicit-any
JoshuaKGoldberg Jul 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ module.exports = {
'react/require-default-props': [ERROR, {ignoreFunctionalComponents: true}],

'@typescript-eslint/consistent-type-definitions': OFF,
'@typescript-eslint/no-explicit-any': OFF,
'@typescript-eslint/require-await': OFF,

'@typescript-eslint/ban-ts-comment': [
Expand Down Expand Up @@ -379,7 +380,6 @@ module.exports = {
// function placeholder params are always ignored, and any other unused
// locals must be justified with a disable comment.
'@typescript-eslint/no-unused-vars': [ERROR, {ignoreRestSiblings: true}],
'@typescript-eslint/prefer-optional-chain': ERROR,
Copy link
Contributor Author

@JoshuaKGoldberg JoshuaKGoldberg Jul 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As much as I love this rule, it needs linting with type information to be bug-free. typescript-eslint/typescript-eslint#6397 changed the rule to require type info in typescript-eslint v6.

I briefly tried adding typed linting in this PR but:

...so my suggestion would be to wait until v8 to use the stabilized parserOptions.projectService.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC, we had a weird type checking setup (to make tests type checked), and I don't remember a good way to deal with it.

'@docusaurus/no-html-links': ERROR,
'@docusaurus/prefer-docusaurus-heading': ERROR,
'@docusaurus/no-untranslated-text': [
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@
"@types/react-test-renderer": "^18.0.0",
"@types/semver": "^7.5.0",
"@types/shelljs": "^0.8.12",
"@typescript-eslint/eslint-plugin": "^5.62.0",
"@typescript-eslint/parser": "^5.62.0",
"@typescript-eslint/eslint-plugin": "^7.15.0",
"@typescript-eslint/parser": "^7.15.0",
"cross-env": "^7.0.3",
"cspell": "^8.1.0",
"eslint": "^8.45.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import dedent from 'dedent';
import npm2yarn from '../index';

const process = async (
content: any,
content: vfile.Compatible | undefined,
options?: Parameters<typeof npm2yarn>[0],
) => {
const {remark} = await import('remark');
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-remark-plugin-npm2yarn/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ const transformNode = (
...converters.flatMap(createConvertedTabItem),
],
},
] as any[];
];
};

const isMdxEsmLiteral = (node: Node): node is Literal =>
Expand Down
2 changes: 0 additions & 2 deletions packages/docusaurus-theme-classic/src/theme-classic.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,7 +957,6 @@ declare module '@theme/MDXComponents' {
readonly h6: (props: ComponentProps<'h6'>) => JSX.Element;
readonly admonition: typeof Admonition;
readonly mermaid: typeof Mermaid;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
[tagName: string]: ComponentType<any>;
};

Expand Down Expand Up @@ -1203,7 +1202,6 @@ declare module '@theme/NavbarItem/ComponentTypes' {
readonly docSidebar: typeof DocSidebarNavbarItem;
readonly docsVersion: typeof DocsVersionNavbarItem;
readonly docsVersionDropdown: typeof DocsVersionDropdownNavbarItem;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
[customComponentType: string]: ComponentType<any>;
};

Expand Down
1 change: 0 additions & 1 deletion packages/docusaurus-types/src/routing.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,6 @@ export type RouteChunkNames = {
*/
export type Registry = {
readonly [chunkName: string]: [
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Loader: () => Promise<any>,
ModuleName: string,
ResolvedModuleName: string,
Expand Down
1 change: 0 additions & 1 deletion packages/docusaurus-types/src/swizzle.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ export type SwizzleConfig = {
* @see https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/60766
*/
export type WrapperProps<
// eslint-disable-next-line @typescript-eslint/no-explicit-any
T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>,
> = T extends JSXElementConstructor<infer P>
? unknown extends P
Expand Down
3 changes: 1 addition & 2 deletions packages/docusaurus-utils/src/markdownUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ export function unwrapMdxCodeBlocks(content: string): string {
const regexp4 =
/(?<begin>^|\r?\n)(?<indentStart>\x20*)````(?<spaces>\x20*)mdx-code-block\r?\n(?<children>.*?)\r?\n(?<indentEnd>\x20*)````(?<end>\r?\n|$)/gs;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const replacer = (substring: string, ...args: any[]) => {
const groups = args.at(-1);
return `${groups.begin}${groups.children}${groups.end}`;
Expand Down Expand Up @@ -105,7 +104,7 @@ export function admonitionTitleToDirectiveLabel(
'gm',
);

return content.replaceAll(regexp, (substring, ...args: any[]) => {
return content.replaceAll(regexp, (substring, ...args) => {
const groups = args.at(-1);

return `${groups.quote ?? ''}${groups.indentation ?? ''}${
Expand Down
1 change: 0 additions & 1 deletion packages/docusaurus/src/client/exports/ComponentCreator.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ export default function ComponentCreator(
}

const chunkNames = routesChunkNames[`${path}-${hash}`]!;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const loader: {[key: string]: () => Promise<any>} = {};
const modules: string[] = [];
const optsWebpack: string[] = [];
Expand Down
6 changes: 3 additions & 3 deletions packages/docusaurus/src/server/plugins/__tests__/plugins.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ import {fromPartial} from '@total-typescript/shoehorn';
import {loadPlugins, reloadPlugin} from '../plugins';
import type {LoadContext, Plugin, PluginConfig} from '@docusaurus/types';

async function testLoad({
async function testLoad<Content = unknown>({
plugins,
themes,
}: {
plugins: PluginConfig<any>[];
themes: PluginConfig<any>[];
plugins: PluginConfig<Content>[];
themes: PluginConfig<Content>[];
}) {
const siteDir = path.join(__dirname, '__fixtures__/site-with-plugin');

Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"build": "tsc"
},
"dependencies": {
"@typescript-eslint/utils": "^5.62.0",
"@typescript-eslint/utils": "^7.15.0",
"tslib": "^2.6.0"
},
"devDependencies": {
Expand Down
3 changes: 1 addition & 2 deletions packages/eslint-plugin/src/rules/no-html-links.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

import {createRule} from '../util';
import type {TSESTree} from '@typescript-eslint/types/dist/ts-estree';
import type {TSESTree} from '@typescript-eslint/types';
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Package exports were cleaned up in typescript-eslint v6: https://typescript-eslint.io/blog/announcing-typescript-eslint-v6#package-exports


const docsUrl = 'https://docusaurus.io/docs/docusaurus-core#link';

Expand Down Expand Up @@ -35,7 +35,6 @@ export default createRule<Options, MessageIds>({
type: 'problem',
docs: {
description: 'enforce using Docusaurus Link component instead of <a> tag',
recommended: false,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are no longer required in types for rules, and it looks to me that these weren't used anywhere in Docusaurus code.

},
schema: [
{
Expand Down
3 changes: 1 addition & 2 deletions packages/eslint-plugin/src/rules/no-untranslated-text.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

import {isTextLabelChild, createRule} from '../util';
import type {TSESTree} from '@typescript-eslint/types/dist/ts-estree';
import type {TSESTree} from '@typescript-eslint/types';

type Options = [
{
Expand All @@ -22,7 +22,6 @@ export default createRule<Options, MessageIds>({
docs: {
description:
'enforce text labels in JSX to be wrapped by translate calls',
recommended: false,
},
schema: [
{
Expand Down
3 changes: 1 addition & 2 deletions packages/eslint-plugin/src/rules/prefer-docusaurus-heading.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

import {createRule} from '../util';
import type {TSESTree} from '@typescript-eslint/types/dist/ts-estree';
import type {TSESTree} from '@typescript-eslint/types';

type Options = [];
type MessageIds = 'headings';
Expand All @@ -18,7 +18,6 @@ export default createRule<Options, MessageIds>({
docs: {
description:
'enforce using Docusaurus theme Heading component instead of any <hn> tag',
recommended: false,
},
schema: [],
messages: {
Expand Down
3 changes: 1 addition & 2 deletions packages/eslint-plugin/src/rules/string-literal-i18n-messages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
isStringWithoutExpressions,
createRule,
} from '../util';
import type {TSESTree} from '@typescript-eslint/types/dist/ts-estree';
import type {TSESTree} from '@typescript-eslint/types';

type Options = [];
type MessageIds = 'translateChildren' | 'translateArg';
Expand All @@ -21,7 +21,6 @@ export default createRule<Options, MessageIds>({
type: 'problem',
docs: {
description: 'enforce translate APIs to be called on plain text labels',
recommended: 'error',
},
schema: [],
messages: {
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin/src/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

import {ESLintUtils} from '@typescript-eslint/utils';
import type {TSESTree} from '@typescript-eslint/types/dist/ts-estree';
import type {TSESTree} from '@typescript-eslint/types';

type CheckTranslateChildOptions = {
ignoredStrings?: string[];
Expand Down
1 change: 0 additions & 1 deletion website/src/plugins/featureRequests/FeatureRequestsPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ function CannyWidget({basePath}: {basePath: string}) {

const theme = useCannyTheme();
useEffect(() => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const {Canny} = window as any;
Canny('render', {
boardToken: BOARD_TOKEN,
Expand Down
Loading