GeezerVison is showing github.com — esm: add import.meta.dirname and import.meta.filename by jsumners · Pull Request #48740 · nodejs/node
Conversation
jsumners
commented
Jul 11, 2023
•
edited by GeoffreyBooth
Loading
Uh oh!
There was an error while loading. Please reload this page.
This PR adds import.meta.dirname and import.meta.filename for ECMAScript Modules that are loaded from the local filesystem. In my view, these properties don’t make any sense for modules loaded from the network, but they are very desired for local modules. At least one recent issue (#47756) wanted them, and there exists at least two ecosystem modules to solve for them:
The Problem
As it stands, to determine the containing directory of a script we must write code like:
import url from 'url'
import path from 'path'
const dirname = path.dirname(url.fileURLToPath(import.meta.url))
Of course, this needs to be repeated in every script that needs the information. With this PR, the code is reduced to:
const dirname = import.meta.__dirname
The developer doesn’t need to remember how to convert the file URL to a path and then resolve the directory from that.
External Discussion
The impetus for this PR is a recent Twitter discussion – https://twitter.com/jasnell/status/1677335322978295809
Notable change
In file:-based ES modules, new properties import.meta.filename and import.meta.dirname provide equivalents to CommonJS __filename and __dirname. In particular, import.meta.filename provides the full absolute path (as a file path, not URL) to the module; and import.meta.dirname provides the full absolute path to the module’s containing folder. These properties are missing for non-file:-based ES modules, such as those loaded from data: or https: URLs.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
MoLow, GlenTiki, gengjiawen, atlowChemi, bricss, tlhunter, bakkot, Lehoczky, Mifrill, simonkberg, and 38 more reacted with thumbs up emoji
jimmywarting reacted with thumbs down emoji
tniessen reacted with confused emoji
jcbhmr, bricss, lin72h, ghiscoding, ximex, miclgael, Razem, svieira, MaartenStaa, tim545, and 4 more reacted with rocket emoji
All reactions
-
👍
48 reactions
-
👎
1 reaction
-
😕
1 reaction
-
🚀
14 reactions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
The
notable-change
PRs with changes that should be highlighted in changelogs.
label has been added by @mcollina.
Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
|
This was suggested before in #39147. Has anything changed since then?
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
This was suggested before in #39147. Has anything changed since then?
I think it is less controversial now. Everybody migrating to ESM needs to figure this out and it requires way too many steps to get those values.
|
jsumners, gengjiawen, Linkgoron, Qard, tlhunter, rschristian, ghiscoding, 0xdevalias, and borys-p reacted with thumbs up emoji
jcbhmr reacted with confused emoji
All reactions
-
👍
9 reactions
-
😕
1 reaction
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
jcbhmr
commented
Jul 12, 2023
•
edited
Loading
Uh oh!
There was an error while loading. Please reload this page.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it's a good idea to introduce this, we should move away from paths IMO.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
jcbhmr, KhafraDev, gurgunday, bricss, jimmywarting, and nicolo-ribaudo reacted with thumbs up emoji
jcbhmr reacted with hooray emoji
All reactions
-
👍
6 reactions
-
🎉
1 reaction
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Everybody migrating to ESM needs to figure this out and it requires way too many steps to get those values.
Why do you need paths though? It shouldn't be necessary, URL should get you covered.
|
jcbhmr, anonrig, bricss, and jimmywarting reacted with thumbs up emoji
jcbhmr reacted with rocket emoji
All reactions
-
👍
4 reactions
-
🚀
1 reaction
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Why do you need paths though? It shouldn't be necessary, URL should get you covered.
Most APIs from fs and path do not work well with URLs. Reading files relative to the current one is something everybody does all the time for all sorts of purposes. Currently, it takes quite a few lines of code to get the path for a file in the same directory:
import { fileURLToPath } from 'url'
import { dirname, join } from 'path'
const __dirname = dirname(url.fileURLToPath(import.meta.url))
const toAccess = join(__dirname, 'another_file')
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Most APIs from fs
That's wrong I think, all node:fs APIs works with either. If you see issues with node:fs and URL, please open an issue, that'd be a bug.
and path
That's kinda obvious, node:path is for paths, not URLs.
Reading files relative to the current one is something everybody does all the time for all sorts of purposes.
That's my point, you should be using URL for that. The equivalent to your code snippet would be:
const toAccess = new URL('./another_file', import.meta.url);
|
bricss, jcbhmr, jimmywarting, nulladdict, trusktr, felixfbecker, and electrovir reacted with thumbs up emoji
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding an explicit -1 on this because it already has an approval and I don't want it to land without some extensive discussion first.
I think this goes in the wrong direction. I'm happy to be proven wrong, but I guess there's also an ideological problem: I think using paths in ESM is a faux-pas, if one goes ESM, they should let paths be a relic of the past, and embrace URLs. I can see it can certainly be useful to have the proposed properties to convert a CJS module to ESM, but someone writing ESM from scratch should never need it, and it would be confusing to add something that works only on file: protocol, when I would prefer to see Node.js go in the direction of being more protocol agnostic.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
jcbhmr, gurgunday, bricss, lucacasonato, nulladdict, trusktr, nicolo-ribaudo, jimmywarting, and wooorm reacted with thumbs up emoji
Qard reacted with thumbs down emoji
jcbhmr reacted with rocket emoji
All reactions
-
👍
9 reactions
-
👎
1 reaction
-
🚀
1 reaction
I think this goes in the wrong direction. I'm happy to be proven wrong, but I guess there's also an ideological problem: I think using paths in ESM is a faux-pas, if one goes ESM, they should let paths be a relic of the past, and embrace URLs. I can see it can certainly be useful to have the proposed properties to convert a CJS module to ESM, but someone writing ESM from scratch should never need it, and it would be confusing to add something that works only on file: protocol, when I would prefer to see Node.js go in the direction of being more protocol agnostic.
We should also consider if it will help the adoption of ESM and make migration easier / less painful.
even if there is an ideological issue - it is not very pragmatic to only provide a solution for "someone writing ESM from scratch".
even if one can argue it will never be needed, avoiding such utilities/helpers because they seem redundant can have a negative effect on the ecosystem.
|
jsumners, ruyadorno, and tim545 reacted with thumbs up emoji
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Almost shed tears, thank you
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
jsumners, ghiscoding, junaga, guansss, and 0xdevalias reacted with heart emoji
if one goes ESM, they should let paths be a relic of the past, and embrace URLs.
It's like a muscle memory even can trace from python. It can avoid many mental burden from using esm, this is my mosted missed feature in esm.
Also many people trapped on this. lots of libs goto full esm have this info everywhere.
It's a good move in the long run, and way friendly for users back then when only cjs exists.
|
MoLow, mcollina, rschristian, ghiscoding, and Nemikolh reacted with thumbs up emoji
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
I will share some my work experience, we used js almost everywhere, some are cjs, some are esm. When it comes to script job in CI and linux server, it's always have been cjs module. because __dirname and __filename used everywhere just like python. Esm equivalence is way verbose and less instinctive.
|
jimmywarting reacted with thumbs down emoji
mcollina and Nemikolh reacted with heart emoji
All reactions
-
👎
1 reaction
-
❤️
2 reactions
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
@aduh95 The vast majority of the modules on npm only accept paths, not URLs. Therefore it adds quite a bit of a mental burden to do that. The recommendation you have is for all modules on NPM to start accepting file:// URLs as well as paths, or even only URLs. I don't think that's feasible.
Even modules that went all-in on ESM only use paths everywhere and not URLs, as an example take a look at https://vitest.dev/guide/#workspaces-support.
Overall I think adding __filename and __dirname will help the adoption of ESM.
|
jsumners, benjamingr, gurgunday, shalvah, aladdin-add, and ghiscoding reacted with thumbs up emoji
jimmywarting reacted with thumbs down emoji
All reactions
-
👍
6 reactions
-
👎
1 reaction
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This was referenced Apr 10, 2026
This was referenced Apr 18, 2026
This was referenced Apr 27, 2026
This was referenced May 4, 2026
This was referenced May 13, 2026
This was referenced May 20, 2026
This was referenced May 28, 2026
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Labels
commit-queue-squash
PRs the Commit Queue should land as one squashed commit.
esm
Issues and PRs related to the ECMAScript Modules implementation.
needs-ci
PRs that need a full CI run.
notable-change
PRs with changes that should be highlighted in changelogs.
semver-minor
PRs that contain new features and should be released in the next minor version.
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
|