Skip to content

Figure out how to deal with annoying node: prefix in auto-imports from @types/node #43842

Closed
#45080
Closed
Figure out how to deal with annoying node: prefix in auto-imports from @types/node#43842
#45080
Assignees
andrewbranch
Labels
Domain: LS: Auto-importFix AvailableA PR has been opened for this issueIn DiscussionNot yet reached consensusSuggestionAn idea for TypeScript
Milestone
TypeScript 4.4.1 (RC)

Description

@DanielRosenwasser
Daniel Rosenwasser (DanielRosenwasser)
opened on Apr 27, 2021

Nowadays @types/node ships with built-ins like fs as well as node:fs. Accidentally auto-importing these are extremely annoying if you're trying to target older versions of Node.js.

We should consider

  • inferring the best type of auto-import from your project
  • pick the older style of imports one until Node 16 14 becomes the last supported version
  • provide an option

CC Andrew Branch (@andrewbranch) Matt Bierner (@mjbvz)

Activity

  1. Daniel Rosenwasser (DanielRosenwasser)
    added
    SuggestionAn idea for TypeScript
    In DiscussionNot yet reached consensus
    Domain: LS: Auto-import
    on Apr 27, 2021

  2. andrewbranch commented on Apr 27, 2021

    @andrewbranch
    Andrew Branch (andrewbranch)
    on Apr 27, 2021
    Member

    Thanks for opening an issue—this has been on my mental to-do list since Ben Lichtman (@uniqueiniquity) brought it up. I’m actually surprised we haven’t gotten a flood of complaints about it already 🤔

  3. jakebailey commented on Apr 27, 2021

    @jakebailey
    Jake Bailey (jakebailey)
    on Apr 27, 2021
    Member

    I think it's very likely that people just have old versions of the packages installed, predating DefinitelyTyped/DefinitelyTyped#51107.

    I know I hit this and it's frustrating, but I'm pretty diligent about updating my stuff regularly.

  4. jakebailey commented on Apr 27, 2021

    @jakebailey
    Jake Bailey (jakebailey)
    on Apr 27, 2021
    Member

    And, this may go away in short order with DefinitelyTyped/DefinitelyTyped#52595.

  5. DanielRosenwasser commented on Apr 28, 2021

    @DanielRosenwasser
    Daniel Rosenwasser (DanielRosenwasser)
    on Apr 28, 2021
    MemberAuthor

    CC Ron Buckton (@rbuckton) we don't really understand this well enough, and I heard there's some churn going into DefinitelyTyped?

  6. andrewbranch commented on Apr 28, 2021

    @andrewbranch
    Andrew Branch (andrewbranch)
    on Apr 28, 2021
    Member

    #42764 for reference

  7. sheetalkamat commented on Apr 28, 2021

    @sheetalkamat
    Sheetal Nandi (sheetalkamat)
    on Apr 28, 2021
    Member

    Also needs handling for ATA: https://github.com/microsoft/TypeScript/blob/master/src/jsTyping/jsTyping.ts#L32 ?

  8. karlhorky commented on May 7, 2021

    @karlhorky
    Karl Horky (karlhorky)
    on May 7, 2021
    Contributor

    It seems like the PR from Simon Schick (@SimonSchick) was merged DefinitelyTyped/DefinitelyTyped#52595

    Unfortunately, some applications (like ours) are depending on these module specifiers to work in TypeScript and also VS Code: DefinitelyTyped/DefinitelyTyped#52595

    Could the fix in #42764 be prioritized so that node: prefixes stay valid module specifiers?

  9. SimonSchick commented on May 7, 2021

    @SimonSchick
    Simon Schick (SimonSchick)
    on May 7, 2021
    Contributor

    Even if #42764 was fixed we would not be able to use this feature as the typings need to support old versions.

  10. karlhorky commented on May 8, 2021

    @karlhorky
    Karl Horky (karlhorky)
    on May 8, 2021
    Contributor

    I guess what I would hope for (although I'm not sure if this is the changes described in #42764) would be to satisfy both requirements (prefixed and unprefixed builtin module specifiers):

    1. the node: definitions stay in to not break users who are using them
    2. the non-prefixed versions also stay there
    3. the non-prefixed versions are selected for auto-imports (no user configuration for selecting the node: versions for now)

    Also mentioned that over here: DefinitelyTyped/DefinitelyTyped#52595 (comment)

  11. andrewbranch commented on May 10, 2021

    @andrewbranch
    Andrew Branch (andrewbranch)
    on May 10, 2021
    Member

    Even if #42764 was fixed we would not be able to use this feature as the typings need to support old versions.

    Simon Schick (@SimonSchick) you’re referring to the node: protocol imports not being supported in CJS require prior to Node 16, right? But if/when that gets backported to Node 14, or when you start writing new types for Node 16, you’d be able to use the feature at that point, right?

  12. SimonSchick commented on May 10, 2021

    @SimonSchick
    Simon Schick (SimonSchick)
    on May 10, 2021
    Contributor

    No, I'm talking about the fact that node typings lag several TS versions behind for compatibility.

  13. karlhorky commented on May 30, 2021

    @karlhorky
    Karl Horky (karlhorky)
    on May 30, 2021
    Contributor

    So looks like the node: scheme / prefix was backported to Node.js 14.13.1 / 12.20.0 🎉

    https://nodejs.org/api/esm.html -> link "node: Imports" (links with anchors don't scroll properly right now)

    Screen Shot 2021-05-30 at 11 04 39

  14. karlhorky commented on May 30, 2021

    @karlhorky
    Karl Horky (karlhorky)
    on May 30, 2021
    Contributor

    Ah, maybe require / CommonJS support is not quite there yet for v14 and v12:

    In Node 16 require('node:fs') works, but it looks like it still doesn't in 14.17.0.

    DefinitelyTyped/DefinitelyTyped#52595 (comment)

  15. karlhorky commented on Jul 3, 2021

    @karlhorky
    Karl Horky (karlhorky)
    on Jul 3, 2021
    Contributor

    @types/node@16.0.0 has been published now - the node: schema / prefix now works again properly:

  16. Andrew Branch (andrewbranch)
    added this to the TypeScript 4.4.1 (RC) milestone on Jul 16, 2021
  17. Andrew Branch (andrewbranch)
    self-assigned this
    on Jul 16, 2021
  18. TypeScript Bot (typescript-bot)
    added
    Fix AvailableA PR has been opened for this issue
    on Jul 16, 2021
  19. Andrew Branch (andrewbranch)
    closed this as completedin #45080on Jul 19, 2021

  20. Pytal commented on Aug 14, 2021

    @Pytal
    Pytal
    on Aug 14, 2021

    As the node: import URL scheme has been backported to v14.13.1 and v12.20.0 https://nodejs.org/api/esm.html#esm_node_imports

    image

    Will @types/node for versions 14 and 12 be updated?

  21. SimonSchick commented on Aug 14, 2021

    @SimonSchick
    Simon Schick (SimonSchick)
    on Aug 14, 2021
    Contributor

    I probably won't do it as I prefer working on the bleeding edge stuff, but the process is relatively trivial.

    • Add a secondary declare module for each module declaration that re-exports everything with the node: prefix
    • (Optional): Change all internal imports to prefer node: prefix.

    You can use the current typings as an example or even just copy/paste from there.

  22. ExE-Boss commented on Aug 14, 2021

    @ExE-Boss
    ExE Boss (ExE-Boss)
    on Aug 14, 2021
    Contributor

    Pytal

    As the node: import URL scheme has been backported to v14.13.1 and v12.20.0

    That’s only in ECMAScript Module import statements, not the CommonJS require(…) function.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Domain: LS: Auto-importFix AvailableA PR has been opened for this issueIn DiscussionNot yet reached consensusSuggestionAn idea for TypeScript

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions