chore: Improve Windows contributing experience (#908)

* chore: Use gitattributes to enforce linebreak style instead of eslint
* docs: Fix readme generation on Windows
* docs: Visualize carriage return character in readme

.eslintrc.json

@@ -36,6 +36,7 @@
     "unicorn/no-array-reduce": 0,
     "unicorn/no-unsafe-regex": 0,
     "unicorn/prefer-array-some": 0,
-    "unicorn/prevent-abbreviations": 0
+    "unicorn/prevent-abbreviations": 0,
+    "linebreak-style": 0
   }
 }

.gitattributes

@@ -0,0 +1,3 @@
+# Use LF line endings on all files by default.
+# Allows safely disabling the "linebreak-style" linting rule.
+* text eol=lf

.gitignore

@@ -9,6 +9,7 @@ pnpm-lock.yaml
 !.editorconfig
 !.eslintrc.json
 !.eslintignore
+!.gitattributes
 !.gitignore
 !.npmignore
 !.README

README.md

@@ -2403,14 +2403,14 @@ const fn = ( lorem, sit ) => {}
 // Message: Expected JSDoc block lines to not be aligned.
 
 
-       /**
-        * Function description.
-        *
-        * @param {string} lorem Description.
-        * @param {int} sit Description multi words.
-        * @param {string} sth   Multi
-        *                       line description.
-        */
+       /**\r
+        * Function description.\r
+        *\r
+        * @param {string} lorem Description.\r
+        * @param {int} sit Description multi words.\r
+        * @param {string} sth   Multi\r
+        *                       line description.\r
+        */\r
        const fn = ( lorem, sit ) => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "always"]
 // Message: Expected JSDoc block lines to be aligned.
@@ -2671,14 +2671,14 @@ const fn = ({ids}) => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "always"]
 
 
-       /**
-        * Function description.
-        *
-        * @param {string} lorem Description.
-        * @param {int}    sit   Description multi words.
-        * @param {string} sth   Multi
-        *                       line description.
-        */
+       /**\r
+        * Function description.\r
+        *\r
+        * @param {string} lorem Description.\r
+        * @param {int}    sit   Description multi words.\r
+        * @param {string} sth   Multi\r
+        *                       line description.\r
+        */\r
        const fn = ( lorem, sit ) => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "always"]
 
@@ -6288,7 +6288,7 @@ function quux (foo) {
 
 /**
  * @module test
- * @license MIT
+ * @license MIT\r
  */
 'use strict';
 
@@ -8365,14 +8365,14 @@ function quux () {
 // Message: There must be no newline after the description of the JSDoc block.
 
 
-         /**
-          * Bar.
-          *
-          * Bar.
-          *
-          * @bar
-          */
-         function quux () {
+         /**\r
+          * Bar.\r
+          *\r
+          * Bar.\r
+          *\r
+          * @bar\r
+          */\r
+         function quux () {\r
 
          }
 // "jsdoc/newline-after-description": ["error"|"warn", "never"]
@@ -8396,12 +8396,12 @@ function quux () {
 // Message: There must be a newline after the description of the JSDoc block.
 
 
-     /**
-      * Service for fetching symbols.
-      * @param {object} $http - Injected http helper.
-      * @param {object} $q - Injected Promise api helper.
-      * @param {object} $location - Injected window location object.
-      * @param {object} REPORT_DIALOG_CONSTANTS - Injected handle.
+     /**\r
+      * Service for fetching symbols.\r
+      * @param {object} $http - Injected http helper.\r
+      * @param {object} $q - Injected Promise api helper.\r
+      * @param {object} $location - Injected window location object.\r
+      * @param {object} REPORT_DIALOG_CONSTANTS - Injected handle.\r
       */
 // Message: There must be a newline after the description of the JSDoc block.
 
@@ -8464,20 +8464,20 @@ function quux () {
 // "jsdoc/newline-after-description": ["error"|"warn", "never"]
 
 
-     /**
-      * @foo
-      * Test 
-      * abc 
-      * @bar 
+     /**\r
+      * @foo\r
+      * Test \r
+      * abc \r
+      * @bar \r
       */
 
 
-     /**
-      * 
-      * @foo
-      * Test 
-      * abc 
-      * @bar 
+     /**\r
+      * \r
+      * @foo\r
+      * Test \r
+      * abc \r
+      * @bar \r
       */
 
 /***
@@ -8488,16 +8488,16 @@ function quux () {
 }
 // "jsdoc/newline-after-description": ["error"|"warn", "always"]
 
-/**
- * Parses query string to object containing URL parameters
- * 
- * @param queryString
- * Input string
- * 
- * @returns
- * Object containing URL parameters
- */
-export function parseQueryString(queryString: string): { [key: string]: string } {    // <-- Line 10 that fails
+/**\r
+ * Parses query string to object containing URL parameters\r
+ * \r
+ * @param queryString\r
+ * Input string\r
+ * \r
+ * @returns\r
+ * Object containing URL parameters\r
+ */\r
+export function parseQueryString(queryString: string): { [key: string]: string } {    // <-- Line 10 that fails\r
 
 }
 

src/bin/generateReadme.js

@@ -25,7 +25,7 @@ const trimCode = (code) => {
     return line.slice(lineIndentSize);
   });
 
-  return lines.join('\n');
+  return lines.join('\n').replaceAll('\r', '\\r');
 };
 
 const formatCodeSnippet = (setup, ruleName) => {
@@ -49,7 +49,7 @@ const formatCodeSnippet = (setup, ruleName) => {
 };
 
 const getAssertions = () => {
-  const assertionFiles = glob.sync(path.resolve(__dirname, '../../test/rules/assertions/*.js'));
+  const assertionFiles = glob.sync(path.resolve(__dirname, '../../test/rules/assertions/*.js').replaceAll('\\', '/'));
 
   const assertionNames = assertionFiles.map((filePath) => {
     return path.basename(filePath, '.js');