Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add node shims example #2997

Merged
merged 1 commit into from
May 3, 2023
Merged

chore: add node shims example #2997

merged 1 commit into from
May 3, 2023

Conversation

hardfist
Copy link
Contributor

@hardfist hardfist commented May 3, 2023

Related issue (if exists)

it's a common question that users import node globals like process and Buffer like #2994, so we provide an example about how to provide custom shims to avoid runtime error on browser.

Summary

馃 Generated by Copilot at 8959d13

This pull request adds a new example project that shows how to use the rspack CLI tool to bundle and serve JavaScript modules that use Node.js globals in the browser. It creates a simple app that renders a message with the answer to life, the universe, and everything.

Walkthrough

馃 Generated by Copilot at 8959d13

  • Add an example project that uses the rspack CLI tool to bundle and serve JavaScript modules (link, link, link, link, link, link, link)
  • Create a basic HTML template for the project in index.html and inject it into the output bundle with the html plugin (link, link)
  • Define the project metadata, scripts, and dev dependency in package.json and reference the rspack CLI tool as a workspace package (link)
  • Configure the context, entry, and builtins options for the rspack CLI tool in rspack.config.js and use the provide plugin to shim the process global variable with a custom module (link, link)
  • Implement the app logic in src/index.js and import the util and answer modules (link, link, link)
  • Define a constant named answer with the value 42 in src/answer.js and export it (link)
  • Log the process variable to the console in src/util.js and demonstrate how the provide plugin works (link, link)

@changeset-bot
Copy link

changeset-bot bot commented May 3, 2023

鈿狅笍 No Changeset found

Latest commit: 06995c5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@hardfist hardfist requested a review from hyf0 May 3, 2023 10:32
@github-actions github-actions bot added the team The issue/pr is created by the member of Rspack. label May 3, 2023
@hardfist hardfist added this pull request to the merge queue May 3, 2023
Merged via the queue into main with commit aa0c694 May 3, 2023
10 checks passed
@hardfist hardfist deleted the add-shim-example branch May 3, 2023 13:02
siyou pushed a commit to siyou/rspack that referenced this pull request May 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team The issue/pr is created by the member of Rspack.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants