You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently for our V6 codemods we generate the README for the repo using a template MD file in each rule that inserts examples before compiling the MD files together into the master README.
Because we use the rule info for other things like helping with creation of release notes it would be better if the rule name, PR link, description, and other attributes were instead stored in a more easily parsed format such as JSON instead of MD.
Additionally if we need special markdown features such as tables we should include those as a separate key outside of the rule description. The description should only be plain text.
We could also probably use this JSON file to store data such as if the rule is a warning instead of having that info in the rulecustomization array. That should be done under a different issue if so, I'm just mentioning it here because it's another advantage of this approach.
The text was updated successfully, but these errors were encountered:
Currently for our V6 codemods we generate the README for the repo using a template MD file in each rule that inserts examples before compiling the MD files together into the master README.
Because we use the rule info for other things like helping with creation of release notes it would be better if the rule name, PR link, description, and other attributes were instead stored in a more easily parsed format such as JSON instead of MD.
Additionally if we need special markdown features such as tables we should include those as a separate key outside of the rule description. The description should only be plain text.
We could also probably use this JSON file to store data such as if the rule is a warning instead of having that info in the rulecustomization array. That should be done under a different issue if so, I'm just mentioning it here because it's another advantage of this approach.
The text was updated successfully, but these errors were encountered: