Skip to content

Commit

Permalink
update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alicewriteswrongs committed Apr 10, 2024
1 parent d2864e2 commit 9c56583
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,17 @@ stuck, your debugger may not have switched to a worker process that has halted o
avoid this altogether by setting `--max-workers=1` when you launch Stencil (with the possibility of not being able to
reproduce timing issues between workers as a side effect).

> [!NOTE]
> If you want to have access to sourcemaps when debugging the compiler locally
> you can run the `build` script in `package.json` with the `DEBUG` environment
> variable set to `true` like so:
>
> ```sh
> DEBUG=true npm run build
> ```
>
> this will write a `.js.map` file to disk next to each JavaScript file.
#### Debugging the Compiler in VSCode
Two launch configurations for debugging the compiler can be found in the `.vscode/launch.json` configuration found in
Expand Down
2 changes: 1 addition & 1 deletion scripts/esbuild/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ export function getBaseEsbuildOptions(): ESBuildOptions {
target: getEsbuildTargets(),
};

// if the `build` subcomment is called with the `DEBUG` env var, like
// if the `build` sub-command is called with the `DEBUG` env var, like
//
// DEBUG=true npm run build
//
Expand Down

0 comments on commit 9c56583

Please sign in to comment.