Movatterモバイル変換


[0]ホーム

URL:


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

Sign up
Appearance settings

Rule proposal: Export all types used in exports #7670

Open
Labels
accepting prsGo ahead, send a pull request that resolves this issueenhancement: new plugin ruleNew rule request for eslint-pluginpackage: eslint-pluginIssues related to @typescript-eslint/eslint-plugin
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Before You File a Proposal Please Confirm You Have Done The Following...

My proposal is suitable for this project

  • My proposal specifically checks TypeScript syntax, or it proposes a check that requires type information to be accurate.
  • My proposal is not a "formatting rule"; meaning it does not just enforce how code is formatted (whitespace, brace placement, etc).
  • I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).

Description

If a file exports a construct that relies on some other types, but doesn't export those other types, it can be difficult for other files to declare types based on the construct.

For example, suppose a./somewhere file exports adoSomething function with a single parameter of typeSomeSettings, but doesn't exportSomeSettings. What if a consuming file wants to declare a local/parameter of that sameSomeSettings type? There'd be no easy way to refer toSomeSettings.

import{doSomething}from"./somewhere";exportfunctioncallDoSomethingAndLog(settings:Parameters<typeofdoSomething>[0]){doSomething(settings);console.log("Done!");}

I see this a lot in definitions for libraries. Example:saurabhnemade/react-twitter-embed#132

Fail Cases

interfaceSomeSettings{something:string;}exportfunctionsomething(settings:SomeSettings){// ...}

Pass Cases

exportinterfaceSomeSettings{something:string;}exportfunctionsomething(settings:SomeSettings){// ...}

Additional Info

...I could have sworn this was already filed somewhere, but I couldn't find it after a few minutes of searching. 🤷

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issueenhancement: new plugin ruleNew rule request for eslint-pluginpackage: eslint-pluginIssues related to @typescript-eslint/eslint-plugin

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


      [8]ページ先頭

      ©2009-2025 Movatter.jp