Add section on Target Environments #282053
Conversation
jruales
changed the title
There was a problem hiding this comment.
Pull request overview
This PR documents the target runtime environments used to organize code within VS Code's layered architecture. It adds important context about how code is structured based on which runtime APIs it requires (JavaScript, Web, Node.js, or Electron).
Key Changes
- Added "Target Environments" section explaining the 6 environment types:
common,browser,node,electron-browser,electron-utility, andelectron-main - Documented the dependency relationships between different target environments
- Clarified which APIs are available in each environment
| - may use code from: `common` | ||
| - `node`: Source code that requires Node.JS APIs | ||
| - may use code from: `common` | ||
| - `electron-browser`: Source code that requires the `browser` APIs like access to the DOM and a small subset of APIs to communicate with the Electron main process (anything exposed from `src/vs/base/parts/sandbox/electron-browser/globals.ts` |
There was a problem hiding this comment.
Missing closing parenthesis at the end of the line. The parenthesis opened before "anything exposed" should be closed after "globals.ts`".
| - `electron-browser`: Source code that requires the `browser` APIs like access to the DOM and a small subset of APIs to communicate with the Electron main process (anything exposed from `src/vs/base/parts/sandbox/electron-browser/globals.ts` | |
| - `electron-browser`: Source code that requires the `browser` APIs like access to the DOM and a small subset of APIs to communicate with the Electron main process (anything exposed from `src/vs/base/parts/sandbox/electron-browser/globals.ts`) |
|
|
||
| ### Target Environments | ||
| Inside each layer, the code is organized by the target runtime environment. This ensures that only the runtime specific APIs are used. In the code we distinguish between the following target environments: | ||
| - `common`: Source code that only requires basic JavaScript APIs and run in all the other target environments |
There was a problem hiding this comment.
Grammar error: "run" should be "runs" to agree with the singular subject "Source code".
| - `common`: Source code that only requires basic JavaScript APIs and run in all the other target environments | |
| - `common`: Source code that only requires basic JavaScript APIs and runs in all the other target environments |
| - `node`: Source code that requires Node.JS APIs | ||
| - may use code from: `common` | ||
| - `electron-browser`: Source code that requires the `browser` APIs like access to the DOM and a small subset of APIs to communicate with the Electron main process (anything exposed from `src/vs/base/parts/sandbox/electron-browser/globals.ts` | ||
| - may use code from: `common`, `browser`, `electron-browser` |
There was a problem hiding this comment.
[nitpick] The dependency list includes electron-browser itself, which is redundant. Code from electron-browser can inherently use other code from the same environment. Consider removing electron-browser from this list, or clarify if this is intentionally documenting that modules within the same environment can reference each other.
| - may use code from: `common`, `browser`, `electron-browser` | |
| - may use code from: `common`, `browser` |
No description provided.