@obinexusltd/obix-config-eslint

ESLint v9 flat configuration for OBIX SDK packages — part of the @obinexusltd/obix-monorepo.

Provides typed factory functions, ready-to-use flat config files, and environment-specific rule presets for linting OBIX SDK source code with ESLint 9 + typescript-eslint 8.

Installation

Registered automatically as an npm workspace package:

# From monorepo root
npm install

To add it as a dependency in a consumer package:

{
  "devDependencies": {
    "@obinexusltd/obix-config-eslint": "workspace:*"
  }
}

Package Structure

packages/config/eslint/
├── eslint.config.js          ← Root flat config (./flat export)
├── base/
│   └── eslint.config.js      ← Base TypeScript rules
├── development/
│   └── eslint.config.js      ← Dev config (console allowed, any-type off)
├── production/
│   └── eslint.config.js      ← Prod config (no-console error, strict types)
└── src/
    └── index.ts              ← TypeScript programmatic API (compiled to dist/)

Requirements

This package targets ESLint v9 flat config only. The legacy .eslintrc format is not supported.

Your eslint.config.js (or eslint.config.mjs) must be present at the project root.

Programmatic API

import {
  createBaseConfig,
  createDevConfig,
  createProdConfig,
  resolveConfig,
} from '@obinexusltd/obix-config-eslint';

// Base — TypeScript-eslint recommended + OBIX core rules
const base = createBaseConfig();

// Development — relaxed console/any rules
const dev = createDevConfig({ typescript: true });

// Production — strict, no-console error, explicit return types
const prod = createProdConfig();

// Resolve by environment string
const config = resolveConfig('production', { files: ['src/**/*.ts'] });

Factory Functions

| Function | Description | |----------|-------------| | createBaseConfig(opts?) | Base TypeScript rules, no-console: warn | | createDevConfig(opts?) | Dev: no-console: off, no-explicit-any: off | | createProdConfig(opts?) | Prod: no-console: error, no-explicit-any: error, strict types | | resolveConfig(env, opts?) | Delegates by 'base' \| 'development' \| 'production' |

All factories return Array<Record<string, unknown>> — a plain flat config array. Spread into your own tseslint.config(...) call or use directly.

ObixEsLintOptions

interface ObixEsLintOptions {
  typescript?: boolean;        // default: true  — enable @typescript-eslint rules
  imports?: boolean;           // default: false — enable eslint-plugin-import
  unicorn?: boolean;           // default: false — enable eslint-plugin-unicorn
  files?: string[];            // default: ['**/*.ts', '**/*.tsx']
  ignores?: string[];          // default: ['dist/**', 'node_modules/**', '**/*.d.ts']
  rules?: Record<string, unknown>; // default: {} — merged on top of preset
}

Static Descriptors

import {
  baseConfig,
  developmentConfig,
  productionConfig,
} from '@obinexusltd/obix-config-eslint';

Using Config Files Directly

Root flat config (recommended)

Reference in your project's eslint.config.js:

// eslint.config.js
import obixConfig from '@obinexusltd/obix-config-eslint/flat';

export default [
  ...obixConfig,
  // your project-specific overrides
  {
    rules: {
      'no-console': 'off', // override for this project
    },
  },
];

Or with the tseslint.config() helper:

import tseslint from 'typescript-eslint';
import obixConfig from '@obinexusltd/obix-config-eslint/flat';

export default tseslint.config(
  ...obixConfig,
  {
    rules: {
      '@typescript-eslint/no-explicit-any': 'error',
    },
  },
);

Base config

import base from '@obinexusltd/obix-config-eslint/base';
export default [...base];

Development config

import devConfig from '@obinexusltd/obix-config-eslint/development';
export default [...devConfig];

Production config

import prodConfig from '@obinexusltd/obix-config-eslint/production';
export default [...prodConfig];

Environment Rule Reference

| Rule | base | development | production | |------|--------|---------------|--------------| | no-console | warn | off | error | | no-debugger | error | warn | error | | @typescript-eslint/no-explicit-any | warn | off | error | | @typescript-eslint/no-unused-vars | error | error | error | | @typescript-eslint/explicit-function-return-type | — | — | warn | | @typescript-eslint/strict-boolean-expressions | — | — | warn | | @typescript-eslint/consistent-type-imports | warn | off | error | | @typescript-eslint/no-non-null-assertion | warn | warn | error | | prefer-const | error | error | error | | no-var | error | error | error | | eqeqeq | error | error | error | | curly | error | error | error |

Peer Dependencies

Required:

{
  "devDependencies": {
    "@eslint/js": ">=9.0.0",
    "eslint": ">=9.0.0",
    "typescript-eslint": ">=8.0.0"
  }
}

Optional:

{
  "devDependencies": {
    "eslint-plugin-import": "*",
    "eslint-plugin-unicorn": "*"
  }
}

Comparison with Other OBIX Config Packages

| Feature | ESLint | TypeScript | Rollup | Webpack | |---------|--------|------------|--------|---------| | Primary role | Linting | Type checking | Library bundling | App bundling | | TypeScript support | typescript-eslint | Native | @rollup/plugin-typescript | ts-loader | | Output format | Report only | .d.ts + .js | ESM / CJS | Bundle | | Best for | Code quality | Type safety | SDK packages | Browser apps |

Use ESLint alongside your build toolchain — not instead of it.

Author

Nnamdi Michael Okpala — OBINexus <[email protected]>

Part of the OBIX Heart/Soul UI/UX SDK monorepo.