Re-add prettier

- Re-add prettier as completely separate
- Remove stylist as part of the linter
- jsonc formatting for required files
- Formatting markdown as well!
- Added formatting and pre-commit to github actions

Author: alexrecuenco

.eslintignore

@@ -5,6 +5,8 @@ dist/
 .vscode/
 node_modules/
 coverage/
+report/
 !*.js
 !*.ts
 !.vscode/*.json
+package-lock.json

.github/workflows/main.yml

@@ -1,14 +1,25 @@
 name: Node.js CI
 
-on: [push]
+on:
+  pull_request:
+  push:
+    branches: [main]
 
 jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          cache: 'pip'
+      - uses: pre-commit/[email protected]
+
   build:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-      # Current versions not in maintainance
         node-version: [18.x, 20.x]
 
     steps:
@@ -21,5 +32,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

.pre-commit-config.yaml

@@ -19,3 +19,7 @@ repos: #The order matters, we want prospector to run after all the sorting was d
       # File normalization
       - id: end-of-file-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: 'v3.1.0' # Use the sha or tag you want to point at
+    hooks:
+      - id: prettier

.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

.vscode/extensions.json

@@ -1,6 +1,7 @@
 {
     "recommendations": [
         "dbaeumer.vscode-eslint",
+        "esbenp.prettier-vscode",
         "ghmcadams.lintlens",
         "visualstudioexptteam.vscodeintellicode",
         "wix.vscode-import-cost",

.vscode/settings.json

@@ -4,12 +4,12 @@
         "typescriptreact"
     ],
     "editor.formatOnSave": true,
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.codeActionsOnSave": {
         "source.organizeImports": "never"
     },
     "[javascript,typescript]": {
-        "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
         "editor.codeActionsOnSave": {
             "source.organizeImports": "never"
         },

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
 

eslint.config.js

@@ -1,19 +1,16 @@
-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'];
@@ -37,7 +34,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 +53,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 +64,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 +76,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,
         {