tools icon indicating copy to clipboard operation
tools copied to clipboard

📎 Add fixable tag to lint rule docs

Open sebmck opened this issue 5 years ago • 2 comments

This should go in the index and in the generated description. It could be a frontmatter field.

Generation scripts:

  • https://github.com/romefrontend/rome/blob/main/scripts/generated-files/lint-rules-docs.ts
  • https://github.com/romefrontend/rome/blob/main/scripts/generated-files/lint-rules.ts

sebmck avatar Aug 08 '20 17:08 sebmck

@sebmck Can i help you on this? And could you please clarify on basically what is to be done? As in i don't understand what you mean by Add fixable tag

robintom avatar Aug 11 '20 08:08 robintom

@robintom We have a set of rules that can be fixable automatically by running the command rome check --apply, although some rules cannot be fixed automatically.

Sebastian is suggesting to flag these rules that can be fixed automatically in our docs by adding a frontmatter field. The frontmatter fields are the properties at the top of the file. Ultimately, we want to show this in our website in a fashion way.

If you need more guidance, feel free to ask!

ematipico avatar Aug 11 '20 09:08 ematipico