Merge pull request #16 from alexrecuenco/feature/re-add-prettier

alexrecuenco · web-flow · commit 64eca933f260 · 2024-03-07T19:33:38.000+01:00
Adding prettier again
diff --git a/.eslintignore b/.eslintignore
@@ -5,6 +5,8 @@ dist/
 .vscode/
 node_modules/
 coverage/
+report/
 !*.js
 !*.ts
 !.vscode/*.json
+package-lock.json
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1 @@
-* text=auto eol=lf
+* text=auto eol=lf
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -1,14 +1,28 @@
 name: Node.js CI
 
-on: [push]
+on:
+  pull_request:
+  push:
+    branches: [main]
 
 jobs:
+  pre-commit:
+    env:
+      # Disabled because: [error] Cannot find package 'prettier-plugin-jsdoc' imported from /app/noop.js
+      SKIP: prettier
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          cache: 'pip'
+      - uses: pre-commit/action@v3.0.1
+
   build:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-      # Current versions not in maintainance
         node-version: [18.x, 20.x]
 
     steps:
@@ -21,5 +35,6 @@ jobs:
       - run: npm ci
       - run: npm test
       - run: npm run lint
+      - run: npm run format
       - run: npm run build:debug
       - run: npm run build:prod
diff --git a/.gitignore b/.gitignore
@@ -394,4 +394,4 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.gitignore.io/api/git,node,linux,macos,python,pycharm,windows,visualstudiocode
+# End of https://www.gitignore.io/api/git,node,linux,macos,python,pycharm,windows,visualstudiocode
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -14,8 +14,15 @@ repos: #The order matters, we want prospector to run after all the sorting was d
       - id: check-toml
       - id: check-xml
       - id: check-yaml
-      - id: detect-aws-credentials
+      # - id: detect-aws-credentials
       - id: detect-private-key
       # File normalization
       - id: end-of-file-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: 'v3.1.0'
+    hooks:
+      - id: prettier
+        additional_dependencies:
+          - prettier@3.2.5
+          - prettier-plugin-jsdoc@1.3.0
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,16 @@
+**/.git
+**/.svn
+**/.hg
+**/node_modules
+package-lock.json
+lib/
+build/
+build-*/
+dist/
+.vscode/
+node_modules/
+coverage/
+report/
+!*.js
+!*.ts
+!.vscode/*.json
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,10 +1,11 @@
 {
     "recommendations": [
         "dbaeumer.vscode-eslint",
+        "esbenp.prettier-vscode",
         "ghmcadams.lintlens",
         "visualstudioexptteam.vscodeintellicode",
         "wix.vscode-import-cost",
         "pmneo.tsimporter",
-        "orta.vscode-jest"
-    ]
+        "orta.vscode-jest",
+    ],
 }
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -13,7 +13,7 @@
             "preLaunchTask": "tsc: build - tsconfig.json",
             "outFiles": ["${workspaceFolder}/build/**/*.js"],
             "env": { "DEBUG": "*", "NODE_ENV": "development" },
-            "showAsyncStacks": true
+            "showAsyncStacks": true,
         },
         {
             "type": "node",
@@ -27,8 +27,8 @@
             "disableOptimisticBPs": true,
             "showAsyncStacks": true,
             "windows": {
-                "program": "${workspaceFolder}/node_modules/jest/bin/jest"
-            }
+                "program": "${workspaceFolder}/node_modules/jest/bin/jest",
+            },
         },
         {
             "type": "node",
@@ -42,8 +42,8 @@
             "disableOptimisticBPs": true,
             "showAsyncStacks": true,
             "windows": {
-                "program": "${workspaceFolder}/node_modules/jest/bin/jest"
-            }
-        }
-    ]
+                "program": "${workspaceFolder}/node_modules/jest/bin/jest",
+            },
+        },
+    ],
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,22 +1,18 @@
 {
-    "eslint.validate": [
-        "typescript",
-        "typescriptreact"
-    ],
+    "eslint.validate": ["typescript", "typescriptreact"],
     "editor.formatOnSave": true,
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.codeActionsOnSave": {
-        "source.organizeImports": "never"
+        "source.organizeImports": "never",
     },
-    "[javascript,typescript]": {
-        "editor.defaultFormatter": "dbaeumer.vscode-eslint",
-        "editor.codeActionsOnSave": {
-            "source.organizeImports": "never"
-        },
+    "editor.formatOnSaveMode": "modificationsIfAvailable",
+    "[javascript,typescript,jsonc,json]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSaveMode": "modificationsIfAvailable",
     },
     "eslint.experimental.useFlatConfig": true,
     "jest.jestCommandLine": "npm test -- ",
     "jest.runMode": {
-        "type": "on-demand"
-    }
+        "type": "on-demand",
+    },
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -7,31 +7,31 @@
             "type": "npm",
             "script": "build",
             "group": "build",
-            "problemMatcher": []
+            "problemMatcher": [],
         },
         {
             "type": "npm",
             "script": "lint",
-            "problemMatcher": []
+            "problemMatcher": [],
         },
         {
             "type": "npm",
             "script": "start",
-            "problemMatcher": []
+            "problemMatcher": [],
         },
         {
             "type": "typescript",
             "tsconfig": "tsconfig.json",
             "problemMatcher": ["$tsc"],
-            "group": "build"
+            "group": "build",
         },
         {
             "label": "tsc: watch",
             "type": "typescript",
             "tsconfig": "tsconfig.json",
             "option": "watch",
             "problemMatcher": ["$tsc-watch"],
-            "group": "build"
-        }
-    ]
+            "group": "build",
+        },
+    ],
 }
