Expose file resolution as a utility
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 122k
- Forks
- 37.3k
- Ø Merge
- 4 T. 2 Std.
- Gemergte PRs (30 T.)
- 283
Beschreibung
What is the problem this feature will solve?
Tool authors often need to reimplement Node's resolving behaviors in order to ask the question: if this file was to import this path, which file would Node resolve that to?
This comes up for build tools like Vite, Esbuild, or Webpack. It also comes up for analysis tools like Eslint and Typescript.
For a long time, people were able to get by with the likes of https://www.npmjs.com/package/resolve. But the introduction of the full suite of package.json exports features (conditions, subpath imports, etc) and ESM have resulted in a situation where almost no tool actually covers Node's complete spec correctly anymore. It seems wasteful to try to fix all these parallel implementations rather than share node's implementation as a utility.
What is the feature you are proposing to solve the problem?
A node-provided, importable constructor that takes conditions:
import { Resolver } from 'node:resolver';
let r = new Resolver({
conditions: ['default', 'node', 'development' ]
});
Where the Resolver instance offers a method with the signature:
resolve(requestedPath: string, requestingFile: string): Promise<string | undefined>;
The key features provided here that are not provided (AFAIK) by any existing Node API are:
- you can programmatically ask what would happen under the given conditions. These are distinct from the global
--conditionsthat prevail in the current node process (remember -- we're talking about running this inside a tool like a linter. Regardless of what conditions the linter uses for its own implementation, it should follow imports the way the user's program is going to do it, using the user's conditions.) - you can ask on behalf of another file in another package. Critically, this would need to respect rules like self-referencing. This is in contrast with
require.resolvewhich, even if you setpathsto the inside a package doesn't respect the self-referencing rule.
Note that I'm definitely not asking for access to the state of the current node process's resolver. I don't want its customized loaders, I don't want to share its cache. Rather, this would be asking to set up an entirely separate state that would not interfere with Node's own module loading at all.
What alternatives have you considered?
There are lots of third-party implementations, maintained at great effort and all with incomplete support for Node's behaviors. In theory somebody could invest the effort to make one of them perfect and continually invest in making it follow new node features.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit der Durchsicht der Dokumentation zur Paketauflösung von Node, einschließlich package.json exports, conditions, subpath imports, self-referencing und des bestehenden require.resolve-Verhaltens. Definieren Sie, was ein isolierter importierbarer Resolver bereitstellen sollte, und überprüfen Sie anschließend, dass er im Auftrag einer anderen Datei unter den angegebenen Bedingungen auflösen kann, ohne die Loader oder den Cache des aktuellen Prozesses zu verwenden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, node.js
- Bereich
- api, backend
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100