biomejs / website

Biome's website
https://biomejs.dev
MIT License
33 stars 57 forks source link

📚 Incorrect documentation for the rule "use-import-extensions" #794

Open kibertoad opened 1 month ago

kibertoad commented 1 month ago

Documentation URL

https://biomejs.dev/linter/rules/use-import-extensions/

Description

make sure to enable allowImportingTsExtensions=true in your tsconfig.json.

This seems to be an incorrect statement, as allowImportingTsExtensions no longer is useful due to explicit extension mapping support, and it never was super useful to begin with, as it was blocking emission of transpiled code, so referring to it is more confusing than helpful.

Rule does not yet check filesystem for file type. It tries to guess which extension it should add based on the file extension of the current file and the import path.

Caveat seems both redundant and also confusing, having in mind that "Options" section explains both the default and the option to provide mapping manually, while caveat only refers to the default behaviour.

Expectations

Documentation doesn't contain redundant or confusing descriptions.

Code of Conduct

Conaclos commented 1 month ago

due to explicit extension mapping support.

Have you some link to share about this? I am not aware of this change.

kibertoad commented 1 month ago

@Conaclos I mean https://github.com/biomejs/biome/pull/3274

Conaclos commented 1 month ago

Oh, I got it. I thought you was talking about TSC.