Repository navigation
Add a utility to convert file URL or path to one of them? #41521
Description
Activity
- changed the title
[-]Add a utility to convert file URL and path to path?[/-][+]Add a utility to convert between file URL or path to one of them?[/+]on Jan 14, 2022 - changed the title
[-]Add a utility to convert between file URL or path to one of them?[/-][+]Add a utility to convert file URL or path to one of them?[/+]on Jan 14, 2022 We have a
toPathIfFileURLinternal API already, maybe we could expose it in thenode:urlmoduleLines 1558 to 1562 in 38b7961
For converting to URL:
url.from(URL | string)I don't think there is any reliable way to check if a string is a path or a file URL... I'm afraid the best option here is to assume that a string is a path and call
pathToFileurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fnodejs%2Fnode%2Fissues%2Fstring)(which is what is doing Node.js internally as well) – or if you prefer to assume strings are URLs in your application, callnew url(/sitelet?url=https%3A%2F%2Fgithub.com%2Fnodejs%2Fnode%2Fissues%2Fstring).We have a toPathIfFileURL internal API already, maybe we could expose it in the node:url module
Wouldn't it be more natural to have it in
node:path, since we want to convert it to a path? My proposal forpath.from()was inspired byArray.fromandBuffer.fromtype methods.Reacted by Benjamin GruenbaumI don't think there is any reliable way to check if a string is a path or a file URL...
To be clear, the
stringin that example is meant to be a file path, not a string file URL.Example usage:
import path from 'node:path'; // Passthrough path.from('/Users/sindresorhus/dev'); //=> '/Users/sindresorhus/dev' path.from(new URL('file:///Users/sindresorhus/dev')); //=> '/Users/sindresorhus/dev'
Reacted by Szymon Marczak, Benjamin Gruenbaum and Lucas SantosIs this what you had in mind in terms of semantics? benjamingr@0704851#diff-6610c8d452ba38a0db8c591e06af555bc7755ace17065a066c853ffcc5271559R7-R20
Reacted by fisker CheungYes, that's what I want.
Reacted by Benjamin Gruenbaum@aduh95 wdyt about an implementation that does that? ( #41521 (comment) )
@aduh95 wdyt about an implementation that does that? ( #41521 (comment) )
I don't think we'll get consensus landing in core something that treats differently a string depending on if it starts with
file:or not – what if the user meant./file:/(i.e. they really have a local directory namedfile:)?The workarounds that come to mind are:
- only support absolute paths – or require relative paths to start with a
.(like inrequirecalls). - always treat a string as a path.
- publish this as an npm module instead (I think npm module would get away with not supporting having directory named
file:).
Any combination of the above would address my concern, but I'm open to other ideas if someone thinks of something else.
- only support absolute paths – or require relative paths to start with a
@aduh95 I think it's safe to say "if this can be an npm module, sindre has already probably published one" :D Making small useful modules kind of their thing.
Edit: lol found it https://www.npmjs.com/package/file-url
Edit2: actually that's the other side of conversionBasically: I think the main issue with this being on npm is that file urls and paths are both very common in modern Node.js and not having a utility to convert them in core is weird.
I'm sure we can bikeshed the name and semantics as long as the core use case (convert file url to path) is addressed.
Would it be better if the name was explicit
path.fromFileUrlthat only takes either afile://url string or an actualURLwith the file protocol and throws an error on non-file urls?29 remaining items
There has been no activity on this feature request for 5 months. To help maintain relevant open issues, please add the never-stale
Issues and PRs exempt from automated stale handling. label or close this issue if it should be closed. If not, the issue will be automatically closed 6 months after the last non-automated comment.
For more information on how the project manages feature requests, please consult the feature request management document.Please keep this open.
Reacted by Jurj Andrei GeorgeHmm
There has been no activity on this feature request for 5 months. To help maintain relevant open issues, please add the never-stale
Issues and PRs exempt from automated stale handling. label or close this issue if it should be closed. If not, the issue will be automatically closed 6 months after the last non-automated comment.
For more information on how the project manages feature requests, please consult the feature request management document.Please keep this open.
I think there's no current need for another API for file path conversions, the URL module should provide everything y'all need, right? (Just ping me if I'm wrong)
Reacted by fisker Cheung and Sindre SorhusfileURLToPath()handles only the URL branch; it doesn't accept aURL | stringinput and pass paths through unchanged.The actual pattern every caller has to duplicate is:
const path = input instanceof URL ? fileURLToPath(input) : input;
That is precisely the API requested by this issue.
A small
path.from(URL | string)API is unambiguous, useful at every API boundary, and removes the same boilerplate from userland.
What is the problem this feature will solve?
It's a nice way to accept both
URLand path string in API, but we need covert it to either string or URL, it would be nice to have a built-in method to do this.What is the feature you are proposing to solve the problem?
For converting to string:
Maybe add
path.from(URL | string)? @sindresorhus proposed here.For converting to URL:
url.from(URL | string)I'm not sure, since
URLis a standard, I guess adding methodURLobject won't be acceptable, maybe tonode:urlmodule?What alternatives have you considered?
No response