eslint-plugin-props-checker

ESlint Plugin to Check whether Props exist

Introduction

This ESLint plugin is designed to verify that certain components (in React/React Native) have specific props defined. This can be useful to ensure that components have whatever props you want them to have.

If the rules are configured correctly, the plugin will generate an error if a component is missing any of the required props.

The plugin also includes a dependOn feature that allows you to specify that prop validation for a particular component should only be performed if another prop is present. For example, you could use this feature to validate that a testID prop exists only if an onPress prop is also present on a component.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-props-checker:

npm install eslint-plugin-props-checker --save-dev

Usage

Add props-checker to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": ["props-checker"]
}

Then configure the rules you want to use under the rules section. Once you enable this, it will errors for all the components that we have mentioned.

A sample can be found below.

{
    'rules':
        {
            'props-checker/validator':
                [
                    'error',
                    {
                        props:
                            [
                                { propName: 'testID', components: ['Button', { component: 'Text', dependOn: 'onPress' }] },
                                { propName: 'accessible', components: ['TextInput'] }
                            ]
                    }
                ]
        }
}

According to the above configuration, the plugin will throw an error,

• if the Button component does not have a testID prop.
• if the Text component does not have a testID prop only if it has an onPress prop defined.
• if the TextInput component does not have an accessible prop.

Rule Configurations

You can use the following configurations to customize the plugin. But,

• props, propName and components are mandatory.
• components can be a string or an object with component and dependOn properties.

Props: Array of validation objects PropName: Name of the prop to be validated Components: Array of components to be validated against the propName

Features

1. dependOn feature

If you need to check whether a prop exists only if another prop exists, you can use the dependOn feature. This feature allows you to specify that prop validation for a particular component should only be performed if another prop is present.

2. ignoreESLintPropValidation prop feature

If you need to ignore the ESLint prop validation of a component in a specific scenario, you can use the ignoreESLintPropValidation prop. Examples are included below.

##Examples

• A warning will be generated instead of an error

{ 'rules': { 'props-checker/validator': ['warn', { props: [{ propName: 'customProp', components: ['CustomComponent'] }] }] } }

• Multiple components with multiple dependOn to validate against testID prop.

{
    'rules':
        {
            'props-checker/validator':
                [
                    'error',
                    {
                        props:
                            [
                                { propName: 'testID', components: [{ component: 'Button', dependOn: 'title' }, { component: 'Text', dependOn: 'onPress' }] }
                            ]
                    }
                ]
        }
}

• Using ignoreESLintPropValidation prop

In this example, as you can see, CustomComponent must have a customProp property. But, we can ignore the ESLint prop validation by using the ignoreESLintPropValidation prop.

{ 'rules': { 'props-checker/validator': ['error', { props: [{ propName: 'anyProp', components: [ 'AnyComponent'] }] }] } }

If you want to ignore the ESLint prop validation of the AnyComponent in a particular situation/screen, you can use the ignoreESLintPropValidation prop.

<AnyComponent ignoreESLintPropValidation>

ESLint Extends

If this plugin configurations take too much space from your main eslintrc file, you can use the extends feature from eslint to keep these rule settings in another file in another directory. Example can be found here.

Contribution

All PRs are welcome. Please raise an issue before raising a PR.