About SmooAI

SmooAI is a platform for building and deploying AI-powered apps.

Learn more on smoo.ai

About @smooai/library-template

A template repository for creating new SmooAI libraries with standardized tooling, configuration, and best practices.

Key Features

• 📦 Preconfigured development environment with TypeScript, ESLint, and Prettier
• 🧪 Testing setup with Vitest
• 🔄 Changesets for version management
• 📚 Integration with SmooAI core utilities

Dependencies

This template comes pre-configured with essential SmooAI packages:

@smooai/logger

A structured logging utility for SmooAI applications that provides:

• Standardized log formatting
• Log level management
• Integration with SmooAI's logging infrastructure

@smooai/utils

Common utility functions and helpers used across SmooAI applications.

Development Setup

1. Clone the repository
2. Install dependencies:

pnpm install

Available Scripts

• pnpm test - Run tests using Vitest
• pnpm build - Build the library using tsup
• pnpm lint - Run ESLint
• pnpm format - Format code with Prettier

Contributing

Contributions are welcome! This project uses changesets to manage versions and releases.

Development Workflow

1. Fork the repository

2. Create your branch (git checkout -b amazing-feature)

3. Make your changes

4. Add a changeset to document your changes:

   pnpm changeset

   This will prompt you to:

   • Choose the type of version bump (patch, minor, or major)
   • Provide a description of the changes

5. Commit your changes (git commit -m 'Add some amazing feature')

6. Push to the branch (git push origin feature/amazing-feature)

7. Open a Pull Request

Pull Request Guidelines

• Reference any related issues in your PR description

The maintainers will review your PR and may request changes before merging.

(back to top)

Contact

Brent Rager

• Email
• LinkedIn
• BlueSky
• TikTok
• Instagram

Smoo Github: https://github.com/SmooAI

(back to top)