cisagov / ScubaGear

Automation to assess the state of your M365 tenant against CISA's baselines
https://www.cisa.gov/resources-tools/services/secure-cloud-business-applications-scuba-project
Creative Commons Zero v1.0 Universal
1.54k stars 210 forks source link

Compare ymllint to Prettier #763

Open james-garriss opened 8 months ago

james-garriss commented 8 months ago

💡 Summary

What is the work, as a high-level summary?

There is a GitHub Action workflow that lints YAML files, and it uses ymllint under the covers. Most of the developers on the team code with VS Code, which uses Prettier by default for linting YAML file. Wouldn't it be nice if the workflow used the same tool that the developers use?

Motivation and context

Why does this work belong in this project?

It would slightly ease the burden of development.

ymllint is not broken, and the extent to which the two tools have different linting rules is unknown. This could be explored during this issue. Perhaps ymllint is better; perhaps not.

Implementation notes

Please provide details for implementation, such as:

Acceptance criteria

How do we know when this work is done?

james-garriss commented 8 months ago

I've been looking for yamllint as a VSCode extension. The authors of yamllint recommend using this extension:
https://marketplace.visualstudio.com/items?itemName=fnando.linter

If we can all agree to use that, then this issue (763) becomes moot. OTOH, if we switch everything to Prettier, then there's no need for devs to add this extension.