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

Suggested rules #2

Open
negz opened this issue Feb 5, 2023 · 0 comments
Open

Suggested rules #2

negz opened this issue Feb 5, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@negz
Copy link
Member

negz commented Feb 5, 2023

Thanks for building this - I expect it will be very useful.

What do you think about having the linter warn if folks aren't following "best practices"? These aren't things that would break a Configuration or Composition, but they are things that make them more readable, and in some cases "future proof" them.

The two examples that immediately come to mind are:

  • Warn if any entries in the resources array are missing a name field. When this is the case Composition operates in a kind of "legacy mode". It can't support deleting or reordering entries in the resources array, and can't support Composition Functions.
  • Warn if any type field is missing. This is mostly a readability thing - we introduced a couple of type fields as optional when they probably should have been required. I think writing the type out each time makes it more obvious what the Composition is doing.
@MisterMX MisterMX added the enhancement New feature or request label Feb 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants