https://github.com/forcedotcom/soql-tooling
SOQL Language Tooling features including the Language Server and Query Builder UI.
https://github.com/forcedotcom/soql-tooling
Last synced: 4 months ago
JSON representation
SOQL Language Tooling features including the Language Server and Query Builder UI.
- Host: GitHub
- URL: https://github.com/forcedotcom/soql-tooling
- Owner: forcedotcom
- License: bsd-3-clause
- Created: 2020-07-21T19:41:07.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-14T17:18:57.000Z (about 2 years ago)
- Last Synced: 2025-06-06T09:15:56.942Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.79 MB
- Stars: 24
- Watchers: 6
- Forks: 8
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: docs/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# SOQL Tooling
## Introduction
This repo contains the source for SOQL Language Tooling features including:
- `soql-builder-ui`: SOQL Query Builder UI with [LWC](https://lwc.dev/)
- `soql-model`: SOQL queries internal model
- `soql-common`: SOQL common utility library. Shared by Query Builder and [Language Server](https://github.com/forcedotcom/soql-language-server)
- `soql-data-view`: Web assests for displaying SOQL Results
These packages are used from [Salesforce's SOQL VS Code extension](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode-soql) which lives in repo [salesforcedx-vscode](https://github.com/forcedotcom/salesforcedx-vscode).
## Development
If you are interested in contributing, please take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.
- Run `yarn` from the top-level directory to pull all dependencies and auto-link the local inter-dependencies between packages (i.e: `soql-builder-ui` depends on `soql-model`, which depends on `soql-common`).
- `yarn build` to compile and build
- `yarn run lint` to run static checks with eslint
- `yarn run test` to run automated tests
During development, you can work with a local copy of the `salesforcedx-vscode` repo and configure it to use your local build of packages in your `soql-tooling` repo using yarn/npm links. Example:
```
# Make global links available
cd soql-tooling
for P in packages/*; do cd $P; npm link; cd -; done
# Link to them from the VS Code SOQL extension package
cd salesforcedx-vscode/packages/salesforcedx-vscode-soql
npm install
npm link @salesforce/soql-builder-ui
```
With that in place, you can make changes to your soql-tooling packages, compile them, and then relaunch the whole `salesforcedx-vscode` extension from VSCode to see the changes.
### Debug Jest Test
You can debug Jest test for an individual package by running the corresponding launch configuraiton in VS Codes _RUN_ panel.