feat: support CR and CRLF line breaks (#13)

Author: npalm

.editorconfig

@@ -0,0 +1,7 @@
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.crlf]
+end_of_line = crlf
+tab_width = 20

.gitignore

@@ -94,4 +94,5 @@ typings/
 .DS_Store
 Thumbs.db
 
-.npmrc
+.npmrc
+lib

README.md

@@ -41,13 +41,15 @@ The following options are available via the CLI
 
 ```
 Options:
-      --help           Show help                                       [boolean]
-      --version        Show version number                             [boolean]
-  -t, --toc-level      TOC level used for markdown
+      --help               Show help                                   [boolean]
+      --version            Show version number                         [boolean]
+  -t, --toc-level          TOC level used for markdown
                                                 [number] [required] [default: 2]
-  -a, --action         GitHub action file       [string] [default: "action.yml"]
-      --no-banner      Print no banner
-  -u, --update-readme  Update readme file.                              [string]
+  -a, --action             GitHub action file   [string] [default: "action.yml"]
+      --no-banner          Print no banner
+  -u, --update-readme      Update readme file.                          [string]
+      --line-breaks, --lb  Used line breaks in the generated docs.
+                          [string] [choices: "CR", "LF", "CRLF"] [default: "LF"]
 ```
 
 

__tests__/index.test.ts renamed to __tests__/action-docs.test.ts

@@ -1,5 +1,6 @@
-import { generateActionMarkdownDocs } from "../src";
+import { generateActionMarkdownDocs, Options } from "../src";
 import { readFileSync, writeFileSync } from "fs";
+import { option } from "yargs";
 
 test("With defaults.", async () => {
   const markdown = await generateActionMarkdownDocs();
@@ -48,10 +49,20 @@ test("Update filled readme (all fields)", async () => {
   );
 });
 
+test("Update readme (all fields) CRLF", async () => {
+  await testReadme(
+    "__tests__/fixtures/all_fields_action.yml.crlf",
+    "__tests__/fixtures/all_fields_readme.input.crlf",
+    "__tests__/fixtures/all_fields_readme.output.crlf",
+    { lineBreaks: "CRLF" }
+  );
+});
+
 async function testReadme(
   actionFile: string,
   originalReadme: string,
-  fixtureReadme: string
+  fixtureReadme: string,
+  overwriteOptions?: Options
 ) {
   const expected = <string>readFileSync(fixtureReadme, "utf-8");
   const original = <string>readFileSync(originalReadme, "utf-8");
@@ -60,6 +71,7 @@ async function testReadme(
     actionFile: actionFile,
     updateReadme: true,
     readmeFile: originalReadme,
+    ...overwriteOptions,
   });
 
   const updated = <string>readFileSync(originalReadme, "utf-8");

__tests__/fixtures/all_fields_action.yml.crlf

@@ -0,0 +1,28 @@
+name: 'An Action'
+description: 'Default test'
+author: 'Niek Palm'
+inputs:
+  inputA:
+    description: 'A description A'
+    required: false
+  inputB:     
+    description: 'A description B'
+    required: true
+  inputC:
+    description: 'A description C'
+    required: true
+    default: C
+  inputD:
+    description: 'A description D'
+    required: false
+    default: D
+
+outputs:
+  outputA:
+    description: 'A description A'
+  outputB:
+    description: 'A description B'
+
+runs:
+  using: 'node12'
+  main: 'dist/index.js'

__tests__/fixtures/all_fields_readme.input.crlf

@@ -0,0 +1,7 @@
+<!-- action-docs-description -->
+
+<!-- action-docs-inputs -->
+
+<!-- action-docs-outputs -->
+
+<!-- action-docs-runs -->

__tests__/fixtures/all_fields_readme copy 2.md renamed to __tests__/fixtures/all_fields_readme.output.crlf

@@ -1,33 +1,41 @@
-<!-- action-docs-description -->
-## Description
-
-Default test
-
-
-<!-- action-docs-description -->
-
-<!-- action-docs-inputs -->
-## Inputs
-
-| parameter | description | required | default |
-| - | - | - | - |
-| inputA | A description A | `false` |  |
-| inputB | A description B | `true` |  |
-| inputC | A description C | `true` | C |
-| inputD | A description D | `false` | D |
-
-
-
-<!-- action-docs-inputs -->
-
-<!-- action-docs-outputs -->
-## Outputs
-
-| parameter | description |
-| - | - |
-| outputA | A description A |
-| outputB | A description B |
-
-
-
-<!-- action-docs-outputs -->
+<!-- action-docs-description -->
+## Description
+
+Default test
+
+
+<!-- action-docs-description -->
+
+<!-- action-docs-inputs -->
+## Inputs
+
+| parameter | description | required | default |
+| - | - | - | - |
+| inputA | A description A | `false` |  |
+| inputB | A description B | `true` |  |
+| inputC | A description C | `true` | C |
+| inputD | A description D | `false` | D |
+
+
+
+<!-- action-docs-inputs -->
+
+<!-- action-docs-outputs -->
+## Outputs
+
+| parameter | description |
+| - | - |
+| outputA | A description A |
+| outputB | A description B |
+
+
+
+<!-- action-docs-outputs -->
+
+<!-- action-docs-runs -->
+## Runs
+
+This action is an `node12` action.
+
+
+<!-- action-docs-runs -->

__tests__/linebreak.test.ts

@@ -0,0 +1,14 @@
+import * as lb from "../src/linebreak";
+
+test("Line break types", () => {
+  expect(lb.getLineBreakType("CR")).toEqual("CR");
+  expect(lb.getLineBreakType("CRLF")).toEqual("CRLF");
+  expect(lb.getLineBreakType("LF")).toEqual("LF");
+  expect(lb.getLineBreakType("unknown")).toEqual("LF");
+});
+
+test("Line break types", () => {
+  expect(lb.getLineBreak("CR")).toEqual("\r");
+  expect(lb.getLineBreak("CRLF")).toEqual("\r\n");
+  expect(lb.getLineBreak("LF")).toEqual("\n");
+});

package-lock.json

@@ -54,7 +54,7 @@
     "@types/jest": "^26.0.15",
     "@types/js-yaml": "^4.0.0",
     "@types/node": "^14.14.30",
-    "@typescript-eslint/parser": "^4.8.1",
+    "@typescript-eslint/parser": "^4.16.1",
     "conventional-changelog-conventionalcommits": "^4.5.0",
     "eslint": "^7.17.0",
     "eslint-plugin-github": "^4.1.1",
@@ -74,4 +74,4 @@
   "directories": {
     "dist": "lib"
   }
-}
+}