Skip to content

zenobi-us/pi-ds

Repository files navigation

pi-ds

A TUI design system for pi-mono

Features

  • 🏗️ TypeScript-based TUI component architecture
  • 🔧 Mise task runner integration
  • 📦 Bun/npm build tooling
  • ✨ ESLint + Prettier formatting
  • 🧪 Vitest testing setup
  • 🚀 GitHub Actions CI/CD
  • 📝 Release automation with release-please

Usage

In your pi-mono extensions, ensure you have a package.json file set up. Then, install and import the design system:

bun add @zenobius/pi-ds
import { Grid, Flex, Sized, sized } from '@zenobius/pi-ds';

Development

  1. Clone this repository:

    git clone https://github.com/zenobi-us/pi-ds.git
    cd pi-ds
  2. Install dependencies:

    mise setup
  3. Implement your TUI components in src/{name}.ts:

  4. Test your components:

    mise run test #runs pi with a kitchen sink extension that uses the ds

Dev Commands

  • mise run build - Build the design system
  • mise run test - Run tests
  • mise run lint - Lint code
  • mise run lint:fix - Fix linting issues
  • mise run format - Format code with Prettier

Contributing

Contributions are welcome! Please file issues or submit pull requests on the GitHub repository.

License

MIT License. See the LICENSE file for details.

About

A tui design system for pi-mono

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •