From 3d6b6ba3b436b4dd7bbbd769063afb29255bd8a5 Mon Sep 17 00:00:00 2001
From: Kristian Klemets <kristian.klemets@gmail.com>
Date: Thu, 20 Oct 2022 12:29:21 +0300
Subject: [PATCH] Tables: Use three hyphens in tables instead of one (#292)

* Tables: Use three hyphens in tables instead of one

In order to follow the GitHub specification for tables, we want
to use 3 hyphens to separate table header row from the data rows.

Refs https://github.com/npalm/action-docs/issues/275

* Tables: Add three hyphens to all test files
---
 __tests__/fixtures/all_fields_action.output          | 4 ++--
 __tests__/fixtures/all_fields_action_toc1.output     | 4 ++--
 __tests__/fixtures/all_fields_action_toc3_cli.output | 4 ++--
 __tests__/fixtures/all_fields_readme.output          | 4 ++--
 __tests__/fixtures/all_fields_readme.output.crlf     | 4 ++--
 __tests__/fixtures/all_fields_readme_filled.input    | 4 ++--
 __tests__/fixtures/all_fields_readme_filled.output   | 4 ++--
 __tests__/fixtures/default.output                    | 4 ++--
 src/action-docs.ts                                   | 2 +-
 9 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/__tests__/fixtures/all_fields_action.output b/__tests__/fixtures/all_fields_action.output
index 6a29fd39..a35a1e82 100644
--- a/__tests__/fixtures/all_fields_action.output
+++ b/__tests__/fixtures/all_fields_action.output
@@ -5,7 +5,7 @@ Default test
 ## Inputs
 
 | parameter | description | required | default |
-| - | - | - | - |
+| --- | --- | --- | --- |
 | inputA | A description A | `false` |  |
 | inputB | A description B | `true` |  |
 | inputC | A description C | `true` | C |
@@ -16,7 +16,7 @@ Default test
 ## Outputs
 
 | parameter | description |
-| - | - |
+| --- | --- |
 | outputA | A description A |
 | outputB | A description B |
 
diff --git a/__tests__/fixtures/all_fields_action_toc1.output b/__tests__/fixtures/all_fields_action_toc1.output
index d1004139..1000879a 100644
--- a/__tests__/fixtures/all_fields_action_toc1.output
+++ b/__tests__/fixtures/all_fields_action_toc1.output
@@ -5,7 +5,7 @@ Default test
 # Inputs
 
 | parameter | description | required | default |
-| - | - | - | - |
+| --- | --- | --- | --- |
 | inputA | A description A | `false` |  |
 | inputB | A description B | `true` |  |
 | inputC | A description C | `true` | C |
@@ -16,7 +16,7 @@ Default test
 # Outputs
 
 | parameter | description |
-| - | - |
+| --- | --- |
 | outputA | A description A |
 | outputB | A description B |
 
diff --git a/__tests__/fixtures/all_fields_action_toc3_cli.output b/__tests__/fixtures/all_fields_action_toc3_cli.output
index 42be0844..fa49f895 100644
--- a/__tests__/fixtures/all_fields_action_toc3_cli.output
+++ b/__tests__/fixtures/all_fields_action_toc3_cli.output
@@ -5,7 +5,7 @@ Default test
 ### Inputs
 
 | parameter | description | required | default |
-| - | - | - | - |
+| --- | --- | --- | --- |
 | inputA | A description A | `false` |  |
 | inputB | A description B | `true` |  |
 | inputC | A description C | `true` | C |
@@ -16,7 +16,7 @@ Default test
 ### Outputs
 
 | parameter | description |
-| - | - |
+| --- | --- |
 | outputA | A description A |
 | outputB | A description B |
 
diff --git a/__tests__/fixtures/all_fields_readme.output b/__tests__/fixtures/all_fields_readme.output
index 335d6db0..6326bb48 100644
--- a/__tests__/fixtures/all_fields_readme.output
+++ b/__tests__/fixtures/all_fields_readme.output
@@ -10,7 +10,7 @@ Default test
 ## Inputs
 
 | parameter | description | required | default |
-| - | - | - | - |
+| --- | --- | --- | --- |
 | inputA | A description A | `false` |  |
 | inputB | A description B | `true` |  |
 | inputC | A description C | `true` | C |
@@ -25,7 +25,7 @@ Default test
 ## Outputs
 
 | parameter | description |
-| - | - |
+| --- | --- |
 | outputA | A description A |
 | outputB | A description B |
 
diff --git a/__tests__/fixtures/all_fields_readme.output.crlf b/__tests__/fixtures/all_fields_readme.output.crlf
index ed3cb1d8..f34ff4a6 100644
--- a/__tests__/fixtures/all_fields_readme.output.crlf
+++ b/__tests__/fixtures/all_fields_readme.output.crlf
@@ -10,7 +10,7 @@ Default test
 ## Inputs
 
 | parameter | description | required | default |
-| - | - | - | - |
+| --- | --- | --- | --- |
 | inputA | A description A | `false` |  |
 | inputB | A description B | `true` |  |
 | inputC | A description C | `true` | C |
@@ -25,7 +25,7 @@ Default test
 ## Outputs
 
 | parameter | description |
-| - | - |
+| --- | --- |
 | outputA | A description A |
 | outputB | A description B |
 
diff --git a/__tests__/fixtures/all_fields_readme_filled.input b/__tests__/fixtures/all_fields_readme_filled.input
index c7f80039..e7950ef5 100644
--- a/__tests__/fixtures/all_fields_readme_filled.input
+++ b/__tests__/fixtures/all_fields_readme_filled.input
@@ -10,7 +10,7 @@ Default test abc
 ## Inputs
 
 | parameter | description | required | default |
-| - | - | - | - |
+| --- | --- | --- | --- |
 | inputA | A description A | `false` |  |
 | inputB | A description B | `true` |  |
 | inputD | A description D | `false` | D |
@@ -24,7 +24,7 @@ Default test abc
 ## Outputs
 
 | parameter | description |
-| - | - |
+| --- | --- |
 | outputB | A description B |
 
 
diff --git a/__tests__/fixtures/all_fields_readme_filled.output b/__tests__/fixtures/all_fields_readme_filled.output
index 335d6db0..6326bb48 100644
--- a/__tests__/fixtures/all_fields_readme_filled.output
+++ b/__tests__/fixtures/all_fields_readme_filled.output
@@ -10,7 +10,7 @@ Default test
 ## Inputs
 
 | parameter | description | required | default |
-| - | - | - | - |
+| --- | --- | --- | --- |
 | inputA | A description A | `false` |  |
 | inputB | A description B | `true` |  |
 | inputC | A description C | `true` | C |
@@ -25,7 +25,7 @@ Default test
 ## Outputs
 
 | parameter | description |
-| - | - |
+| --- | --- |
 | outputA | A description A |
 | outputB | A description B |
 
diff --git a/__tests__/fixtures/default.output b/__tests__/fixtures/default.output
index 31f1209d..d0be2851 100644
--- a/__tests__/fixtures/default.output
+++ b/__tests__/fixtures/default.output
@@ -5,14 +5,14 @@ Default test
 ## Inputs
 
 | parameter | description | required | default |
-| - | - | - | - |
+| --- | --- | --- | --- |
 | inputA | A description | `false` | test |
 
 
 ## Outputs
 
 | parameter | description |
-| - | - |
+| --- | --- |
 | outputA | A description |
 
 
diff --git a/src/action-docs.ts b/src/action-docs.ts
index 43c92c69..4b8343b5 100644
--- a/src/action-docs.ts
+++ b/src/action-docs.ts
@@ -176,7 +176,7 @@ function getInputOutput(
     type === "input"
       ? ["parameter", "description", "required", "default"]
       : ["parameter", "description"];
-  headers[1] = Array(headers[0].length).fill("-");
+  headers[1] = Array(headers[0].length).fill("---");
 
   for (let i = 0; i < Object.keys(data).length; i++) {
     const key = Object.keys(data)[i];