Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DX] Add recommended extensions and direction for sh / yml formatting #191562

Open
Ikuni17 opened this issue Aug 27, 2024 · 1 comment
Open

[DX] Add recommended extensions and direction for sh / yml formatting #191562

Ikuni17 opened this issue Aug 27, 2024 · 1 comment
Labels
Team:Operations Team label for Operations Team

Comments

@Ikuni17
Copy link
Contributor

Ikuni17 commented Aug 27, 2024

It would be good to get some consistent formatting and linting on specific file types, namely .yml and .sh. For example, I see PRs which will flip .yml from single to double quote and/or adjust spacing. Then another PR comes along doing the opposite, due to the user's environment. This does increase the diff, or require Save without Formatting, and/or manually formatting. In the case of yml it can cause parsing issues which break the file too.

Ideas:

  • Can we utilize .editorconfig better?
  • Should we add shellcheck?
  • Can we nudge developers in the right direction with recommended extensions?
  • Should we add a Checks step to be more firm about these changes?
@botelastic botelastic bot added the needs-team Issues missing a team label label Aug 27, 2024
@Ikuni17 Ikuni17 added the Team:Operations Team label for Operations Team label Aug 29, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-operations (Team:Operations)

@botelastic botelastic bot removed the needs-team Issues missing a team label label Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Operations Team label for Operations Team
Projects
None yet
Development

No branches or pull requests

2 participants