feat(core): add getBooleanInput function

[yi-Xu-0100]

Gets the input value of the boolean type in the YAML specification.
The return value is also in boolean type.

ref: https://yaml.org/type/bool.html

close #723

[yi-Xu-0100]

@ericsciple After I read the discussion in #362, I find that the YAML 1.2 core schema is implemented (#362 (comment)). So could we add the getBooleanInput function into the core package? 😀

[thboop]

Thanks for the contribution @yi-Xu-0100! I left some minor feedback before merging, happy to take the pr over if you don't have the time to continue working on this!

[thboop]

Suggested change

	export function getBooleanInput(name: string): boolean {
	export function getBooleanInput(name: string, options?: InputOptions: boolean) {

Lets keep consistent with the getInput function. We really shouldn't throw if the value does not exist or is invalid, just return false. We can debug if the parsing does not match either case, to help with troubleshooting if users encounter this issue

We can add another option to InputOptions to set a default value, and return that instead of false if needed as well. I'm happy to tackle that in another pr if you want.

[yi-Xu-0100]

@thboop Sorry for the delayed reply, I tried to fix the conflict with the main branch, but it didn't seem to get it right. 😅 So I pulled it again, attached my changes, and pushed it forcibly.

The change of what I did:

1. I fixed the README descriptions, add a suggestion about the required option, and try to format the content.
2. I add options for getBooleanInput function and use the getInput to deal with it.
3. I add the support boolean input list into the type error.
4. I add more tests for the getBooleanInput function.

For the error, I think the function is used to deal with boolean input, It should have a default value in action.yml if it is not necessary. And when it should be decided by users, it also should return a type error when users input the wrong value, which will help users to solve it without asking. What do you think? 😀

[thboop]

And when it should be decided by users, it also should return a type error when users input the wrong value, which will help users to solve it without asking.

Agreed, thanks for the contribution!

[thboop]

LGTM thanks for the contribution @yi-Xu-0100!

[chamini2]

what if it was required: false?

[yi-Xu-0100]

@chamini2 The required: false will be dealt with the getInput(Line 107) and get the default value. 👀

[chamini2]

But if there is no default value, that will make val an empty string, which we don't consider in line 108 or 109. Resulting in throw new TypeError because trueValue.includes('') and falseValue.includes('') are both false.

[yi-Xu-0100]

Action inputs can be read with getInput which returns a string or getBooleanInput which parses a boolean based on the yaml 1.2 specification. If required set to be false, the input should have a default value in action.yml.

https://github.com/yi-Xu-0100/toolkit/blob/main/packages/core/README.md

@chamini2 Why a boolean type input have no default value? 👀

[chamini2]

Oh, I did not know this was expected. If required: false and no default I thought it had just to return null or ''. Thanks, sorry for the inconvenience.