feat: Ability to force crlf

Config now includes force-crlf boolean option that makes sure, while enabled, json output prints with \r\n as new line characters. Default remains \n.

Example usage:

{
  "patterns": ["**/*.json", "!**/node_modules/**/*", "!**/dist/**"],
  ....
  "force-crlf": true
}

Usage with CLI matches other boolean arguments.

* [Feature] Ability to force crlf
* [Fix] stricter comparison when deciding to use crlf
* [Chore] Update remaining docs

Author: TDiblik

README.md

@@ -163,6 +163,7 @@ Usage: `jsonlint [options] [--] [<file, directory, pattern> ...]`
     --enforce-double-quotes      surrounds all strings with double quotes
     --enforce-single-quotes      surrounds all strings with single quotes
     --trim-trailing-commas       omit trailing commas from objects and arrays
+    --force-crlf                 makes sure all line breaks are CRLF
     --succeed-with-no-files      succeed (exit code 0) if no files were found
     --[no-]color                 force or disable colourful output of the diff
     -v, --version                output the version number
@@ -237,6 +238,7 @@ The configuration is an object with the following properties, described above, w
 | enforce-double-quotes | enforceDoubleQuotes |
 | enforce-single-quotes | enforceSingleQuotes |
 | trim-trailing-commas | trimTrailingCommas |
+| force-crlf | forceCrlf |
 
 The parameter `config` will be ignored in configuration files. The extra parameter `patterns` can be set to an array of strings with paths or patterns instead of putting them to the command line.
 
@@ -347,6 +349,7 @@ The [`print`](#pretty-printing) method accepts an object `options` as the second
 | `enforceDoubleQuotes`       | will surround all strings with double quotes            |
 | `enforceSingleQuotes`       | will surround all strings with single quotes            |
 | `trimTrailingCommas`        | will omit all trailing commas after the last object entry or array item |
+| `forceCrlf`                 | makes sure all line breaks are CRLF |
 
 ```js
 // Just concatenate the tokens to produce the same output as was the input.
@@ -371,6 +374,8 @@ print(tokens, {
   enforceDoubleQuotes: true,
   trimTrailingCommas: true
 })
+// Same as `print(tokens, {})`, but uses \r\n for line breaks.
+print(tokens, { forceCrlf: true })
 ```
 
 Pretty-printing can be also used to preserve the contents of string literal in the output. For example, the following input:

lib/cli.js

@@ -61,6 +61,7 @@ Options:
   --enforce-double-quotes      surrounds all strings with double quotes
   --enforce-single-quotes      surrounds all strings with single quotes
   --trim-trailing-commas       omit trailing commas from objects and arrays
+  --force-crlf                 makes sure all line breaks are CRLF
   --succeed-with-no-files      succeed (exit code 0) if no files were found
   --[no-]color                 force or disable colourful output of the diff
   -v, --version                output the version number
@@ -241,6 +242,9 @@ for (let i = 2, l = argv.length; i < l; ++i) {
         case 'trim-trailing-commas':
           params.trimTrailingCommas = flag
           return
+        case 'force-crlf':
+          params.forceCrlf = flag
+          return
         case 'succeed-with-no-files':
           params.succeedWithNoFiles = flag
           return
@@ -281,6 +285,7 @@ const paramNames = {
   'enforce-double-quotes': 'enforceDoubleQuotes',
   'enforce-single-quotes': 'enforceSingleQuotes',
   'trim-trailing-commas': 'trimTrailingCommas',
+  'force-crlf': 'forceCrlf',
   'sort-keys': 'sortKeys',
   'sort-keys-ignore-case': 'sortKeysIgnoreCase',
   'sort-keys-locale': 'sortKeysLocale',
@@ -390,7 +395,8 @@ function processContents (source, file) {
         stripObjectKeys: params.stripObjectKeys,
         enforceDoubleQuotes: params.enforceDoubleQuotes,
         enforceSingleQuotes: params.enforceSingleQuotes,
-        trimTrailingCommas: params.trimTrailingCommas
+        trimTrailingCommas: params.trimTrailingCommas,
+        forceCrlf: params.forceCrlf
       })
     }
     const sortOptions = {}
@@ -458,7 +464,7 @@ function ensureLineBreak (parsed, source) {
   const newLine = !lines[lines.length - 1]
   if (params.trailingNewline === true ||
       (params.trailingNewline !== false && newLine)) {
-    parsed += '\n'
+    parsed += params.forceCrlf === true ? "\r\n" : "\n"
   }
   return parsed
 }

lib/index.d.ts

@@ -506,6 +506,11 @@ declare module '@prantlf/jsonlint/lib/printer' {
      * Remove trailing commas after the last item in objects and arrays.
      */
     trimTrailingCommas?: boolean
+
+    /**
+     * Makes sure all line breaks are CRLF.
+     */
+    forceCrlf?: boolean
   }
 
   /**

lib/printer.js

@@ -48,6 +48,7 @@
     const enforceDoubleQuotes = options.enforceDoubleQuotes
     const enforceSingleQuotes = options.enforceSingleQuotes
     const trimTrailingCommas = options.trimTrailingCommas
+    const newLineChar = options.forceCrlf === true ? "\r\n" : "\n"
 
     let outputString = ''
     let foundLineBreak
@@ -90,7 +91,7 @@
     let addDelayedSpaceOrLineBreak
     if (prettyPrint) {
       addLineBreak = function () {
-        outputString += '\n'
+        outputString += newLineChar
       }
 
       addDelayedSpaceOrLineBreak = function () {

test/types.test.ts

@@ -71,5 +71,6 @@ test('print', () => {
   print(tokens, { enforceDoubleQuotes: true })
   print(tokens, { enforceSingleQuotes: true })
   print(tokens, { trimTrailingCommas: true })
+  print(tokens, { forceCrlf: true })
   assert.ok(true)
 })