nitrojs / nitrojs/nitro

Allow mocking and aliasing externals

Open
#1,118 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement performance v2
Dominant language
TypeScript
Stars
11.2k
Forks
899
Avg merge
2d 24m
Merged PRs (30d)
40

Description

When bundling and inlining dependencies, we have a chance to use rollup configuration to mock some unwanted external dependencies using unenv (nuxt uses this for example for vue deps).

This is not possible when externalizing those dependencies and using nitro externals + nft to track them.

With a new option like externals.alias, we can instruct nft to use a mocked and auto-generated package instead. Previously it wasn't possible but with new implementation of externals plugin with full-control over dep graph, we can do this.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the externalization implementation and the new externals plugin mentioned in the issue, then compare it with the linked Nuxt example in packages/nuxt/src/core/nitro.ts. Trace how nft receives the dependency graph and define what externals.alias should generate and how a mocked external should be selected. Done means the option supports aliasing an external dependency and is covered by an appropriate test.

Written by the indexing model from the issue text.

Assessment

Tech stack
rollup, typescript
Domain
backend, build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.