Skip to content

kumixlabs/config

Repository files navigation

Kumix Config

License: MIT Bun

A collection of ready-to-use packages for modern application development. This monorepo includes reusable packages for shared linting and TypeScript configurations.

Packages

Package Version Description
@kumix/biome-config npm Opinionated Biome config for lint/format
@kumix/eslint-config npm Shared ESLint configuration
@kumix/eslint-config-react npm ESLint configuration for React
@kumix/eslint-config-vite npm ESLint configuration for Vite
@kumix/tsconfig npm Extendable TypeScript configuration presets

Tech Stack

  • Package Manager: Bun
  • Monorepo Tool: Turborepo
  • Build Tool: TypeScript compiler (tsc)
  • Linting/Formatting: Biome
  • Testing: Vitest
  • Language: TypeScript

Getting Started

Prerequisites

  • Bun 1.3.0 or higher
  • Node.js 24 or higher

Installation

# Clone repository
git clone https://github.com/kumixlabs/config.git
cd config

# Install dependencies (Bun)
bun install

Common Commands

# Development
bun run dev                # Run all packages (watch mode)
bun run build              # Build all packages
bun run types:check        # Type-check all packages

# Linting & Formatting (Biome)
bun run lint               # Lint with safe fixes
bun run lint:fix           # Lint with comprehensive fixes
bun run format             # Format code

# Testing (Vitest, via Turborepo — builds deps first)
bun run test                          # Run all tests
bun run test:coverage                 # Run tests with V8 coverage
bunx turbo run test --filter=@kumix/eslint-config  # Run one package's tests

# Maintenance
bun run clean:all          # Deep clean (.turbo, bun.lock, coverage, node_modules)

Note: bun run test goes through turbo run test, so dependencies are built first (dependsOn: ["^build"]).

Working on Individual Packages

# Navigate to a specific package
cd packages/eslint-config  # or any package under packages/

# Package commands (available scripts vary per package)
bun run build              # Build the package (tsc)
bun run types:check        # Type-check the package

Development Workflow

  1. Create a branch for your changes
  2. Make your changes in the appropriate package(s)
  3. Run tests and type-check: bun run test && bun run types:check
  4. Format your code: bun run format && bun run lint:fix
  5. Commit your changes following conventional commits
  6. Submit a pull request

For detailed contribution guidelines, see CONTRIBUTING.md.

Contributing

We welcome contributions! This project is community-driven and your help makes it better.

Getting Started:

Security

If you discover a security vulnerability, please email hai@kumix.io. All vulnerabilities will be addressed promptly.

Do not report security issues through public GitHub issues.

License

MIT License — see LICENSE for details.

By contributing to Kumix Config, you agree that your contributions will be licensed under the MIT License.

About

Shared configuration packages for modern TypeScript projects — Biome, ESLint (base/React/Vite), and tsconfig presets.

Resources

License

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Sponsor this project

Packages

 
 
 

Contributors

Generated from kumixlabs/template