Contributing

Contributing

Clone the extension repo

git clone https://github.com/prasaddpathak/dbeagle.git
cd dbeagle
npm ci

Core build and validation commands

Command	Purpose
npm run build	Build the extension, native addon, and SQL parser in debug mode
npm run typecheck	Run the TypeScript typecheck
npm run lint	Run ESLint
npm run test:unit	Run the Vitest suite
npm run test:vscode	Run the Extension Development Host test suite
npm run test:integration:drivers	Run the Docker-backed driver integration suite
npm run test:baseline	Run the current shared validation baseline

Local development loop

1. Run npm run build.
2. Open the repo in VS Code.
3. Press F5 to launch an Extension Development Host.
4. Test the extension from that development window.

Local database targets

The repo includes reproducible local targets for the shipped drivers:

npm run test:local:up
npm run test:local:seed
npm run test:integration:drivers
npm run test:local:down

You can also bring drivers up and down individually with the test:local:<driver>:up|down|seed scripts.

Recommended checks before a PR

• Run npm run test:baseline
• Run npm run test:vscode for extension-host coverage
• Run npm run test:integration:drivers when changing driver behavior
• Manually verify the main user workflow in an Extension Development Host

Useful repo docs

• README.md
• DESIGN.md
• TESTING.md
• ROADMAP.md