Merge pull request #1575 from TriliumNext/chore_eslint-formatting

chore: use eslint for formatting and replace dprint

Author: eliandoran

.dprint.json

@@ -4,6 +4,7 @@
     "editorconfig.editorconfig",
     "vitest.explorer",
     "ms-playwright.playwright",
-    "tobermory.es6-string-html"
+    "tobermory.es6-string-html",
+    "dbaeumer.vscode-eslint"
   ]
 }

.vscode/extensions.json

@@ -24,8 +24,8 @@ export default tseslint.config(
             "@typescript-eslint/no-unused-vars": [
                 "error",
                 {
-                    "argsIgnorePattern": "^_",
-                    "varsIgnorePattern": "^_",
+                    argsIgnorePattern: "^_",
+                    varsIgnorePattern: "^_"
                 }
             ]
         }
@@ -35,6 +35,7 @@ export default tseslint.config(
             "build/*",
             "dist/*",
             "docs/*",
+            "demo/*",
             "libraries/*",
             "src/public/app-dist/*",
             "src/public/app/doc_notes/*"

eslint.config.js

@@ -0,0 +1,48 @@
+import stylistic from "@stylistic/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+
+// eslint config just for formatting rules
+// potentially to be merged with the linting rules into one single config,
+// once we have fixed the majority of lint errors
+
+// Go to https://eslint.style/rules/default/${rule_without_prefix} to check the rule details
+export const stylisticRules = {
+    "@stylistic/indent": [ "error", 4 ],
+    "@stylistic/quotes": [ "error", "double", { avoidEscape: true, allowTemplateLiterals: "always" } ],
+    "@stylistic/semi": [ "error", "always" ],
+    "@stylistic/quote-props": [ "error", "consistent-as-needed" ],
+    "@stylistic/max-len": [ "error", { code: 100 } ],
+    "@stylistic/comma-dangle": [ "error", "never" ],
+    "@stylistic/linebreak-style": [ "error", "unix" ],
+    "@stylistic/array-bracket-spacing": [ "error", "always" ],
+    "@stylistic/object-curly-spacing": [ "error", "always" ],
+    "@stylistic/padded-blocks": [ "error", { classes: "always" } ]
+};
+
+export default [
+    {
+        files: [ "**/*.{js,ts,mjs,cjs}" ],
+        languageOptions: {
+            parser: tsParser
+        },
+        plugins: {
+            "@stylistic": stylistic
+        },
+        rules: {
+            ...stylisticRules
+        }
+    },
+    {
+        ignores: [
+            "build/*",
+            "dist/*",
+            "docs/*",
+            "demo/*",
+            "libraries/*",
+            // TriliumNextTODO: check if we want to format packages here as well - for now skipping it
+            "packages/*",
+            "src/public/app-dist/*",
+            "src/public/app/doc_notes/*"
+        ]
+    }
+];

eslint.format.config.js

@@ -59,8 +59,8 @@
     "test:integration-mem-db": "cross-env TRILIUM_INTEGRATION_TEST=memory TRILIUM_PORT=8082 TRILIUM_DATA_DIR=./integration-tests/db nodemon src/main.ts",
     "test:integration-mem-db-dev": "cross-env TRILIUM_INTEGRATION_TEST=memory TRILIUM_PORT=8082 TRILIUM_ENV=dev TRILIUM_DATA_DIR=./integration-tests/db nodemon src/main.ts",
     "dev:watch-dist": "tsx ./bin/watch-dist.ts",
-    "dev:format-check": "dprint check",
-    "dev:format-fix": "dprint fmt",
+    "dev:format-check": "eslint -c eslint.format.config.js .",
+    "dev:format-fix": "eslint -c eslint.format.config.js . --fix",
     "dev:linter-check": "eslint .",
     "dev:linter-fix": "eslint . --fix",
     "chore:update-build-info": "tsx bin/update-build-info.ts",
@@ -174,6 +174,7 @@
     "@mind-elixir/node-menu": "1.0.5",
     "@playwright/test": "1.51.1",
     "@popperjs/core": "2.11.8",
+    "@stylistic/eslint-plugin": "4.2.0",
     "@types/archiver": "6.0.3",
     "@types/better-sqlite3": "7.6.12",
     "@types/bootstrap": "5.2.10",
@@ -219,7 +220,7 @@
     "bootstrap": "5.3.3",
     "copy-webpack-plugin": "13.0.0",
     "cross-env": "7.0.3",
-    "css-loader": "7.1.2",    
+    "css-loader": "7.1.2",
     "electron": "35.1.2",
     "eslint": "9.23.0",
     "esm": "3.2.25",
@@ -258,7 +259,6 @@
     "webpack-dev-middleware": "7.4.2"
   },
   "optionalDependencies": {
-    "appdmg": "0.6.6",
-    "dprint": "0.49.1"
+    "appdmg": "0.6.6"
   }
 }

package-lock.json

@@ -14,7 +14,7 @@
     "esModuleInterop": true,
     "verbatimModuleSyntax": true
   },
-  "include": ["./src/**/*.js", "./src/**/*.ts", "./*.ts", "./spec/**/*.ts"],
+  "include": ["./src/**/*.js", "./src/**/*.ts", "./*.ts", "./*.js", "./spec/**/*.ts"],
   "exclude": ["./node_modules/**/*", "./spec-es6/**/*.ts"],
   "files": ["src/types.d.ts", "src/public/app/types.d.ts"]
 }