@codefast/typescript-config 0.3.6 → 0.3.7-canary.1

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @codefast/typescript-config
 
+## 0.3.7-canary.1
+
+### Patch Changes
+
+- [`345eb36`](https://github.com/codefastlabs/codefast/commit/345eb368a1e44051e215c0e74a255bb8bf7cca76) Thanks [@thevuong](https://github.com/thevuong)! - chore(cli): implement CLI framework with initial commands and adapters
+
+- [`d5d8343`](https://github.com/codefastlabs/codefast/commit/d5d83431d97f433f9dd5d1c745bd35f163573ad2) Thanks [@thevuong](https://github.com/thevuong)! - chore(ui): replace `tw-animate-css` with `@tailwindcss/typography` for improved styling capabilities
+
+- [`0c0ae47`](https://github.com/codefastlabs/codefast/commit/0c0ae47e822ca82609d5e2dfe55629387ec88df1) Thanks [@thevuong](https://github.com/thevuong)! - chore(ui): update animations and dependencies for improved consistency
+
+## 0.3.7-canary.0
+
+### Patch Changes
+
+- [`e66e9ac`](https://github.com/codefastlabs/codefast/commit/e66e9ac1186a94cb30d83d7125d4991ee91c7a41) Thanks [@thevuong](https://github.com/thevuong)! - refactor: improve readability and naming consistency across multiple packages
+
+- [`c98a4f3`](https://github.com/codefastlabs/codefast/commit/c98a4f3c821039557205fdb0fc4b5a55d8b81944) Thanks [@thevuong](https://github.com/thevuong)! - chore(dependencies): update multiple dependencies to latest versions
+
+- [`161717d`](https://github.com/codefastlabs/codefast/commit/161717db82457444b793bad252099084ef490085) Thanks [@thevuong](https://github.com/thevuong)! - feat(eslint-config): strengthen unicorn and TypeScript rule configurations
+
+- [`dea11de`](https://github.com/codefastlabs/codefast/commit/dea11deef4cab04a9ed2cd411251f6ad939acba6) Thanks [@thevuong](https://github.com/thevuong)! - chore(ui): integrate `tw-animate-css` and enhance animation easing consistency
+
+- [`2f0fd79`](https://github.com/codefastlabs/codefast/commit/2f0fd791d1505279a9c8570f8f3fddcf058d64ee) Thanks [@thevuong](https://github.com/thevuong)! - chore: reorder imports for consistency and clarity
+
+- [`728b150`](https://github.com/codefastlabs/codefast/commit/728b1503583d1f130c2f0abd503343dd8c802ee6) Thanks [@thevuong](https://github.com/thevuong)! - chore(tests): remove obsolete test files for core use cases and adapters
+
 ## 0.3.6
 
 ### Patch Changes
@@ -846,7 +872,7 @@
 
 - [#37](https://github.com/codefastlabs/codefast/pull/37) [`76aa08d`](https://github.com/codefastlabs/codefast/commit/76aa08dd12f143223d88d30c72e7b8677e9808fc) Thanks [@thevuong](https://github.com/thevuong)! - feat(day-picker): support start and end month constraints
 
-- [#37](https://github.com/codefastlabs/codefast/pull/37) [`abde741`](https://github.com/codefastlabs/codefast/commit/abde741acf18523884da7fd98ed3e8a6379bcac4) Thanks [@thevuong](https://github.com/thevuong)! - fix(day-picker): update role query from 'cell' to 'gridcell'
+- [#37](https://github.com/codefastlabs/codefast/pull/37) [`abde741`](https://github.com/codefastlabs/codefast/commit/abde741acf18523884da7fd98ed3e8a6379bcac4) Thanks [@thevuong](https://github.com/thevuong)! - fix(day-picker): update role query from "cell" to "gridcell"
 
 - [#37](https://github.com/codefastlabs/codefast/pull/37) [`00167ec`](https://github.com/codefastlabs/codefast/commit/00167ec8ca7c04911d3c8844c5172f1765aede9f) Thanks [@thevuong](https://github.com/thevuong)! - refactor(style): improve CSS variable formatting
 
@@ -1160,7 +1186,7 @@
 
 ### Patch Changes
 
-- Remove 'use client' directive from components
+- Remove "use client" directive from components
 
 ## 0.1.15
 

package/README.md

@@ -1,337 +1,273 @@
-# @codefast/typescript-config
+# TypeScript Config
 
-Shared TypeScript configuration presets for the CodeFast monorepo, providing consistent and optimized TypeScript settings across different project types including libraries, React applications, and Next.js projects.
+Shared TypeScript configuration presets for the CodeFast monorepo, providing standardized TypeScript settings for different project types including React applications, Next.js projects, libraries, and base configurations.
 
-## Features
-
-- 🎯 **Multiple Presets** - Tailored configurations for different project types
-- 🏗️ **Extensible Base** - Common base configuration with specialized extensions
-- ⚡ **Modern Standards** - Latest TypeScript features and best practices
-- 🔧 **Strict Configuration** - Enhanced type safety and code quality
-- 📦 **Monorepo Optimized** - Designed for monorepo development workflows
-- 🚀 **Performance Focused** - Optimized compiler options for fast builds
-
-## Available Configurations
-
-### Base Configuration (`base.json`)
-
-Foundational TypeScript configuration with strict settings and modern ES features:
-
-- ES2022 target with ESNext modules
-- Strict type checking enabled
-- Declaration files and source maps
-- Optimized for development and production builds
-
-### Library Configuration (`library.json`)
-
-Extends base configuration for library development:
-
-- Composite builds support
-- Incremental compilation
-- Source maps and declaration maps
-- Internal type stripping for clean APIs
-
-### React Configuration (`react.json`)
-
-Optimized for React components and applications:
-
-- React JSX transform (`react-jsx`)
-- React as JSX import source
-- ES2020 target for modern React features
-- Source maps for debugging
-
-### Next.js Configuration (`next.json`)
-
-Tailored for Next.js applications:
-
-- Next.js plugin integration
-- JSX preserve mode
-- JavaScript file support
-- ES2018 target for Next.js compatibility
-- No emit (Next.js handles compilation)
+![NPM Version](https://img.shields.io/npm/v/@codefast/typescript-config.svg)
 
 ## Installation
 
+Install the package via pnpm (recommended):
+
 ```bash
-# Using pnpm (recommended)
 pnpm add -D @codefast/typescript-config
+```
 
-# Using npm
-npm install --save-dev @codefast/typescript-config
+Or using npm:
 
-# Using yarn
-yarn add -D @codefast/typescript-config
+```bash
+npm install --save-dev @codefast/typescript-config
 ```
 
-## Usage
+**Requirements**:
 
-### For Libraries
+- Node.js version 20.0.0 or higher
+- TypeScript version 5.0.0 or higher
 
-Create a `tsconfig.json` in your library package:
+## Quick Start
+
+Create a `tsconfig.json` file in your project and extend from the appropriate configuration:
 
 ```json
 {
-  "extends": "@codefast/typescript-config/library.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": "./src"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["dist", "node_modules", "**/*.test.ts", "**/*.spec.ts"]
+  "extends": "@codefast/typescript-config/base.json"
 }
 ```
 
-### For React Applications
+## Usage
+
+### Base Configuration
 
-Create a `tsconfig.json` for React projects:
+Basic configuration for all TypeScript projects:
 
 ```json
 {
-  "extends": "@codefast/typescript-config/react.json",
+  "extends": "@codefast/typescript-config/base.json",
   "compilerOptions": {
-    "paths": {
-      "@/*": ["./src/*"]
-    }
+    "outDir": "./dist"
   },
   "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist", "build"]
+  "exclude": ["node_modules", "dist"]
 }
 ```
 
-### For Next.js Applications
+### Library Configuration
 
-Create a `tsconfig.json` for Next.js projects:
+For developing libraries and packages:
 
 ```json
 {
-  "extends": "@codefast/typescript-config/next.json",
+  "extends": "@codefast/typescript-config/library.json",
   "compilerOptions": {
-    "paths": {
-      "@/*": ["./src/*"]
-    }
+    "outDir": "./dist",
+    "declarationDir": "./dist/types"
   },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
-  "exclude": ["node_modules"]
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts"]
 }
 ```
 
-### For Custom Configurations
+### React Configuration
 
-You can extend the base configuration and customize it:
+For React components and applications:
 
 ```json
 {
-  "extends": "@codefast/typescript-config/base.json",
+  "extends": "@codefast/typescript-config/react.json",
   "compilerOptions": {
-    "outDir": "./build",
-    "rootDir": "./src",
-    "paths": {
-      "@/*": ["./src/*"],
-      "@components/*": ["./src/components/*"]
-    }
+    "outDir": "./dist"
   },
   "include": ["src/**/*"],
-  "exclude": ["node_modules", "build", "**/*.test.ts"]
+  "exclude": ["node_modules", "dist"]
 }
 ```
 
-## Build Configuration
+### Next.js Configuration
 
-For build-specific configurations, create a separate `tsconfig.build.json`:
+For Next.js applications:
 
 ```json
 {
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "noEmit": false,
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true
-  },
-  "exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.spec.ts", "**/*.stories.ts"]
+  "extends": "@codefast/typescript-config/next.json",
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts"
+  ],
+  "exclude": ["node_modules"]
 }
 ```
 
-## Configuration Details
-
-### Compiler Options Explained
-
-This section explains the meaning and purpose of each TypeScript compiler option used across our configurations.
-
-#### Base Configuration Options (`base.json`)
-
-**Module and Import Settings:**
-
-- `allowImportingTsExtensions: false` - Prevents importing TypeScript files with `.ts` extensions, enforcing proper module resolution
-- `allowSyntheticDefaultImports: true` - Allows default imports from modules without default exports (e.g., `import React from 'react'`)
-- `esModuleInterop: true` - Enables interoperability between CommonJS and ES modules, making imports more intuitive
-- `module: "ESNext"` - Uses the latest ECMAScript module system for modern bundlers
-- `moduleDetection: "force"` - Forces TypeScript to treat all files as modules, preventing global scope pollution
-- `moduleResolution: "node"` - Uses Node.js-style module resolution for better compatibility with Node.js and npm packages
-- `resolveJsonModule: true` - Allows importing JSON files as modules with type safety
-
-**Type Checking and Safety:**
-
-- `strict: true` - Enables all strict type checking options for maximum type safety
-- `noImplicitReturns: true` - Ensures all code paths in functions return a value when a return type is specified
-- `noImplicitOverride: true` - Requires explicit `override` keyword when overriding base class methods
-- `noFallthroughCasesInSwitch: true` - Prevents accidental fallthrough in switch statements
-- `noUnusedLocals: true` - Reports errors for unused local variables
-- `noUnusedParameters: true` - Reports errors for unused function parameters
-- `forceConsistentCasingInFileNames: true` - Ensures consistent file name casing across different operating systems
-
-**Output and Declaration:**
-
-- `declaration: true` - Generates `.d.ts` declaration files for type definitions
-- `declarationMap: true` - Creates source maps for declaration files, enabling "Go to Definition" in editors
-- `incremental: false` - Disables incremental compilation in base config (overridden in specific configs)
-- `noEmitOnError: true` - Prevents emitting JavaScript files when TypeScript errors are present
+## Configurations
 
-**Language Features:**
+### Available Configurations
 
-- `target: "ES2022"` - Compiles to ES2022, supporting modern JavaScript features
-- `lib: ["DOM", "DOM.Iterable", "ESNext"]` - Includes type definitions for DOM APIs and latest ECMAScript features
-- `isolatedModules: true` - Ensures each file can be transpiled independently (required for tools like Babel)
-- `useDefineForClassFields: true` - Uses ECMAScript standard behavior for class field declarations
-- `verbatimModuleSyntax: false` - Allows TypeScript to transform import/export syntax for better compatibility
+| Configuration | Description | Use Case |
+|---------------|-------------|----------|
+| `base.json` | Basic configuration with strict settings | Base for all projects |
+| `library.json` | Extends base, adds library-specific options | NPM packages, shared libraries |
+| `react.json` | Extends base, adds React JSX support | React components and apps |
+| `next.json` | Extends base, optimized for Next.js | Next.js applications |
 
-**Performance and Optimization:**
+### Base Configuration Features
 
-- `skipLibCheck: true` - Skips type checking of declaration files for faster compilation
+- **Strict Type Checking**: Enables all strict options
+- **Modern JavaScript**: Targets ESNext with full ESNext lib support
+- **Module Resolution**: Node-style resolution with ESNext modules
+- **Developer Experience**: Force consistent casing, no unused variables/parameters
+- **JSON Support**: Resolve JSON modules
+- **Isolated Modules**: Transpile each file separately
 
-#### Library Configuration Options (`library.json`)
+### Library Configuration Features
 
-**Build System:**
+- **Declaration Generation**: Automatically generates `.d.ts` files
+- **Source Maps**: Generate source maps for debugging
+- **Strip Internal**: Remove internal declarations from output
+- **ESNext Only**: Does not include DOM libs
 
-- `composite: true` - Enables TypeScript project references for monorepo builds and incremental compilation
-- `incremental: true` - Enables incremental compilation for faster subsequent builds
-- `sourceMap: true` - Generates source maps for debugging compiled JavaScript
+### React Configuration Features
 
-**Output Control:**
+- **Modern JSX Transform**: Uses `react-jsx` transform
+- **React Import Source**: Automatically import React when needed
+- **DOM Support**: Full DOM and DOM.Iterable libs
 
-- `noEmit: false` - Allows emitting JavaScript files (overrides base config for library builds)
-- `removeComments: false` - Preserves comments in output for better debugging experience
-- `stripInternal: true` - Removes types marked with `@internal` from declaration files, creating cleaner public APIs
+### Next.js Configuration Features
 
-**Library-Specific:**
+- **JavaScript Support**: Allow `.js` files
+- **Incremental Compilation**: Faster subsequent builds
+- **JSX Preserve**: Let Next.js handle JSX transform
+- **Bundler Resolution**: Optimized for bundler
+- **No Emit**: Next.js handles compilation
+- **Next.js Plugin**: TypeScript plugin support
 
-- `lib: ["ESNext"]` - Only includes ESNext types (removes DOM types for Node.js libraries)
+## API Reference
 
-#### React Configuration Options (`react.json`)
+### Configuration Files
 
-**JSX Processing:**
+#### `base.json`
 
-- `jsx: "react-jsx"` - Uses the modern React JSX transform (no need to import React in every file)
-- `jsxImportSource: "react"` - Specifies React as the source for JSX runtime functions
+Base configuration with essential compiler options:
 
-**Build Settings:**
-
-- `target: "ES2020"` - Targets ES2020 for modern React applications
-- `moduleResolution: "node"` - Uses Node.js-style module resolution for better compatibility with npm packages
-- `noEmit: false` - Allows emitting files for React builds
-- `sourceMap: true` - Enables source maps for debugging React components
-
-#### Next.js Configuration Options (`next.json`)
-
-**Next.js Integration:**
-
-- `allowJs: true` - Allows JavaScript files alongside TypeScript in Next.js projects
-- `jsx: "preserve"` - Preserves JSX syntax for Next.js to handle during its compilation process
-- `plugins: [{"name": "next"}]` - Integrates Next.js TypeScript plugin for enhanced IDE support
-- `noEmit: true` - Prevents TypeScript from emitting files (Next.js handles compilation)
-
-**Compatibility:**
-
-- `target: "ES2018"` - Targets ES2018 for broader browser compatibility in Next.js apps
-- `moduleResolution: "node"` - Uses Node.js-style module resolution for better compatibility with npm packages
-- `incremental: true` - Enables incremental compilation for faster Next.js development builds
-
-### Configuration Inheritance
+```typescript
+interface BaseConfig {
+  compilerOptions: {
+    allowSyntheticDefaultImports: true;
+    declaration: true;
+    esModuleInterop: true;
+    forceConsistentCasingInFileNames: true;
+    isolatedModules: true;
+    lib: ["DOM", "DOM.Iterable", "ESNext"];
+    module: "ESNext";
+    moduleDetection: "force";
+    moduleResolution: "node";
+    noEmitOnError: true;
+    noFallthroughCasesInSwitch: true;
+    noImplicitOverride: true;
+    noImplicitReturns: true;
+    noUnusedLocals: true;
+    noUnusedParameters: true;
+    resolveJsonModule: true;
+    skipLibCheck: true;
+    strict: true;
+    target: "ESNext";
+    useDefineForClassFields: true;
+  };
+}
+```
 
-Each configuration extends the base configuration and overrides specific options:
+#### `library.json`
 
-- **Library** extends base + adds composite builds, source maps, and library-specific optimizations
-- **React** extends base + adds JSX support and React-specific settings
-- **Next.js** extends base + adds Next.js plugin integration and framework-specific optimizations
+Library-specific configuration extending base:
 
-## Best Practices
+```typescript
+interface LibraryConfig extends BaseConfig {
+  compilerOptions: BaseConfig["compilerOptions"] & {
+    declaration: true;
+    lib: ["ESNext"];
+    sourceMap: true;
+    stripInternal: true;
+  };
+}
+```
 
-### Monorepo Setup
+#### `react.json`
 
-For monorepo packages, use project references in your root `tsconfig.json`:
+React-specific configuration:
 
-```json
-{
-  "files": [],
-  "references": [
-    {
-      "path": "./packages/ui"
-    },
-    {
-      "path": "./packages/hooks"
-    },
-    {
-      "path": "./apps/docs"
-    }
-  ]
+```typescript
+interface ReactConfig extends BaseConfig {
+  compilerOptions: BaseConfig["compilerOptions"] & {
+    jsx: "react-jsx";
+    jsxImportSource: "react";
+  };
 }
 ```
 
-### Path Mapping
+#### `next.json`
 
-Configure consistent path mapping across your projects:
+Next.js-specific configuration:
 
-```json
-{
-  "compilerOptions": {
-    "paths": {
-      "@/*": ["./src/*"],
-      "@/components/*": ["./src/components/*"],
-      "@/utils/*": ["./src/utils/*"],
-      "@/types/*": ["./src/types/*"]
-    }
-  }
+```typescript
+interface NextConfig extends BaseConfig {
+  compilerOptions: BaseConfig["compilerOptions"] & {
+    allowJs: true;
+    incremental: true;
+    jsx: "preserve";
+    moduleResolution: "bundler";
+    noEmit: true;
+    plugins: [{ name: "next" }];
+  };
 }
 ```
 
-### Development vs Production
+## Contributing
 
-Use different configurations for development and production builds:
+We welcome all contributions! To start developing:
 
-```json5
-// tsconfig.dev.json
-{
-  extends: "./tsconfig.json",
-  compilerOptions: {
-    incremental: true,
-    tsBuildInfoFile: ".tsbuildinfo",
-  },
-}
-```
+### Environment Setup
 
-## Troubleshooting
+1. Fork this repository.
+2. Clone to your machine: `git clone <your-fork-url>`
+3. Install dependencies: `pnpm install`
+4. Create a new branch: `git checkout -b feature/feature-name`
 
-### Common Issues
+### Development Workflow
 
-1. **Module Resolution Errors**: Ensure `moduleResolution` is set to `"node"` for better npm package compatibility
-2. **JSX Errors**: Use the appropriate preset (`react.json` or `next.json`) for JSX projects
-3. **Declaration Errors**: Check that `declaration` is enabled for library builds
-4. **Path Mapping**: Verify `baseUrl` and `paths` are correctly configured
+```bash
+# Build all packages
+pnpm build:packages
 
-### Performance Tips
+# Development mode for typescript-config
+pnpm dev --filter=@codefast/typescript-config
 
-- Use `incremental: true` for faster subsequent builds
-- Enable `composite: true` for project references in monorepos
-- Use `skipLibCheck: true` to skip type checking of declaration files
+# Run tests
+pnpm test --filter=@codefast/typescript-config
 
-## Contributing
+# Lint and format
+pnpm lint:fix
+pnpm format
+```
+
+5. Commit and submit pull request.
 
-This package is part of the CodeFast monorepo. For contributions, please refer to the main repository guidelines.
+See details at [CONTRIBUTING.md](../../CONTRIBUTING.md).
 
 ## License
 
-MIT License - see the [LICENSE](../../LICENSE) file for details.
+Distributed under the MIT License. See [LICENSE](../../LICENSE) for more information.
+
+## Contact
+
+- npm: [@codefast/typescript-config](https://www.npmjs.com/package/@codefast/typescript-config)
+- GitHub: [codefastlabs/codefast](https://github.com/codefastlabs/codefast)
+- Issues: [GitHub Issues](https://github.com/codefastlabs/codefast/issues)
+- Documentation: [TypeScript Config Docs](https://github.com/codefastlabs/codefast/tree/main/packages/typescript-config)
+
+## Compatibility
 
----
+This package is compatible with:
 
-**@codefast/typescript-config** provides the foundation for consistent TypeScript development across the CodeFast ecosystem.
+- **TypeScript**: 5.0.0+
+- **Node.js**: 20.0.0+
+- **React**: 18.0.0+ (when using react.json)
+- **Next.js**: 14.0.0+ (when using next.json)

package/base.json

@@ -1,13 +1,10 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    "allowImportingTsExtensions": false,
     "allowSyntheticDefaultImports": true,
     "declaration": true,
-    "declarationMap": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
-    "incremental": false,
     "isolatedModules": true,
     "lib": ["DOM", "DOM.Iterable", "ESNext"],
     "module": "ESNext",
@@ -22,9 +19,8 @@
     "resolveJsonModule": true,
     "skipLibCheck": true,
     "strict": true,
-    "target": "ES2022",
-    "useDefineForClassFields": true,
-    "verbatimModuleSyntax": false
+    "target": "ESNext",
+    "useDefineForClassFields": true
   },
   "display": "Base configuration for monorepo packages"
 }

package/library.json

@@ -1,13 +1,8 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    "composite": true,
     "declaration": true,
-    "declarationMap": true,
-    "incremental": true,
     "lib": ["ESNext"],
-    "noEmit": false,
-    "removeComments": false,
     "sourceMap": true,
     "stripInternal": true
   },

package/next.json

@@ -4,17 +4,13 @@
     "allowJs": true,
     "incremental": true,
     "jsx": "preserve",
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "module": "ESNext",
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
     "noEmit": true,
     "plugins": [
       {
         "name": "next"
       }
-    ],
-    "resolveJsonModule": true,
-    "target": "ES2018"
+    ]
   },
   "display": "Next.js application configuration",
   "extends": "./base.json"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codefast/typescript-config",
-  "version": "0.3.6",
+  "version": "0.3.7-canary.1",
   "description": "Shared TypeScript configuration for the monorepo",
   "keywords": [
     "typescript",
@@ -24,7 +24,6 @@
   },
   "license": "MIT",
   "author": "Vuong Phan <mr.thevuong@gmail.com>",
-  "sideEffects": false,
   "exports": {
     "./base.json": "./base.json",
     "./library.json": "./library.json",

package/react.json

@@ -2,12 +2,7 @@
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
     "jsx": "react-jsx",
-    "jsxImportSource": "react",
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "moduleResolution": "node",
-    "noEmit": false,
-    "sourceMap": true,
-    "target": "ES2020"
+    "jsxImportSource": "react"
   },
   "display": "React component and application configuration",
   "extends": "./base.json"