DEVELOPER.md

Developer Guide

For documentation on developing modules, please see the website

To develop Companion itself (aka core Companion, i.e. this repo), start here

TL;DR

For core Companion:

yarn install
yarn dev

Connect to it at http://localhost:8000/

Optionally, in another terminal:

# Run front end in dev mode for auto-refresh
yarn dev:webui

Connect to it at http://localhost:5173/

Environment configuration

A .env file in the root of the repository can be used to customise the dev environment. Copy .env.example to get started:

cp .env.example .env

See .env.example for descriptions of available settings.

Testing

Unit tests are written with Vitest.

# Run all tests
yarn test --run

# Run tests in watch mode
yarn test

Storybook

The webui has a Storybook for developing and visually reviewing UI components in isolation.

yarn dev:storybook

Connect to it at http://localhost:6006/

Linting and formatting

The project uses ESLint for linting and Prettier for formatting. Both are enforced via a pre-commit hook (husky + lint-staged), so code will be checked automatically before each commit.

To run them manually:

# Check for lint errors
yarn lint

# Format all files
yarn format

Type checking

TypeScript types across all packages can be checked without running the full build:

yarn check-types

Docs

The documentation is built with Docusaurus and lives in the docs/ package. The same content is bundled into Companion and published at https://companion.free.

yarn dev:docs

Connect to it at http://localhost:4000/