Linting

An ESLint plugin enforces App-Compose conventions in TypeScript code. It requires ESLint 9+.

Installation

Use your preferred package manager.

npm

npm install --save-dev --save-exact @grlt-hub/eslint-plugin-app-compose

pnpm

pnpm add --save-dev --save-exact @grlt-hub/eslint-plugin-app-compose

yarn

yarn add --dev --exact @grlt-hub/eslint-plugin-app-compose

bun

bun add --dev --exact @grlt-hub/eslint-plugin-app-compose

Usage

Import the plugin and add it to your config. Use the recommended preset for a quick start.

import appCompose from "@grlt-hub/eslint-plugin-app-compose"
import tseslint from "typescript-eslint"

export default tseslint.config(appCompose.configs.recommended)

You can also configure it manually.

{
  plugins: {
    'app-compose': appCompose,
  },
  rules: {
    'app-compose/task-options-order': 'warn',
  },
}

Rules

task-options-order

This order matches how a Task reads top-to-bottom: name first, then run before the optional enabled. Inside both, context comes before fn. The plugin warns when the order differs.

// ❌ Wrong
createTask({
  name: "alpha",
  enabled: {
    fn: check,
    context: { authorized: authorizedTag },
  },
  run: {
    context: { timeout: timeoutTag },
    fn: init,
  },
})

// ✅ Correct
createTask({
  name: "alpha",
  run: {
    context: { timeout: timeoutTag },
    fn: init,
  },
  enabled: {
    context: { authorized: authorizedTag },
    fn: check,
  },
})