eslint-plugin-hunt-club v0.1.0

eslint-plugin-hunt-club

Provides custom linting rules from Hunt Club.

Table of Contents

• Installation
• Rules
  • hunt-club/require-icon-postfix
    • Examples
    • When Not To Use It
    • Version
    • Futher Reading
• License

Installation

$ yarn add -D eslint-plugin-hunt-club

Add it to your .eslintrc.js:

module.exports = {
  plugins: [
    'hunt-club',
  ],
  rules: {
    'hunt-club/require-icon-postfix': 'error',
  },
};

Rules

hunt-club/require-icon-postfix

Require the Icon postfix for all Lucide icon components

Examples

Examples of incorrect code for this rule:

import {Settings} from 'lucide-react';

Examples of correct code for this rule:

import {SettingsIcon} from 'lucide-react';

When Not To Use It

When you do not care which import alias is used for importing icons from lucide-react.

Version

This rule was introduced in package version v0.1.0

Futher Reading

Lucide Dev

License

MIT