eslint-plugin-ripple

eslint-plugin-ripple

ESLint plugin for Ripple - helps enforce best practices and catch common mistakes when writing Ripple applications.

Works just like eslint-plugin-react - simply install and use the recommended config!

Installation

npm install --save-dev eslint-plugin-ripple
# or
yarn add --dev eslint-plugin-ripple
# or
pnpm add --save-dev eslint-plugin-ripple

Usage

Flat Config (ESLint 9+)

// eslint.config.js
import ripple from 'eslint-plugin-ripple';

export default [...ripple.configs.recommended];

The plugin automatically:

• Detects and uses eslint-parser-ripple if installed for .ripple files
• Detects and uses @typescript-eslint/parser if installed for .ts/.tsx files
• Excludes .d.ts files, node_modules, dist, and build directories from linting
• Works with both .ts/.tsx and .ripple files

Legacy Config (.eslintrc)

{
  "plugins": ["ripple"],
  "extends": ["plugin:ripple/recommended"]
}

Configurations

recommended

The recommended configuration enables all rules at their default severity levels (errors and warnings).

import ripple from 'eslint-plugin-ripple';

export default [
  {
    plugins: { ripple },
    rules: ripple.configs.recommended.rules,
  },
];

strict

The strict configuration enables all rules as errors.

import ripple from 'eslint-plugin-ripple';

export default [
  {
    plugins: { ripple },
    rules: ripple.configs.strict.rules,
  },
];

Rules

ripple/no-module-scope-track (error)

Prevents calling track() at module scope. Tracked values must be created within a component context.

❌ Incorrect:

import { track } from 'ripple';

// This will cause runtime errors
let globalCount = track(0);

export component App() {
  <div>{@globalCount}</div>
}

✅ Correct:

import { track } from 'ripple';

export component App() {
  // track() called within component
  let count = track(0);

  <div>{@count}</div>
}

ripple/require-component-export (warning)

Warns when capitalized components are not exported. This helps ensure components are reusable across modules.

❌ Incorrect:

component MyButton() {
  <button>Click me</button>
}
// MyButton is defined but not exported

✅ Correct:

export component MyButton() {
  <button>Click me</button>
}

ripple/prefer-oninput (warning, fixable)

Recommends using onInput instead of onChange for form inputs. Unlike React, Ripple doesn't have synthetic events, so onInput is the correct event handler.

❌ Incorrect:

<input onChange={handleChange} />

✅ Correct:

<input onInput={handleInput} />

This rule is auto-fixable with --fix.

ripple/no-return-in-component (error)

Prevents returning JSX from Ripple components. In Ripple, JSX should be used as statements, not expressions.

❌ Incorrect:

export component App() {
  return <div>Hello World</div>;
}

✅ Correct:

export component App() {
  <div>Hello World</div>
}

ripple/unbox-tracked-values (error)

Ensures tracked values are unboxed with the @ operator when used in JSX expressions.

❌ Incorrect:

export component App() {
  let count = track(0);

  // Missing @ operator
  <div>{count}</div>
}

✅ Correct:

export component App() {
  let count = track(0);

  // Properly unboxed with @
  <div>{@count}</div>
}

ripple/no-introspect-in-modules (error)

Prevents using the @ introspection operator in TypeScript/JavaScript modules. In .ts/.js files, you should use get() and set() functions instead.

❌ Incorrect:

// count.ts
export function useCount() {
  const count = track(1);
  effect(() => {
    console.log(@count); // Error: Cannot use @ in TypeScript modules
  });
  return { count };
}

✅ Correct:

// count.ts
import { get, set } from 'ripple';

export function useCount() {
  const count = track(1);
  
  // Use get() to read tracked values
  const double = derived(() => get(count) * 2);
  
  effect(() => {
    console.log("count is", get(count));
  });
  
  return { count, double };
}

Note: The @ operator is only valid in .ripple component files. In TypeScript modules, use get() to read values and set() to update them.

Custom Configuration

You can customize individual rules in your ESLint config:

export default [
  {
    plugins: { ripple },
    rules: {
      'ripple/no-module-scope-track': 'error',
      'ripple/require-component-export': 'off', // Disable this rule
      'ripple/prefer-oninput': 'error', // Make this an error instead of warning
      'ripple/no-return-in-component': 'error',
      'ripple/unbox-tracked-values': 'error',
      'ripple/no-introspect-in-modules': 'error',
    },
  },
];

The plugin will automatically detect and use the Ripple parser for your .ripple files.

License

MIT

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Related

• Ripple - The Ripple framework
• vite-plugin-ripple - Vite plugin for Ripple
• prettier-plugin-ripple - Prettier plugin for Ripple