Skip to content

Commit 33ab949

Browse files
Merge remote-tracking branch 'origin/main' into beta-releases
2 parents 02b83c3 + 4609f91 commit 33ab949

File tree

312 files changed

+5542
-2357
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

312 files changed

+5542
-2357
lines changed

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,4 @@ Ben Radcliffe <[email protected]>
8989
Betsy Button <[email protected]>
9090
Vivian Xiao <[email protected]>
9191
admin-token-bot <[email protected]>
92+
Kræn Hansen <[email protected]>

CONTRIBUTING.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,11 @@ This repository includes a few recommended plugins for your convenience:
3535
- ESLint extension highlights possible issues in your code following our common eslint configuration.
3636
- ANTLR4 grammar support extension helps to work with the `bson-transpilers` package that is implemented with the help of antlr (.g and .g4 files).
3737

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
3943

4044
> [!NOTE]
4145
> 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
5155
- `npm run test-changed` will run tests in all packages and their dependants changed since `origin/HEAD`.
5256
- `npm run check-changed` will run `eslint` and `depcheck` validation in all packages (ignoring dependants) changed since `origin/HEAD`
5357

54-
### Building Compass Locally
58+
## Building Compass Locally
5559

5660
To build compass you can run `package-compass` script:
5761

@@ -83,7 +87,7 @@ To speed up the process you might want to disable creating installer for the app
8387
HADRON_SKIP_INSTALLER=true npm run package-compass
8488
```
8589

86-
### Publishing Packages
90+
## Publishing Packages
8791

8892
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.
8993

@@ -95,13 +99,13 @@ Merging that PR will trigger another CI job that will publish to NPM any package
9599

96100
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.
97101

98-
### Add / Update / Remove Dependencies in Packages
102+
## Add / Update / Remove Dependencies in Packages
99103

100104
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`.
101105

102106
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`
103107

104-
### Creating a New Workspace / Package
108+
## Creating a New Workspace / Package
105109

106110
To create a new package please use the `create-workspace` npm script:
107111

@@ -111,9 +115,9 @@ npm run create-workspace [workspace name]
111115

112116
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)
113117

114-
### Caveats
118+
## Caveats
115119

116-
#### `hdiutil: couldn't unmount "diskn" - Resource busy` or Similar `hdiutil` Errors
120+
### `hdiutil: couldn't unmount "diskn" - Resource busy` or Similar `hdiutil` Errors
117121

118122
<!-- TODO: might go away after https://jira.mongodb.org/browse/COMPASS-4947 -->
119123

@@ -123,7 +127,7 @@ Sometimes when trying to package compass on macOS you can run into the said erro
123127
HADRON_SKIP_INSTALLER=true npm run test-package-compass
124128
```
125129

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
127131

128132
<!-- TODO: should go away after https://jira.mongodb.org/browse/COMPASS-4896 -->
129133

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Is there anything else you’d like to see in Compass? Let us know by submitting
5050
- [**@mongodb-js/compass-logging**](packages/compass-logging): Shared helpers for logging in Compass packages
5151
- [**@mongodb-js/compass-maybe-protect-connection-string**](packages/compass-maybe-protect-connection-string): Utility for protecting connection strings if requested
5252
- [**@mongodb-js/compass-settings**](packages/compass-settings): Settings for compass
53+
- [**@mongodb-js/compass-telemetry**](packages/compass-telemetry): Compass telemetry
5354
- [**@mongodb-js/compass-test-server**](packages/compass-test-server): Wrapper around mongodb-runner to manage test servers for Compass
5455
- [**@mongodb-js/compass-user-data**](packages/compass-user-data): undefined
5556
- [**@mongodb-js/compass-utils**](packages/compass-utils): Utilities for MongoDB Compass Development
@@ -62,6 +63,7 @@ Is there anything else you’d like to see in Compass? Let us know by submitting
6263
- [**@mongodb-js/databases-collections-list**](packages/databases-collections-list): List view for the databases and collections
6364
- [**@mongodb-js/explain-plan-helper**](packages/explain-plan-helper): Explain plan utility methods for MongoDB Compass
6465
- [**@mongodb-js/my-queries-storage**](packages/my-queries-storage): Saved aggregations and queries storage
66+
- [**@mongodb-js/reflux-state-mixin**](packages/reflux-state-mixin): Reflux stores mixin adding 'state' syntax similar to React components
6567
- [**bson-transpilers**](packages/bson-transpilers): Source to source compilers using ANTLR
6668
- [**compass-e2e-tests**](packages/compass-e2e-tests): E2E test suite for Compass app that follows smoke tests / feature testing matrix
6769
- [**compass-preferences-model**](packages/compass-preferences-model): Compass preferences model
@@ -83,6 +85,7 @@ Is there anything else you’d like to see in Compass? Let us know by submitting
8385
- [**@mongodb-js/eslint-plugin-compass**](configs/eslint-plugin-compass): Custom eslint rules for Compass monorepo
8486
- [**@mongodb-js/mocha-config-compass**](configs/mocha-config-compass): Shared mocha mocha configuration for Compass packages
8587
- [**@mongodb-js/prettier-config-compass**](configs/prettier-config-compass): Shared Compass prettier configuration
88+
- [**@mongodb-js/testing-library-compass**](configs/testing-library-compass): Compass unit testing utils
8689
- [**@mongodb-js/tsconfig-compass**](configs/tsconfig-compass): Shared Compass Typescript configuration
8790
- [**@mongodb-js/webpack-config-compass**](configs/webpack-config-compass): Shared webpack configuration for Compass application and plugins
8891

0 commit comments

Comments
 (0)