eslint-plugin-react-native-enforce-testid

ESLint plugin for enforcing testID attributes in React Native components.

Installation

Install the plugin via npm:

npm install eslint-plugin-react-native-enforce-testid --save-dev

Ensure that ESLint is installed:

npm install eslint --save-dev

Usage

Configure ESLint to use the plugin. Add it to the ESLint configuration:

{
  "plugins": ["react-native-enforce-testid"],
  "rules": {
    "react-native-enforce-testid/testid-missing": "error"
  }
}

Run ESLint with the plugin:

npx eslint --ext .js --plugin react-native-enforce-testid .

Rule Details

testid-missing Ensures that specified React Native components have a testID attribute defined.

Triggers an error if a React Native component is missing the testID attribute. Default components can be viewed in the lib/index.js file:

const defaultComponents = [
  "TextInput",
  "TouchableOpacity",
  "TouchableHighlight",
  "TouchableNativeFeedback",
  "Pressable",
];

Customize the checked components in the ESLint configuration.

module.exports = {
  plugins: ['react-native-enforce-testid'],
  rules: {
    'react-native-enforce-testid/testid-missing': [
      'error',
      {
        disableDefaultComponents: ['Button', 'TouchableOpacity'], // Disable default enabled components
        enableComponents: ['Button'], // Custom components to enable this rule for
      },
    ],
  },
};

Contributing Contributions are welcome! Submit issues or pull requests on the GitHub repository.

License This project is licensed under the MIT License.