diff --git a/README.md b/README.md
@@ -2,10 +2,12 @@
 
 Example of typescript, eslint, and jest with property based testing.
 
-Possibly, you might want to delete the `.pre-commit-config.yaml` file if you are not using python anywhere.
-
-This is only tested with certain versions of node and npm, it might work with others, disable the `engine-strict=true` in the `.npmrc` file at your discretion.
+Possibly, you might want to delete the `.pre-commit-config.yaml` file if you are
+not using python anywhere.
 
+This is only tested with certain versions of node and npm, it might work with
+others, disable the `engine-strict=true` in the `.npmrc` file at your
+discretion.
 
 ## Check upgrades
 
diff --git a/__tests__/replace.test.ts b/__tests__/replace.test.ts
@@ -29,7 +29,7 @@ describe.each(EachSimpleType)(
             f,
             (t): t is any => !Array.isArray(t),
           )(arr);
-          const realResult = arr.map(v => f(v));
+          const realResult = arr.map((v) => f(v));
           expect(obtainedResult).toStrictEqual(realResult);
         }),
       );
diff --git a/eslint.config.js b/eslint.config.js
@@ -1,25 +1,23 @@
-const stylistic = require('@stylistic/eslint-plugin');
 const js = require('@eslint/js');
 const tseslint = require('typescript-eslint');
-
-const ts = require('@typescript-eslint/eslint-plugin');
+const eslintConfigPrettier = require('eslint-config-prettier');
 const tsParser = require('@typescript-eslint/parser');
 // When it works again do `npm install --save-dev eslint-plugin-import`
 // const imprt = require('eslint-plugin-import');
 // https://github.com/eslint/eslint/issues/18087
 // https://github.com/import-js/eslint-plugin-import/pull/2829
 const globals = require('globals');
 const jest = require('eslint-plugin-jest');
-const off = 'off';
 
+const off = 'off';
 const warn = 'warn';
-
 const error = 'error';
 
 // const TEST_ONLY_IMPORTS = ['fast-check', 'jest'];
 
 /**
- * set of typescript-eslint any rules
+ * Set of typescript-eslint any rules
+ *
  * @param {'error' | 'warn' | 'off'} level
  * @returns
  */
@@ -37,7 +35,9 @@ const any_rules = (level) => {
 
 module.exports = [
   js.configs.recommended,
+  tseslint.configs.eslintRecommended,
   ...tseslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
   {
     languageOptions: {
       globals: globals.node,
@@ -54,19 +54,6 @@ module.exports = [
       },
     },
   },
-  stylistic.configs['recommended-flat'],
-  stylistic.configs.customize({
-    // the following options are the default values
-    semi: true,
-  }),
-  {
-    languageOptions: { parser: tsParser },
-    plugins: {
-      // 'import': imprt,
-      '@stylistic': stylistic,
-      ts,
-    },
-  },
   {
     ignores: [
       '**/node_modules',
@@ -78,11 +65,10 @@ module.exports = [
       '**/report',
     ],
   },
+  // Disables all styling from eslint
+  eslintConfigPrettier,
   {
     rules: {
-      ...ts.configs['eslint-recommended'].rules,
-      ...ts.configs['recommended'].rules,
-      ...ts.configs['recommended-requiring-type-checking'].rules,
       // ...imprt.configs['errors'].rules,
       // ...imprt.configs['warnings'].rules,
       // ...imprt.configs['typescript'].rules,
@@ -91,7 +77,7 @@ module.exports = [
       '@typescript-eslint/return-await': ['error', 'always'],
       'no-unused-vars': off,
       '@typescript-eslint/no-unused-vars': error,
-      'eqeqeq': [error, 'smart'],
+      eqeqeq: [error, 'smart'],
       'no-else-return': [
         error,
         {
diff --git a/jest.setup.ts b/jest.setup.ts
@@ -1,6 +1,6 @@
 /**
  * Setup to work together fast-check and jest from the fast-check examples
- *  https://github.com/dubzzz/fast-check/blob/1ceb2b982b754b99aef8d763723206605b67451e/example/jest.setup.js
+ * https://github.com/dubzzz/fast-check/blob/1ceb2b982b754b99aef8d763723206605b67451e/example/jest.setup.js
  */
 
 import fc from 'fast-check';
@@ -9,8 +9,8 @@ import fc from 'fast-check';
 const JestTimeoutMs = 60000;
 const FcTimeoutMs = Math.floor(0.8 * JestTimeoutMs);
 
-const verbose
-  = process.env.DEBUG === undefined
+const verbose =
+  process.env.DEBUG === undefined
     ? fc.VerbosityLevel.None
     : process.env.DEBUG !== '*'
       ? fc.VerbosityLevel.Verbose
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/prettier.config.js b/prettier.config.js
diff --git a/tsconfig.eslint.json b/tsconfig.eslint.json
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/tsconfig.prod.json b/tsconfig.prod.json

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-* text=auto eol=lf`
	`1`	`+* text=auto eol=lf`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,11 @@`
`1`	`1`	`{`
`2`	`2`	`"recommendations": [`
`3`	`3`	`"dbaeumer.vscode-eslint",`
	`4`	`+ "esbenp.prettier-vscode",`
`4`	`5`	`"ghmcadams.lintlens",`
`5`	`6`	`"visualstudioexptteam.vscodeintellicode",`
`6`	`7`	`"wix.vscode-import-cost",`
`7`	`8`	`"pmneo.tsimporter",`
`8`		`- "orta.vscode-jest"`
`9`		`- ]`
	`9`	`+ "orta.vscode-jest",`
	`10`	`+ ],`
`10`	`11`	`}`