chore: ESLint play around.

Author: Cyrus-0101

eslint.config.js

@@ -1,23 +1,41 @@
 // @ts-check
 import eslint from '@eslint/js';
 import tsParser from '@typescript-eslint/parser';
+import esLintConfigPrettier from 'eslint-config-prettier';
+import jsdoc from 'eslint-plugin-jsdoc';
 import { config, configs } from 'typescript-eslint';
 
 export default config(
-  eslint.configs.recommended,
-  ...configs.strict,
-  ...configs.stylisticTypeChecked,
-  ...configs.recommendedTypeChecked,
-  {
-    // ignores: ['dist/**', 'examples/vanilla/**'],
-    languageOptions: {
-      parser: tsParser,
-      parserOptions: {
-        project: ['./tsconfig.json'],
-        sourceType: "module",
-        tsconfigRootDir: import.meta.dirname,
-    
-      },
-    },
-  }
+    eslint.configs.recommended,
+    esLintConfigPrettier,
+    ...configs.strict,
+    ...configs.stylisticTypeChecked,
+    ...configs.recommendedTypeChecked,
+    configs.eslintRecommended,
+    {
+        // ignores: ['dist/**', 'examples/vanilla/**'],
+        languageOptions: {
+            parser: tsParser,
+            parserOptions: {
+                project: ['./tsconfig.json', 'tsconfig.eslint.json'],
+                sourceType: 'module',
+                tsconfigRootDir: import.meta.dirname,
+
+            },
+        },
+        plugins: {
+            jsdoc: jsdoc,
+        },
+        rules: {
+            indent: 'error',
+            quotes: [
+                'error',
+                'single',
+                { 'avoidEscape': true, 'allowTemplateLiterals': true }
+            ],            
+            'jsdoc/require-jsdoc': 'error',
+            'jsdoc/check-values': 'error'
+
+        }
+    }
 );

index.ts

@@ -10,7 +10,7 @@
   "scripts": {
     "build": "bun build src/index.ts --outdir ./dist",
     "dev": "bun run src/index.ts",
-    "lint": "bunx --bun eslint --fix -c eslint.config.js",
+    "lint": "bunx --bun eslint --fix -c eslint.config.js --ignore-pattern 'dist' --ignore-pattern 'examples/vanilla'",
     "serve:examples": "bunx http-server . -o ./examples/ -bg"
   },
   "keywords": [
@@ -32,15 +32,20 @@
   "devDependencies": {
     "@eslint/js": "^9.3.0",
     "@types/bun": "latest",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/eslint__js": "",
     "eslint": "9.x",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-jsdoc": "^48.2.6",
     "globals": "^15.3.0",
     "prettier": "^3.2.5",
     "typescript-eslint": "^7.10.0"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "syronjs": "."
   }
 }

package.json

@@ -2,7 +2,7 @@
 
 /** @type {import("prettier").Config} */
 export default {
-    trailingComma: "es5",
+    trailingComma: 'es5',
     tabWidth: 8,
     semi: false,
     singleQuote: true,

prettier.config.js

@@ -0,0 +1,13 @@
+{
+    // extend your base config so you don't have to redefine your compilerOptions
+    "extends": "./tsconfig.json",
+    "include": [
+        "packages/**/*.ts",
+        "__tests__/**/*.ts",
+        // "typings/**/*.ts",
+        // etc
+        // if you have a mixed JS/TS codebase, don't forget to include your JS file
+    ],
+    "files": ["**/*.js"],
+    "exclude": ["dist", "examples/vanilla"]
+}

tsconfig.eslint.json

@@ -26,15 +26,14 @@
   },
   "typeRoots": ["node_modules/@types", "@types"],
   "include": [
-    "packages/**/*"
-  ],
-  "exclude": [
+    "packages",
     "eslint.config.js",
     "prettier.config.js",
-    "vanilla",
+    "coverage"
+  ],
+  "exclude": [
     "node_modules",
+    "examples/vanilla",
     "dist",
-    "build",
-    "coverage"
   ]
 }