Skip to content

Commit

Permalink
Updated purpose of betaRuleNames array
Browse files Browse the repository at this point in the history
  • Loading branch information
thatblindgeye committed Jul 18, 2024
1 parent 3881ac0 commit 89f7528
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ An eslint plugin (with an extra CLI utility) to help ease products transitioning
- You can also replace `v5` with another version directory within the repo
1. Run `yarn test:v5:single` to run the `pf-codemods` command against the `test.tsx` file and to check what error/warning messages a consumer would see when running our codemods
- You can also run `yarn test:v5:single --fix` to see what the `test.tsx` file looks like after fixes are applied, allowing you to check whether fixes are applied as expected. Make sure to not save the `test.tsx` file after applying fixes.
1. If the rule you're adding should have a severity of `warning` rather than `error`, add the rule name to the `warningRules` array in `eslint-plugin-pf-codemods/index.js`.
1. If the rule you're adding has not yet been merged into pf-react, or if the rule is otherwise intended for a consumer to explicitly run manually, add the rule name to the `betaRuleNames` array in `eslint-plugin-pf-codemods/index.js`.
1. If the rule you're adding should have a severity of `warning` rather than `error`, add the rule name to the `warningRules` array in `eslint-plugin-pf-codemods/src/ruleCustomization.js`.
1. If the rule you're adding is intended for a consumer to explicitly run manually, add the rule name to the `betaRuleNames` array in `eslint-plugin-pf-codemods/src/ruleCustomization.js`.

## Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions packages/eslint-plugin-pf-codemods/src/ruleCustomization.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/** if you want your rule to only run when explicitly called for using the --only flag,
* add the rule name to the below array. If a React PR is not yet merged, provide a comment
* by the rule stating such, so that we can easily remove them in the future.
* add the rule name to the below array. Do not add rules here if the React PR is
* not yet merged; instead add a "do not merge" label to the codemod PR.
*/
export const betaRuleNames: string[] = ["kebabToggle-replace-with-menuToggle"];

Expand Down

0 comments on commit 89f7528

Please sign in to comment.