Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/aurelienbobenrieth/gadget/llms.txt

Use this file to discover all available pages before exploring further.

Developer Tools for Gadget

ESLint plugin with 16 rules for validating Gadget action files, plus a React component library and design system for building beautiful developer experiences.

Get StartedESLint PluginUI Components

Quick Start

Get up and running with Gadget developer tools in minutes

1

Install the ESLint plugin

Add the plugin to your Gadget project to catch invalid options, params, and runtime issues before they hit production.
npm install -D @aurelienbbn/eslint-plugin-gadget
2

Configure your eslint.config.js

Add the recommended config to your ESLint configuration file.
eslint.config.js
import gadget from "@aurelienbbn/eslint-plugin-gadget";

export default [
  gadget.configs.recommended,
  // ...your other configs
];
The plugin automatically activates on Gadget action files: **/api/actions/**/*.{js,ts} and **/api/models/**/actions/**/*.{js,ts}
3

Start validating your code

Run ESLint on your codebase to catch issues instantly.
eslint .

api/models/widget/actions/create.ts
  15:3  error  timeoutMS must not exceed 900000ms (15 min)  gadget/action-no-invalid-timeout-ms
  20:5  error  returnType must be explicitly set           gadget/action-require-explicit-return-type

✖ 2 problems (2 errors, 0 warnings)
  2 errors and 0 warnings potentially fixable with the `--fix` option.

Explore the Tools

Everything you need to build robust Gadget applications

ESLint Plugin

16 rules for validating Gadget action files - options, params, timeout, and runtime safety checks.

Configuration Presets

Choose between recommended and strict configs to match your team’s code quality standards.

UI Components

React component library with dark/light theme support built on Tailwind CSS.

Design Tokens

Tailwind preset with semantic color tokens and typography scales.

Browse by Category

Explore ESLint rules organized by validation type

Options Validation

8 rules for validating action options including timeout, returnType, actionType, and triggers.

View rules

Params Validation

Validate action parameters use supported types and avoid unsupported JSON Schema features.

View rule

Runtime Safety

5 rules to catch runtime issues with onSuccess callbacks, return values, and type annotations.

View rules

Enqueue Safety

2 rules for validating api.enqueue calls with concurrency limits and explicit retry configuration.

View rules

Key Features

Built for teams that care about code quality and developer experience

Auto-fixable Rules

Many rules support automatic fixes with eslint —fix, saving you time and ensuring consistency.

Type Safety

Built with TypeScript for complete type safety and excellent IDE support with IntelliSense.

Design System

Complete React component library with Tailwind preset for building consistent UIs.

Ready to improve your code quality?

Install the ESLint plugin and start catching issues before they reach production.

Get Started Now