style: 🚨 Use eslint and separate config files

embedding configs in package.json has proven less reliable than separate config files as tools have updated over time
fixing the configs revealed a handful of linting errors
xo is still great for including many strict rules, but eslint actually works more reliably
xo is still used for eslint rules
npm-package-json-lint seemed to stop working entirely but keeping prettier-plugin-packagejson seems to do all we need

Signed-off-by: Eric Nemchik <[email protected]>

Author: nemchik

.eslintrc.json

@@ -0,0 +1,33 @@
+{
+    "extends": [
+        "plugin:unicorn/recommended",
+        "plugin:import/recommended",
+        "plugin:import/typescript",
+        "plugin:n/recommended",
+        "xo",
+        "xo-typescript/space",
+        "prettier"
+    ],
+    "settings": {
+        "import/resolver": {
+            "typescript": true,
+            "node": true
+        }
+    },
+    "rules": {
+        "@typescript-eslint/consistent-type-definitions": ["error", "interface"],
+        "unicorn/filename-case": [
+            "error",
+            {
+                "case": "camelCase",
+                "ignore": ["^lint-staged\\.config\\.js$"]
+            }
+        ],
+        "import/order": [
+            "error",
+            {
+                "groups": [["builtin", "external"], "parent", "sibling", "index"]
+            }
+        ]
+    }
+}

.github/workflows/docker-publish.yml

@@ -2,11 +2,11 @@ name: Docker
 
 on:
   push:
-    branches: [ "main", "unstable" ]
+    branches: ['main', 'unstable']
     # Publish semver tags as releases.
-    tags: [ 'v*.*' ]
+    tags: ['v*.*']
   pull_request:
-    branches: [ "main" ]
+    branches: ['main']
 
 env:
   # Use docker.io for Docker Hub if empty
@@ -16,7 +16,6 @@ env:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -62,4 +61,4 @@ jobs:
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           cache-from: type=gha
-          cache-to: type=gha,mode=max
+          cache-to: type=gha,mode=max

.vscode/extensions.json

@@ -1,9 +1,9 @@
 {
     "recommendations": [
         "aaron-bond.better-comments",
+        "dbaeumer.vscode-eslint",
         "editorconfig.editorconfig",
         "esbenp.prettier-vscode",
-        "samverschueren.linter-xo",
         "streetsidesoftware.code-spell-checker"
     ]
 }

lint-staged.config.js

@@ -0,0 +1,9 @@
+/**
+ * @see https://github.com/lint-staged/lint-staged?tab=readme-ov-file#using-js-configuration-files
+ * @type {import('lint-staged').Config}
+ */
+
+export default {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    '*': (filenames) => filenames.map((filename) => `prettier --ignore-unknown --write '${filename}'`),
+};