Skip to content

Commit e3038d4

Browse files
doc: add prerequisite for browser mode (#4455)
* doc: add prerequisite for browser mode Signed-off-by: nkomonen <[email protected]> * Update docs/browser.md --------- Signed-off-by: nkomonen <[email protected]> Co-authored-by: Justin M. Keyes <[email protected]>
1 parent bde0868 commit e3038d4

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ To develop this project, install these dependencies:
2828
- [Git](https://git-scm.com/downloads)
2929
- (optional) Set `git blame` to ignore noise-commits: `git config blame.ignoreRevsFile .git-blame-ignore-revs`
3030
- [AWS `git secrets`](https://github.com/awslabs/git-secrets)
31+
- (required for Web mode) [TypeScript + Webpack Problem Matcher](https://marketplace.visualstudio.com/items?itemName=amodio.tsl-problem-matcher)
3132
- (optional) [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
3233
- (optional) [Docker](https://docs.docker.com/get-docker/)
3334

docs/browser.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ the desktop version.
77

88
You can run the browser implementation of the extension in the following ways.
99

10+
## Pre-requisites
11+
12+
[See the CONTRIBUTING document.](../CONTRIBUTING.md#setup)
13+
1014
### General Notes
1115

1216
- To see logs, using the Command Palette search: `Toggle Developer Tools`. Then go to the `Console` tab. In browser mode VS Code seems to duplicate log messages, idk how to fix this.
@@ -70,7 +74,7 @@ VS Code window, in the background it is running in a Browser context.
7074

7175
## Finding incompatible transitive dependencies
7276

73-
For example, if I have a Typescript module, `myFile.ts`, that imports a module, which imports another module (transitive dependency) such as `fs-extra`,
77+
For example, if I have a Typescript module, `myFile.ts`, that imports a module which imports another module (transitive dependency) such as `fs-extra`,
7478
when I execute `myFile.ts` in the browser it will break due to `fs-extra` not being browser compatible.
7579

7680
It may be difficult to determine which module imported `fs-extra` due to a nested chain of transitive dependencies.

0 commit comments

Comments
 (0)