Contributing & development
Skiller is an open-source VS Code extension on GitHub. Issues and pull requests are welcome. This page covers how to build it locally, run the tests, and open a clean PR.
Set up
Section titled “Set up”Clone the repo and install dependencies:
git clone https://github.com/tivaliy/skiller.gitcd skillernpm installSkiller compiles with esbuild. Use compile for a one-off dev build, or watch to rebuild on
every change while you work:
npm run compile # one-off dev build (esbuild)npm run watch # rebuild on changeRun the extension
Section titled “Run the extension”Press F5 in VS Code to launch an Extension Development Host — a second VS Code window
with your local build of Skiller loaded. Open the Chat view there and talk to @skiller to try your
changes against real skills. The built-in example skills (greeter, mind-reader) are available
immediately; drop your own under .skiller/skills/ in the host’s workspace to iterate.
Type-check
Section titled “Type-check”Two type-check scripts: one for the extension source, one that also includes the tests.
npm run typecheck # tsc --noEmit (src)npm run typecheck:test # tsc --noEmit (src + tests)Unit tests run on Vitest:
npm run test # run the suite oncenpm run test:watch # re-run on changenpm run test:ui # Vitest UIPackage
Section titled “Package”Build a .vsix you can install locally or attach to a release:
npm run package # build a .vsixInstall the result into your main VS Code with code --install-extension skiller-*.vsix, or run
npm run install-local to package and install in one step.
Opening a pull request
Section titled “Opening a pull request”Before you open a PR:
- Run
npm run typecheck:testandnpm run test— both must pass. - Keep changes focused and add tests for new behavior.
- Follow the existing code style and patterns.
License
Section titled “License”Skiller is licensed under the MIT License.