Contributing

Contributions are welcome! This page covers everything you need to get the project running locally and submit changes.

Setup

Clone the repo and install root dependencies:

bun

git clone https://github.com/juleshry/vue-animejs.git
cd vue-animejs
bun install

npm

git clone https://github.com/juleshry/vue-animejs.git
cd vue-animejs
npm install

pnpm

git clone https://github.com/juleshry/vue-animejs.git
cd vue-animejs
pnpm install

yarn

git clone https://github.com/juleshry/vue-animejs.git
cd vue-animejs
yarn install

Playground

The playground is a standalone Vite app for manual testing. It has its own package.json and must be installed separately:

bun

cd playground
bun install && bun run playground:dev

npm

cd playground
npm install && npm run playground:dev

pnpm

cd playground
pnpm install && pnpm run playground:dev

yarn

cd playground
yarn install && yarn playground:dev

Docs

The documentation site (this site) is also a separate sub-project:

bun

cd docs
bun install && bun run docs:dev

npm

cd docs
npm install && npm run docs:dev

pnpm

cd docs
pnpm install && pnpm run docs:dev

yarn

cd docs
yarn install && yarn docs:dev

Tests

Unit tests live in tests/ and run with Vitest:

bun run test

Watch mode:

bun run test:watch

Coverage report:

bun run test:coverage

Adding a Composable

1. Create src/composables/use-my-feature.ts
2. Write the composable with full TypeScript types and JSDoc
3. Register cleanup in onUnmounted
4. Export it from src/index.ts
5. Test it manually in the playground
6. Add a doc page under docs/src/composables/use-my-feature.md

See the Documentation Rules for the expected page structure.

Code Style

Formatting is handled by oxfmt and linting by oxlint. Run both before committing:

bun run format
bun run lint

Format check only (used in CI):

bun run format:check

Key conventions:

• 2-space indentation, double quotes, no semicolons
• Local variables use snake_case; functions and parameters use camelCase
• Composable files: exports first, helpers below