MongoDB Compass Monorepo
This repository contains the source code and build tooling used in MongoDB Compass.
!Aggregation Pipeline Builder Tab in Compass
Contributing
For contributing, please refer to CONTRIBUTING.md
For issues, please create a ticket in our JIRA Project.
Is there anything else you’d like to see in Compass? Let us know by submitting suggestions in out feedback forum.
Packages Overview
- mongodb-compass: The MongoDB GUI
Compass Plugins
- @mongodb-js/compass-aggregations: Compass Aggregation Pipeline Builder
- @mongodb-js/compass-app-stores: The external stores repo for compass
- @mongodb-js/compass-collection: Compass Collection
- @mongodb-js/compass-crud: Compass Plugin for CRUD Operations
- @mongodb-js/compass-databases-collections: Plugin for viewing the list of, creating, and dropping databases and collections
- @mongodb-js/compass-explain-plan: Evaluate the performance of your query
- @mongodb-js/compass-export-to-language: Export MongoDB queries and aggregations to various languages
- @mongodb-js/compass-field-store: FieldStore keeps track of available fields in a collection
- @mongodb-js/compass-find-in-page: cmd-f UI for Compass
- @mongodb-js/compass-import-export: Import/Export feature for Compass
- @mongodb-js/compass-indexes: Collection index management for Compass
- @mongodb-js/compass-query-bar: Renders a component for executing MongoDB queries through a GUI
- @mongodb-js/compass-saved-aggregations-queries: Instance tab plugin that shows saved queries and aggregations
- @mongodb-js/compass-schema: Compass Schema Tab Plugin
- @mongodb-js/compass-schema-validation: Compass plugin for document JSON schema validation
- @mongodb-js/compass-serverstats: Compass Real Time
- @mongodb-js/compass-shell: Compass Shell Plugin
- @mongodb-js/compass-sidebar: The sidebar of Compass
Shared Libraries and Build Tools
- @mongodb-js/atlas-service: Service to handle Atlas sign in and API requests
- @mongodb-js/compass-app-registry: Compass App Registry
- @mongodb-js/compass-components: React Components used in Compass
- @mongodb-js/compass-connection-import-export: UI for Compass connection import/export
- @mongodb-js/compass-connections: Manage your MongoDB connections and connect in Compass
- @mongodb-js/compass-connections-navigation: Databases and collections sidebar navigation tree
- @mongodb-js/compass-context-menu: Context menu hooks and provider for Compass
- @mongodb-js/compass-data-modeling: Data modeling diagram workspace and all related services
- @mongodb-js/compass-editor: Reusable Compass editor component based on codemirror editor, themes, and autocompleters
- @mongodb-js/compass-generative-ai: Generative AI aspects for Compass
- @mongodb-js/compass-global-writes: Compass Global Sharding management
- @mongodb-js/compass-intercom: Intercom scripts and utils for Compass
- @mongodb-js/compass-logging: Shared helpers for logging in Compass packages
- @mongodb-js/compass-maybe-protect-connection-string: Utility for protecting connection strings if requested
- @mongodb-js/compass-settings: Settings for compass
- @mongodb-js/compass-smoke-tests: Smoke test suite for Compass app installers
- @mongodb-js/compass-telemetry: Compass telemetry
- @mongodb-js/compass-test-server: Wrapper around mongodb-runner to manage test servers for Compass
- @mongodb-js/compass-user-data: undefined
- @mongodb-js/compass-utils: Utilities for MongoDB Compass Development
- @mongodb-js/compass-web: Compass application packaged for the browser environment
- @mongodb-js/compass-welcome: The welcome modal
- @mongodb-js/compass-workspaces: Compass plugin responsible for rendering and managing state of current namespace / workspace
- @mongodb-js/connection-form: A form for specifying information needed to connect to a MongoDB instance
- @mongodb-js/connection-info: Types and utilites for connections agnostic of backend
- @mongodb-js/connection-storage: Compass connection storage
- @mongodb-js/databases-collections-list: List view for the databases and collections
- @mongodb-js/explain-plan-helper: Explain plan utility methods for MongoDB Compass
- @mongodb-js/my-queries-storage: Saved aggregations and queries storage
- @mongodb-js/reflux-state-mixin: Reflux stores mixin adding 'state' syntax similar to React components
- bson-transpilers: Source to source compilers using ANTLR
- compass-e2e-tests: E2E test suite for Compass app that follows smoke tests / feature testing matrix
- compass-preferences-model: Compass preferences model
- hadron-build: Tooling for Hadron apps like Compass
- hadron-document: Hadron Document
- hadron-ipc: Simplified IPC for electron apps.
- hadron-type-checker: Hadron Type Checker
- mongodb-collection-model: MongoDB collection model
- mongodb-data-service: MongoDB Data Service
- mongodb-database-model: MongoDB database model
- mongodb-explain-compat: Convert mongodb SBE explain output to 4.4 explain output
- mongodb-instance-model: MongoDB instance model
- mongodb-query-util: Utilty Functions for MongoDB Query Functionality
Shared Configuration Files
- @mongodb-js/eslint-config-compass: Shared Compass eslint configuration
- @mongodb-js/eslint-plugin-compass: Custom eslint rules for Compass monorepo
- @mongodb-js/mocha-config-compass: Shared mocha mocha configuration for Compass packages
- @mongodb-js/prettier-config-compass: Shared Compass prettier configuration
- @mongodb-js/testing-library-compass: Compass unit testing utils
- @mongodb-js/tsconfig-compass: Shared Compass Typescript configuration
- @mongodb-js/webpack-config-compass: Shared webpack configuration for Compass application and plugins