+
+
+
-
-+ Shared TypeScript configs that keep type checking and compilation consistent across every Smoo AI project. +
- +
+ 
+ Features ยท + Install ยท + Usage ยท + Platform +
-SmooAI is an AI-powered platform for helping businesses multiply their customer, employee, and developer experience. +--- -Learn more on [smoo.ai](https://smoo.ai) +> A collection of internal TypeScript configurations used across Smoo AI projects. Extend one of these `tsconfig` presets and your project inherits the same strict, modern, monorepo-friendly compiler settings we use everywhere. Derived from `@turbo/config-typescript`. -## SmooAI Packages +## โจ Features -Check out other SmooAI packages at [npmjs.com/org/smooai](https://www.npmjs.com/org/smooai) - -## About @smooai/config-typescript - -Collection of internal TypeScript configurations used across SmooAI projects. This package provides standardized TypeScript configurations to ensure consistent type checking and compilation settings across all SmooAI repositories. - -Derived from `@turbo/config-typescript`. - - - - - - - - +- Standard TypeScript configurations tuned for Smoo AI projects +- Strict type checking enabled by default +- Modern JavaScript feature support +- Consistent settings across every repository +- Optimized for monorepo setups +- Presets available for: + - Node.js projects + - React applications + - Next.js applications + - Library packages -### Installation +## ๐ฆ Install ```sh pnpm add -D @smooai/config-typescript ``` -Note: This package has a peer dependency on TypeScript. Make sure you have TypeScript installed in your project: +This package has a peer dependency on TypeScript, so make sure it's installed too: ```sh pnpm add -D typescript ``` -### Usage +## ๐ Usage In your `tsconfig.json`: @@ -57,54 +61,32 @@ In your `tsconfig.json`: } ``` -### Features - -- Standard TypeScript configurations optimized for SmooAI projects -- Strict type checking enabled -- Modern JavaScript features support -- Consistent configuration across projects -- Optimized for monorepo setups -- Configurations available for: - - Node.js projects - - React applications - - Next.js applications - - Library packages - - +Swap `base.json` for the preset that matches your target (Node, React, Next.js, or library). -## Contributing +## ๐งฉ Part of Smoo AI -Contributions are welcome! This project uses [changesets](https://github.com/changesets/changesets) to manage versions and releases. +`@smooai/config-typescript` is part of the [Smoo AI](https://smoo.ai) platform โ an AI-powered business platform with AI built into every product. Browse the rest of our open-source packages at [npmjs.com/org/smooai](https://www.npmjs.com/org/smooai), including: -### Development Workflow +- [@smooai/config](https://github.com/SmooAI/config) โ type-safe config, secrets, and feature flags +- [@smooai/logger](https://github.com/SmooAI/logger) โ contextual logging for AWS and the browser +- [@smooai/fetch](https://github.com/SmooAI/fetch) โ resilient, type-safe HTTP client -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: +## ๐ค Contributing - ```sh - pnpm changeset - ``` +Contributions are welcome. This project uses [changesets](https://github.com/changesets/changesets) to manage versions and releases. - 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 +1. Fork the repository. +2. Create your branch (`git checkout -b amazing-feature`). +3. Make your changes. +4. Add a changeset to document them: `pnpm changeset` โ it prompts for the version bump type (patch, minor, or major) and a description. +5. Commit and push your branch. +6. Open a pull request, referencing any related issues. The maintainers will review your PR and may request changes before merging. - +## ๐ License - +MIT ยฉ SmooAI. See [LICENSE](LICENSE). ## Contact @@ -116,6 +98,10 @@ Brent Rager - [TikTok](https://www.tiktok.com/@brentragertech) - [Instagram](https://www.instagram.com/brentragertech/) -Smoo Github: [https://github.com/SmooAI](https://github.com/SmooAI) +Smoo GitHub: [github.com/SmooAI](https://github.com/SmooAI) + +--- - ++ Built by Smoo AI โ AI built into every product. +