Update prettier support to be more portable (#783)

* Update prettier support to be more portable

* Update .gitignore

* Enforce lf when possible and use auto otherwise

* Use npx to run node commands

* Set indent_size to 2 for md files

* Fix js and css linting configuration

* Fix unit test CRLF support

Author: bastien-boussouf

.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+indent_size = 2
+
+[*.{js,css}]
+indent_size = 2

.gitattributes

@@ -1,2 +1,2 @@
 # Auto detect text files and perform LF normalization
-* text=auto
+* text=auto eol=lf

.github/workflows/prettier.yml

@@ -28,7 +28,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install prettier and plugin-php
-        run: npm install --global [email protected] @prettier/[email protected]
+        run: npm i
 
       - name: Lint with Prettier
         continue-on-error: true

.gitignore

@@ -12,9 +12,10 @@ package-lock.json
 
 # Environment
 .env
+.php-version
 DOCKER_ENV
 docker_tag
 
 # IDE
 .vscode/
-.idea/
+.idea/

.prettierignore

@@ -1 +1,2 @@
 vendor
+**/*.min.js

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "printWidth": 120,
+  "endOfLine": "auto"
+}

composer.json

@@ -31,7 +31,7 @@
       "php -S localhost:8000 -t src"
     ],
     "test": "./vendor/bin/phpunit --testdox tests",
-    "lint": "prettier --check *.md **/*.{php,md,js,css} !**/*.min.js --print-width 120",
-    "lint-fix": "prettier --write *.md **/*.{php,md,js,css} !**/*.min.js --print-width 120"
+    "lint": "npx prettier --check *.md **/*.{php,md,js,css}",
+    "lint-fix": "npx prettier --write *.md **/*.{php,md,js,css}"
   }
 }

package.json

@@ -3,7 +3,7 @@
     "node": "18.x"
   },
   "devDependencies": {
-    "@prettier/plugin-php": "^0.18.8",
-    "prettier": "^2.6.2"
+    "@prettier/plugin-php": "^0.18.9",
+    "prettier": "^2.8.1"
   }
 }

tests/RenderTest.php

@@ -261,14 +261,13 @@ public function testFirstAndThirdColumnsSwappedWhenDirectionIsRtl(): void
     {
         $this->testParams["locale"] = "he";
         $render = generateOutput($this->testStats, $this->testParams)["body"];
-        $renderCollapsedSpaces = preg_replace("/(\s)\s*/", '$1', $render);
-        $this->assertStringContainsString(
-            "<!-- Total Contributions big number -->\n<g transform='translate(412.5, 48)'>",
-            $renderCollapsedSpaces
+        $this->assertMatchesRegularExpression(
+            "/<!-- Total Contributions big number -->\\s*<g transform='translate\\(412\\.5, 48\\)'>/",
+            $render
         );
-        $this->assertStringContainsString(
-            "<!-- Longest Streak big number -->\n<g transform='translate(82.5, 48)'>",
-            $renderCollapsedSpaces
+        $this->assertMatchesRegularExpression(
+            "/<!-- Longest Streak big number -->\\s*<g transform='translate\\(82\\.5, 48\\)'>/",
+            $render
         );
     }