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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

docs: add the bundling instruction for Webpack #1236

Merged
merged 2 commits into from Nov 22, 2021
Merged

docs: add the bundling instruction for Webpack #1236

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fecc98
docs: add the bundling instruction for Webpack
pan93412 Nov 21, 2021
8ba8a72
docs: move Webpack section to improve readability
pan93412 Nov 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/bundling.md
View file
Open in desktop
Expand Up @@ -2,6 +2,12 @@

Due to its internal architecture based on Worker Threads, it is not possible to bundle Pino *without* generating additional files.

## Webpack

If you are a Webpack user, you can achieve this with [pino-webpack-plugin](https://github.com/pinojs/pino-webpack-plugin) without manual configuration of `__bundlerPathsOverrides`; however, if you are using other bundlers, you would need to configure it manually.

## Manual Configuration

In particular, a bundler must ensure that the following files are also bundle separately:
pan93412 marked this conversation as resolved.
Show resolved Hide resolved

* `lib/worker.js` from the `thread-stream` dependency
Expand All @@ -27,4 +33,4 @@ globalThis.__bundlerPathsOverrides = {
};
```

Note that `pino/file`, `pino-worker`, `pino-pipeline-worker` and `thread-stream-worker` are required identifiers. Other identifiers are possible based on the user configuration.
Note that `pino/file`, `pino-worker`, `pino-pipeline-worker` and `thread-stream-worker` are required identifiers. Other identifiers are possible based on the user configuration.