folks, looking at the <v1 (stable)> milestone, the only actionable task is <Enforce named arguments ...

# github-workflows-kt

[Piotr Krzemiński]

folks, looking at the v1 (stable) milestone, the only actionable task is Enforce named arguments in whole API (breaking change)! Regarding “whole”, I’m planning to do it for DSL functions like job or uses, but I was thinking of not doing this for literally every function/constructor, so also e.g. for data classes. If you have some thoughts on this, it’s the right moment to share them 🙂 I’m tentatively planning to do it for the v0.45.0, it will be a breaking change if you use positional args somewhere

[Piotr Krzemiński]

it’s also a good moment to bring to my attention anything that must go into v1, even if it’s not tracked in the issues now

[jmfayard]

I’m like NikkyAI, I don’t understand how you force the consumer of the library to use named arguments. Is this an option I’m not aware of?

[Piotr Krzemiński]

Are you asking how is it technically possible, or how I dare forcing the users to use the lib this way? :D

[Piotr Krzemiński]

If the former, please try this trick: https://github.com/typesafegithub/github-workflows-kt/blob/066f5694015fadc4af67631a45f962e410d9a794/library/src/gen/kotlin/io/github/typesafegithub/workflows/actions/actions/CheckoutV3.kt#L126

[Piotr Krzemiński]

Yes, it's a hack. Or an idiom, depending on how you prefer to call it

[Piotr Krzemiński]

I'm more interested in if it's a good idea. The biggest motivation behind it is not loosing the clarity of YAML when it comes to passing arguments in a form of a dictionary. If we want to encourage people to use the library, they cannot feel like they lose something, and they would by being able to use positional arguments. On the other side, the way I'd like to implement it doesn't give a clear error message, so it may cause confusion (more harm than good?)

[Piotr Krzemiński]

So I'm still hesitating if we should do it, and if yes, to what extent

[Piotr Krzemiński]

If ktlint supported kts files and had a rule for checking if kwargs are used, we could say it's a matter of preference of each person

[jmfayard]

That’s abolutely mind blowing, bravo

[jmfayard]

If you don’t mind, open an issue on yaml2kotlin when you do the change

[Piotr Krzemiński]

@Nikky do you feel convinced it's a good idea?

[Piotr Krzemiński]

merged [#807] feat(library)!: enforce named arguments in main DSL functions