You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-8Lines changed: 12 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,11 @@ This repository includes a few recommended plugins for your convenience:
35
35
- ESLint extension highlights possible issues in your code following our common eslint configuration.
36
36
- ANTLR4 grammar support extension helps to work with the `bson-transpilers` package that is implemented with the help of antlr (.g and .g4 files).
37
37
38
-
### Working on Plugins
38
+
## Enabling DevTools
39
+
40
+
To enable the Chrome DevTools for the Electron renderer processes, click "Settings" under "MongoDB Compass Dev Local" in the top menu (or press <kbd>⌘</kbd> + <kbd>,</kbd>) and click "Enable DevTools" followed by "Save", which will enable a "Toggle DevTools" item in the "View" top menu. Click this to toggle the DevTools panel (or press <kbd>⌥</kbd> + <kbd>⌘</kbd> + <kbd>I</kbd>).
41
+
42
+
## Working on Plugins
39
43
40
44
> [!NOTE]
41
45
> For documentation regarding how to write plugin packages, check out the
@@ -51,7 +55,7 @@ In addition to running lerna commands directly, there are a few convenient npm s
51
55
-`npm run test-changed` will run tests in all packages and their dependants changed since `origin/HEAD`.
52
56
-`npm run check-changed` will run `eslint` and `depcheck` validation in all packages (ignoring dependants) changed since `origin/HEAD`
53
57
54
-
###Building Compass Locally
58
+
## Building Compass Locally
55
59
56
60
To build compass you can run `package-compass` script:
57
61
@@ -83,7 +87,7 @@ To speed up the process you might want to disable creating installer for the app
83
87
HADRON_SKIP_INSTALLER=true npm run package-compass
84
88
```
85
89
86
-
###Publishing Packages
90
+
## Publishing Packages
87
91
88
92
Compass is built out of a number of different NPM packages. Since all the relevant code is bundled in the packaged version of Compass with webpack, it is not necessary to publish any package to build and run the Compass application.
89
93
@@ -95,13 +99,13 @@ Merging that PR will trigger another CI job that will publish to NPM any package
95
99
96
100
The version of packages is calculated following conventional bumps: See https://github.com/mongodb-js/devtools-shared/tree/main/packages/bump-monorepo-packages for details.
97
101
98
-
###Add / Update / Remove Dependencies in Packages
102
+
## Add / Update / Remove Dependencies in Packages
99
103
100
104
To add, remove, or update a dependency in any workspace you can use the usual `npm install` with a `--workspace` argument added, e.g. to add `react-aria` dependency to compass-aggregations and compass-query-bar plugins you can run `npm install --save react-aria --workspace @mongodb-js/compass-aggregations --workspace @mongodb-js/compass-query-bar`.
101
105
102
106
Additionally if you want to update a version of an existing dependency, but don't want to figure out the scope manually, you can use `npm run where` helper script. To update `webpack` in every package that has it as a dev dependency you can run `npm run where "devDependencies['webpack']" -- install --save-dev webpack@latest`
103
107
104
-
###Creating a New Workspace / Package
108
+
## Creating a New Workspace / Package
105
109
106
110
To create a new package please use the `create-workspace` npm script:
107
111
@@ -111,9 +115,9 @@ npm run create-workspace [workspace name]
111
115
112
116
This will do all the initial workspace bootstrapping for you, ensuring that your package has all the standard configs set up and ready, and all the npm scripts aligned with other packages in the monorepo, which is important to get the most out of all the provided helpers in this repository (like `npm run check-changed` commands or to make sure that your tests will not immediately fail in CI because of the test timeout being too small)
113
117
114
-
###Caveats
118
+
## Caveats
115
119
116
-
####`hdiutil: couldn't unmount "diskn" - Resource busy` or Similar `hdiutil` Errors
120
+
### `hdiutil: couldn't unmount "diskn" - Resource busy` or Similar `hdiutil` Errors
117
121
118
122
<!-- TODO: might go away after https://jira.mongodb.org/browse/COMPASS-4947 -->
119
123
@@ -123,7 +127,7 @@ Sometimes when trying to package compass on macOS you can run into the said erro
123
127
HADRON_SKIP_INSTALLER=true npm run test-package-compass
124
128
```
125
129
126
-
####`Module did not self-register` or `Module '<path>' was compiled against a different Node.js version` Errors
130
+
### `Module did not self-register` or `Module '<path>' was compiled against a different Node.js version` Errors
127
131
128
132
<!-- TODO: should go away after https://jira.mongodb.org/browse/COMPASS-4896 -->
Copy file name to clipboardExpand all lines: README.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,7 @@ Is there anything else you’d like to see in Compass? Let us know by submitting
50
50
-[**@mongodb-js/compass-logging**](packages/compass-logging): Shared helpers for logging in Compass packages
51
51
-[**@mongodb-js/compass-maybe-protect-connection-string**](packages/compass-maybe-protect-connection-string): Utility for protecting connection strings if requested
52
52
-[**@mongodb-js/compass-settings**](packages/compass-settings): Settings for compass
0 commit comments