Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (20 loc) · 974 Bytes

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 974 Bytes
Raw

Contributing to Sherlock

This extension ships for multiple platforms (Windows/macOS/Linux), so please test on more than one OS when touching platform-specific behavior.

Getting started

Prerequisites

  • Node.js 22
  • pnpm

Setup

  1. Clone the repository: git clone git@github.com:opral/sherlock.git
  2. Install dependencies: pnpm install
  3. Build Sherlock: pnpm run build
  4. Run tests: pnpm test

Development

  • Run tests: pnpm test
  • Watch tests: pnpm test:watch
  • Start editor app dev server: pnpm run editor:dev
  • Package extension: pnpm run package

Debugging

Set an inlang project in your workspace and point the extension launcher at it via .vscode/launch.json (the args list).

Windows

  1. For executing the package scripts a Bash shell is needed. Install git and run npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe". This can be undone with npm config delete script-shell.