@orsetra/shared-config

Shared configuration files for Orsetra platform projects.

Installation

npm install @orsetra/shared-config
# or
pnpm add @orsetra/shared-config
# or
yarn add @orsetra/shared-config

Peer Dependencies

npm install tailwindcss

Usage

Tailwind CSS Configuration

Extend the shared Tailwind configuration in your tailwind.config.ts:

import type { Config } from 'tailwindcss'
import sharedConfig from '@orsetra/shared-config/tailwind'

const config: Config = {
  ...sharedConfig,
  content: [
    './app/**/*.{js,ts,jsx,tsx,mdx}',
    './components/**/*.{js,ts,jsx,tsx,mdx}',
    './node_modules/@orsetra/shared-ui/**/*.{js,ts,jsx,tsx}',
  ],
}

export default config

TypeScript Configuration

Extend the shared TypeScript configuration in your tsconfig.json:

{
  "extends": "@orsetra/shared-config/typescript",
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["./app/*"]
    }
  }
}

What's Included

Tailwind Configuration

• Design tokens - Colors, spacing, typography
• Custom utilities - Additional Tailwind utilities
• Plugin configuration - Pre-configured Tailwind plugins
• Theme - Consistent design system

TypeScript Configuration

• Strict mode - Enabled for type safety
• Module resolution - Configured for modern bundlers
• JSX support - React JSX configuration
• Path aliases - Common path alias patterns

Customization

You can override any configuration by spreading the shared config and adding your own settings:

import sharedConfig from '@orsetra/shared-config/tailwind'

export default {
  ...sharedConfig,
  theme: {
    ...sharedConfig.theme,
    extend: {
      ...sharedConfig.theme.extend,
      colors: {
        ...sharedConfig.theme.extend.colors,
        brand: '#your-color',
      },
    },
  },
}

License

MIT

Repository

GitHub