ESLint

@plumeria/eslint-plugin is the ESLint plugin for Plumeria.

Installation

npm i --save-dev @plumeria/eslint-plugin

yarn add -D @plumeria/eslint-plugin

pnpm i --save-dev @plumeria/eslint-plugin

Overview

import type { ESLint, Linter, Rule } from 'eslint';
type PlumeriaPlugin = ESLint.Plugin & {
    rules: Record<string, Rule.RuleModule>;
    configs: {
        recommended: Linter.LegacyConfig;
    };
    flatConfigs: {
        recommended: Linter.Config;
    };
};
export declare const plumeria: PlumeriaPlugin;

API

Rules: recommended

• '@plumeria/style-name-requires-import': 'error'
• '@plumeria/no-combinator': 'error'
• '@plumeria/no-destructure': 'error'
• '@plumeria/no-inner-call': 'error'
• '@plumeria/no-unused-keys': 'warn'
• '@plumeria/sort-properties': 'warn'
• '@plumeria/format-properties': 'warn'
• '@plumeria/validate-values': 'warn'

When using recommended, all rules are turned on.