This is the monorepo for the @ibnlanre/builder library and its documentation. It contains:
# Install dependencies
pnpm install
# Run tests
pnpm test
# Build the library
cd app && pnpm run bundle
# Start the docs dev server
cd docs && pnpm run devWorking on the library:
cd app
pnpm run test # Run tests
pnpm run typecheck # Type check
pnpm run lint # Lint code
pnpm run bundle # Build the libraryWorking on documentation:
cd docs
pnpm run dev # Start dev server
pnpm run build # Build for productionFor comprehensive guides, API references, and live examples, visit the official documentation:
The project uses Vitest for testing:
# Run all tests
pnpm test
# Run tests with coverage
pnpm run coverage
# Run tests in watch mode
cd app && pnpm run test -- --watchThe library is published to npm from the app/ directory:
cd app
# Patch version (1.0.0 → 1.0.1)
pnpm run patch
# Minor version (1.0.0 → 1.1.0)
pnpm run minor
# Major version (1.0.0 → 2.0.0)
pnpm run majorThe publish process automatically:
- Runs tests and type checking
- Builds the library
- Validates package exports with
@arethetypeswrong/cli - Publishes to npm
- Pushes git tags
Contributions are welcome! Please follow these guidelines:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Run tests (
pnpm test) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
The @ibnlanre/builder library is licensed under the MIT License.