eslint-plugin-react-native-enforce-testid

ESLint plugin for enforcing testID attributes in React Native components.

Installation

Install the plugin via npm:

1npm 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:

1{
2  "plugins": ["react-native-enforce-testid"],
3  "rules": {
4    "react-native-enforce-testid/testid-missing": "error"
5  }
6}

Run ESLint with the plugin:

1npx 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:

1const defaultComponents = [
2  "TextInput",
3  "TouchableOpacity",
4  "TouchableHighlight",
5  "TouchableNativeFeedback",
6  "Pressable",
7];

Customize the checked components in the ESLint configuration.

1module.exports = {
2  plugins: ['react-native-enforce-testid'],
3  rules: {
4    'react-native-enforce-testid/testid-missing': [
5      'error',
6      {
7        disableDefaultComponents: ['Button', 'TouchableOpacity'], // Disable default enabled components
8        enableComponents: ['Button'], // Custom components to enable this rule for
9      },
10    ],
11  },
12};

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

License This project is licensed under the MIT License.