@maltjoy/eslint-rules

Custom ESLint rules for Maltjoy design system usage.

This package is ESM-only ("type": "module"). Use import from eslint.config.mjs / eslint.config.js (with ESM).

Rules

• no-vjoybutton-circle: disallow circle prop usage on VJoyButton.

Message:

VJoyButton circle property is deprecated, please use VJoyIconButton instead

• no-vjoyinput-type-password: disallow VJoyInput with type="password" (or a literal :type bound to password). Use VJoyInputPassword instead.

• no-vjoyinput-unit: disallow unit prop usage on VJoyInput. Use VJoyInputNumber instead.

Message:

Do not use VJoyInput with unit, use VJoyInputNumber instead.

• no-vjoyusercard-rating-stars-slot: disallow user-card-rating-stars slot usage on VJoyUserCard. Use the default slot instead.

Message:

Do not use VJoyUserCard user-card-rating-stars slot, use the default slot instead.

Usage (flat config)

Preset (recommended) — active toutes les règles du design system d’un coup :

import maltjoyRules from '@maltjoy/eslint-rules';
import vueParser from 'vue-eslint-parser';

export default [
  {
    files: ['**/*.vue'],
    languageOptions: {
      parser: vueParser,
    },
  },
  ...maltjoyRules.configs.recommended,
];

Les sévérités par défaut du preset sont en error. Pour assouplir une règle, ajoute un bloc après le spread :

  ...maltjoyRules.configs.recommended,
  {
    rules: {
      '@maltjoy/eslint-rules/no-vjoybutton-circle': 'warn',
    },
  },

Règles à la carte (sans preset) :

import maltjoyRules from '@maltjoy/eslint-rules';

export default [
  {
    plugins: {'@maltjoy/eslint-rules': maltjoyRules},
    rules: {
      '@maltjoy/eslint-rules/no-vjoybutton-circle': 'warn',
    },
  },
];