Kablamo eslint plugin
yarn add -D @kablamo/eslint-plugin
Add the following to your .eslintrc.js
.
module.exports = {
plugins: ["@kablamo"],
extends: ["plugin:@kablamo/recommended"],
};
Rules
test-id-prefix-match-path
This rule fixes the first argument of createTestIds(prefix, [ ...ids])
to be a prefix derived from the files
current directory. This ensures consistent unique prefixes per component.
You can still suffix variables to the end of your test id for example data-testid={\
${testId.myId}-${uuid}`}`.
test-id-consistent-naming
This rule ensures common misspellings always get fixed to the kebab-case data-testid
by default.
This can be configured to data-test-id
.
module.exports = {
plugins: ["@kablamo"],
extends: ["plugin:@kablamo/recommended"],
rules: {
"@kablamo/test-id-consistent-naming": ["error", "data-test-id"],
},
};
Configurations
This plugin contains a reccomended elsint ruleset to enable the included rules.
Developing
Run yarn test
from the root of the project.