Provide a reliable way to find the entrypoint path or URL
Personne n'a encore pris cette issue.
- Langage dominant
- JavaScript
- Étoiles
- 122k
- Forks
- 37.3k
- Merge moyen
- 4 j 2 h
- PR mergées (30 j)
- 283
Description
What is the problem this feature will solve?
This solves the same problem as require.main.filename did in a CommonJS-only world: finding the entrypoint script for the Node.js process. This is most commonly used to determine the whether the current file is the entrypoint, but is also useful for various other sorts of introspection about the running Node.js environment. My specific use-case is finding a sensible default base URL to use to replicate Node.js's package resolution algorithm.
What is the feature you are proposing to solve the problem?
I suggest something like process.cliEntrypoint or process.cliMainUrl. I think it's important that any solution be usable regardless of whether the current module is CJS or ESM.
What alternatives have you considered?
require.main.filename provides this information but it doesn't work outside of CJS files, nor does it work if the entrypoint itself is ESM.
process.argv[1] sometimes provides this information, but it has a number of problems:
-
If the Node.js CLI is run without a file extension, like
node myappinstead ofnode myapp.js,process.argv[1]won't have an extension either. -
If the entrypoint is a symlink,
process.argv[1]will point to the symlink instead of the physical JS file. This differs from__filename, which means it also differs from the logic used byrequire(). Note thatnpm execalways creates a symlink when running executables. -
process.argvis mutable, so it's possible for unrelated code to modify it in such a way that it's no longer usable to find the entrypoint.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Aucun fichier d’implémentation ni test n’est indiqué. Commencez par examiner comment Node.js détermine actuellement le point d’entrée de la CLI pour CommonJS et ESM, notamment les alternatives require.main.filename et process.argv[1] décrites ici. Le travail est considéré comme terminé lorsqu’une API stable fonctionne avec les deux systèmes de modules et gère les chemins sans extension, les liens symboliques et les modifications ultérieures de process.argv.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, node.js
- Domaine
- backend
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100