@elizaos/config

Shared configuration package for ElizaOS projects and plugins. This package provides standardized TypeScript, ESLint, and Prettier configurations to ensure consistency across the ElizaOS ecosystem.

Overview

This package centralizes common development configurations used throughout ElizaOS, making it easy to maintain consistent code style, linting rules, and TypeScript settings across all packages and plugins.

Installation

bun add -d @elizaos/config

Available Configurations

TypeScript Configurations

• Base Config (tsconfig.base.json): Core TypeScript settings for all ElizaOS packages
• Plugin Config (tsconfig.plugin.json): Extends base config with plugin-specific settings
• Frontend Config (tsconfig.frontend.json): For frontend/client-side packages
• Test Config (tsconfig.test.json): Optimized for test files

ESLint Configurations

• Base Config (eslint.config.base.js): Core linting rules and settings
• Plugin Config (eslint.config.plugin.js): ESLint configuration for plugins
• Frontend Config (eslint.config.frontend.js): ESLint rules for frontend code

Prettier Configuration

• Prettier Config (prettier.config.js): Standard code formatting rules

Usage

TypeScript Configuration

In your tsconfig.json:

{
  "extends": "@elizaos/config/typescript/tsconfig.base.json",
  "compilerOptions": {
    "outDir": "./dist",
    "rootDir": "./src"
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

For plugins, extend the plugin-specific config:

{
  "extends": "@elizaos/config/typescript/tsconfig.plugin.json"
}

ESLint Configuration

Create an eslint.config.js file:

import pluginConfig from '@elizaos/config/eslint/eslint.config.plugin.js';

export default [
  ...pluginConfig,
  {
    // Your custom rules here
  },
];

Prettier Configuration

Create a prettier.config.js file:

import prettierConfig from '@elizaos/config/prettier/prettier.config.js';

export default {
  ...prettierConfig,
  // Your custom overrides here
};

Or reference it directly in package.json:

{
  "prettier": "@elizaos/config/prettier/prettier.config.js"
}

Exports

The package provides the following exports for direct import:

// TypeScript configs
import tsConfigBase from '@elizaos/config/typescript/tsconfig.base.json';
import tsConfigPlugin from '@elizaos/config/typescript/tsconfig.plugin.json';
import tsConfigFrontend from '@elizaos/config/typescript/tsconfig.frontend.json';
import tsConfigTest from '@elizaos/config/typescript/tsconfig.test.json';

// ESLint configs
import eslintConfigPlugin from '@elizaos/config/eslint/eslint.config.plugin.js';
import eslintConfigFrontend from '@elizaos/config/eslint/eslint.config.frontend.js';
import {
  baseConfig,
  testOverrides,
  standardIgnores,
} from '@elizaos/config/eslint/eslint.config.base.js';

// Prettier config
import prettierConfig from '@elizaos/config/prettier/prettier.config.js';

Configuration Paths

The package also exports configuration paths that can be used programmatically:

import { configPaths } from '@elizaos/config';

console.log(configPaths.typescript.base); // '@elizaos/configs/typescript/tsconfig.base.json'
console.log(configPaths.eslint.plugin); // '@elizaos/configs/eslint/eslint.config.plugin.js'
console.log(configPaths.prettier); // '@elizaos/configs/prettier/prettier.config.js'

Development

This is a private package used internally by ElizaOS. To make changes:

1. Clone the ElizaOS monorepo
2. Make your changes in packages/config/src/
3. Run bun run format to ensure formatting
4. Submit a PR with your changes

Scripts

• bun run lint - Format code with Prettier
• bun run format - Format code with Prettier
• bun run format:check - Check code formatting

License

MIT