Skip to content

Commit

Permalink
feat: support multi-line (#377)
Browse files Browse the repository at this point in the history
* feat: support multi-line

Basic support for multi-line. YAML multi-line strings a converted to a single line for the tables.

* cleanup
  • Loading branch information
npalm committed Mar 2, 2023
1 parent 14567cb commit ec0aa99
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
12 changes: 10 additions & 2 deletions __tests__/fixtures/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ author: 'Niek Palm'
inputs:
inputA:
required: false
description: 'A description'
description: |
A description
This is a multiline description
default: test
inputB:
required: false
description: |
This is a
multiline description
default: test

outputs:
Expand All @@ -13,4 +21,4 @@ outputs:

runs:
using: 'node12'
main: 'dist/index.js'
main: 'dist/index.js'
3 changes: 2 additions & 1 deletion __tests__/fixtures/default.output
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Default test

| parameter | description | required | default |
| --- | --- | --- | --- |
| inputA | A description | `false` | test |
| inputA | A description This is a multiline description | `false` | test |
| inputB | This is a multiline description | `false` | test |


## Outputs
Expand Down
2 changes: 1 addition & 1 deletion src/action-docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ function createMdTable(
for (const line of tableArray) {
result = `${result}|`;
for (const c of line) {
result = `${result} ${c} |`;
result = `${result} ${c.replace(/(\r\n|\n|\r)/gm, " ")} |`;
}
result = `${result}${getLineBreak(options.lineBreaks)}`;
}
Expand Down

0 comments on commit ec0aa99

Please sign in to comment.