Skip to content

Commit 0c6980c

Browse files
author
Luca Forstner
committed
Update docs
1 parent b62bca6 commit 0c6980c

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ These flags serve two purposes:
6767
1. They enable us to remove debug code for our production browser bundles.
6868
2. Enable users to tree-shake Sentry debug code for their production builds.
6969

70-
Flags will be replaced with booleans for our browser bundles, or with statements that do not throw for cjs and esm bundles.
70+
Flags will be replaced with booleans for our browser bundles. In cjs and esm builds, they will be replaced by statements that do not throw.
7171
Take care when introducing new flags - they must be disarmed in our build scripts!
7272

7373
## Linting

rollup/plugins/npmPlugins.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,11 @@ export function makeRemoveBlankLinesPlugin() {
128128
}
129129

130130
/**
131-
* TODO
131+
* Creates a plugin to replace all instances of "__DEBUG_BUILD__" with a safe statement that
132+
* a) evaluates to `true`
133+
* b) can easily be modified by bundlers to evaluate to false, facilitating the treeshaking of logger code.
134+
*
135+
* @returns A `@rollup/plugin-replace` instance.
132136
*/
133137
export function makeDebugBuildStatementReplacePlugin() {
134138
return replace({

0 commit comments

Comments
 (0)