Skip to content

ErrorFSA type alias is incorrectly formatted #116

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

Open
thisissami opened this issue Jul 6, 2019 · 2 comments
Open

ErrorFSA type alias is incorrectly formatted #116

thisissami opened this issue Jul 6, 2019 · 2 comments

Comments

@thisissami
Copy link

This is pretty minor and trivial, but should be addressed nonetheless. It seems that the entirety of the type definitions use the order of <Type, Payload, Meta> (or equivalent). However, ErrorFSA was not updated to use this new order.

That being said... I don't really understand why the ordering was changed... With this new ordering, all apps that use flux-standard-action now are required to define a type if they want to define a Payload or Meta. For many codebases, the type will remain as string. In my company's codebase - we have had to add a string to almost every instance of FSA (and derivatives).

It seems really weird that the only type that has a value used so commonly that it gets a default should be forced to be first. It being last makes the most logical sense imo; if you want to define just a Payload or Meta, you are not forced to also add a string that would otherwise be set by default.

@thisissami
Copy link
Author

Oh and for what it's worth, I am commenting on this ordering change now as I assumed there were more significant reasons for it changing. Looking at the PR where it was changed (#114) now as a result of the issue originally reported here, it seems that it was just an arbitrary stylistic choice, not considering the ramifications described above.

@unional
Copy link
Contributor

unional commented Mar 20, 2022

Seems like it is just missed. But changing the order will be a breaking change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants