Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Docs: add type annotation for tseslint.config() usage examples #10508

Copy link
Copy link
Closed
@MonstraG

Description

@MonstraG
Issue body actions

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

In examples of eslint.config.mjs, add:

// @ts-check

import eslint from '@eslint/js';
import tseslint from 'typescript-eslint';

+ /** @type {FlatConfig.ConfigArray} */
export default tseslint.config(
  eslint.configs.recommended,
  tseslint.configs.recommended,
);

(or whatever there actually should be)

(or add this as a separate FAQ item or something)

Affected URL(s)

https://typescript-eslint.io/getting-started/

Additional Info

I request this for the following 2 reasons:

  1. My repositories use types as much as possible, and whenever I have to write .mjs files, I always add type there, for typescript to check them also
  2. without appropriate type annotation, typescript reports;
TS2742: The inferred type of config cannot be named without a reference to
.pnpm/@typescript-eslint+utils@8.18.0_eslint@9.17.0_typescript@5.7.2/node_modules/@typescript-eslint/utils/ts-eslint
. This is likely not portable. A type annotation is necessary.

While the error sounds important, I would still be raising this issue even if error was not there.

Additionally, I don't actually know what to write there, and never could I find this information. I searched for jsdoc, type annotations, ConfigArray and portable but was unable to find any issues that would give me even a hint at what should be the correct @type.

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issueGo ahead, send a pull request that resolves this issuebugSomething isn't workingSomething isn't workinglocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.package: typescript-eslintIssues related to the typescript-eslint packageIssues related to the typescript-eslint package

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.