@hhgtech/eslint-plugin-hhg-customs

Hello Health Group's Custom ESLint rules for enforcing best practices.

Installation

You can install this plugin using npm or yarn:

npm install @hhgtech/eslint-plugin-hhg-customs --save-dev

or

yarn add @hhgtech/eslint-plugin-hhg-customs --dev

Configuration

To use the custom ESLint rules in your project, you need to configure ESLint to include this plugin and enable the specific rules in your .eslintrc.js or other ESLint configuration file.

Here's an example ESLint configuration:

module.exports = {
  plugins: ['@hhgtech/hhg-customs'],
  rules: {
    '@hhgtech/hhg-customs/img-require-loading': 'error',
    // Add other custom rules as needed
  },
};

Make sure to replace 'img-require-loading' with the actual name of the custom rule you want to enable.

Usage

After configuring ESLint to use the custom rules, you can run ESLint on your code to enforce these rules. For example:

npx eslint your-source-files.js

If you want ESLint to automatically fix issues reported by these custom rules, you can add the --fix flag:

npx eslint --fix your-source-files.js

Rules

img-require-loading

This rule enforces the presence of a loading prop on <img> elements.

Options:

• always (default) - Requires the loading prop.
• never - Does not require the loading prop.

Examples:

// .eslintrc.js
module.exports = {
  plugins: ['@hhgtech/hhg-customs'],
  rules: {
    '@hhgtech/hhg-customs/img-require-loading': 'error', // Requires the loading prop
  },
};

License

This project is licensed under the MIT License - see the LICENSE file for details.