Skip to content

core: Create getInputList utility #336

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.

Sign up for GitHub

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

Closed
kiprasmel wants to merge 4 commits into from
Closed

core: Create getInputList utility #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0fb5515
feat(core): Create `getInputList` utility
kiprasmel Feb 6, 2020
86a466b
chore(core): Document usage of '\n' instead of [] @ `getInputList`
kiprasmel Feb 6, 2020
a4e0c5c
test(core): Create a very simple test for `getInputList`
kiprasmel Feb 6, 2020
7658fd8
Merge branch 'main' into sarpik/getInputList-support
thboop Jun 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions packages/core/__tests__/core.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ const testEnvVars = {
INPUT_WRONG_BOOLEAN_INPUT: 'wrong',
INPUT_WITH_TRAILING_WHITESPACE: ' some val ',

// Set input lists
/**
* why `'\n'` instead of an `[]`: https://github.com/actions/cache/issues/44#issuecomment-549399196
* the FR for this feature + tracking of the previous one: https://github.com/actions/toolkit/issues/184
*/
INPUT_MY_INPUT_LIST: 'val1\nval2\nval3',

// Save inputs
STATE_TEST_1: 'state_val',

Expand Down Expand Up @@ -166,6 +173,10 @@ describe('@actions/core', () => {
)
})

it('getMultilineInput works', () => {
expect(core.getMultilineInput('my input list')).toEqual(['val1', 'val2', 'val3'])
})

it('getInput trims whitespace by default', () => {
expect(core.getInput('with trailing whitespace')).toBe('some val')
})
Expand Down
16 changes: 16 additions & 0 deletions packages/core/src/core.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,22 @@ export function getInput(name: string, options?: InputOptions): string {
return val.trim()
}

/**
* Gets the values of an multiline input. Each value is also trimmed.
*
* @param name name of the input to get
* @param options optional. See InputOptions.
* @returns string[]
*
*/
export function getMultilineInput(name: string, options?: InputOptions): string[] {
const inputs: string[] = getInput(name, options)
.split('\n')
.filter(x => x !== '')

return inputs
}

/**
* Gets the input value of the boolean type in the YAML 1.2 "core schema" specification.
* Support boolean input list: `true | True | TRUE | false | False | FALSE` .
Expand Down