Update packages and improve repository setup

Author: fabian-hiller

.eslintrc.cjs

@@ -4,6 +4,7 @@ All notable changes to the library will be documented in this file.
 
 ## vX.X.X (Month DD, YYYY)
 
+- Change `FormDataEntry` and `FormDataInfo` from type to interface
 - Fix potential prototype pollution by ignoring certain keys
 
 ## v0.8.0 (August 20, 2024)

CHANGELOG.md

@@ -0,0 +1,74 @@
+import eslint from '@eslint/js';
+import importPlugin from 'eslint-plugin-import';
+import jsdoc from 'eslint-plugin-jsdoc';
+import pluginSecurity from 'eslint-plugin-security';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  tseslint.configs.strict,
+  tseslint.configs.stylistic,
+  jsdoc.configs['flat/recommended'],
+  pluginSecurity.configs.recommended,
+  {
+    files: ['src/**/*.ts'],
+    extends: [importPlugin.flatConfigs.recommended],
+    plugins: { jsdoc },
+    rules: {
+      // Enable rules -----------------------------------------------------------
+
+      // TypeScript
+      '@typescript-eslint/consistent-type-definitions': 'error', // Enforce declaring types using `interface` keyword for better TS performance.
+      '@typescript-eslint/consistent-type-imports': 'warn',
+
+      // Import
+      'import/extensions': ['error', 'always'], // Require file extensions
+
+      // JSDoc
+      'jsdoc/tag-lines': ['error', 'any', { startLines: 1 }],
+      'jsdoc/sort-tags': [
+        'error',
+        {
+          linesBetween: 1,
+          tagSequence: [
+            { tags: ['deprecated'] },
+            { tags: ['param'] },
+            { tags: ['returns'] },
+          ],
+        },
+      ],
+      // NOTE: For overloads functions, we only require a JSDoc at the top
+      // SEE: https://github.com/gajus/eslint-plugin-jsdoc/issues/666
+      'jsdoc/require-jsdoc': [
+        'error',
+        {
+          contexts: [
+            'ExportNamedDeclaration[declaration.type="TSDeclareFunction"]:not(ExportNamedDeclaration[declaration.type="TSDeclareFunction"] + ExportNamedDeclaration[declaration.type="TSDeclareFunction"])',
+            'ExportNamedDeclaration[declaration.type="FunctionDeclaration"]:not(ExportNamedDeclaration[declaration.type="TSDeclareFunction"] + ExportNamedDeclaration[declaration.type="FunctionDeclaration"])',
+          ],
+          require: {
+            FunctionDeclaration: false,
+          },
+        },
+      ],
+
+      // Disable rules ----------------------------------------------------------
+
+      // TypeScript
+      '@typescript-eslint/ban-ts-comment': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-inferrable-types': 'off',
+
+      // Imports
+      'no-duplicate-imports': 'off',
+
+      // JSDoc
+      'jsdoc/require-param-type': 'off',
+      'jsdoc/require-returns-type': 'off',
+
+      // Security
+      'security/detect-object-injection': 'off', // Too many false positives
+    },
+  }
+);

eslint.config.js

@@ -42,23 +42,27 @@
   "scripts": {
     "test": "vitest",
     "coverage": "vitest run --coverage",
-    "lint": "eslint \"src/**/*.ts*\" && tsc --noEmit",
+    "lint": "eslint \"src/**/*.ts*\" && tsc --noEmit && deno check ./src/index.ts",
     "format": "prettier --write ./src",
     "format.check": "prettier --check ./src",
     "build": "tsup"
   },
   "devDependencies": {
-    "@types/eslint": "^8.44.3",
-    "@typescript-eslint/eslint-plugin": "^6.7.4",
-    "@typescript-eslint/parser": "^6.7.4",
-    "@vitest/coverage-v8": "^0.34.6",
-    "eslint": "^8.50.0",
-    "eslint-plugin-import": "^2.28.1",
-    "jsdom": "^22.1.0",
-    "prettier": "^3.0.3",
-    "tsup": "^7.2.0",
-    "typescript": "^5.2.2",
-    "vite": "^4.4.10",
-    "vitest": "^0.34.6"
+    "@eslint/js": "^9.23.0",
+    "@trivago/prettier-plugin-sort-imports": "^5.2.2",
+    "@types/node": "^22.13.13",
+    "@vitest/coverage-v8": "^3.0.9",
+    "eslint": "^9.23.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jsdoc": "^50.6.9",
+    "eslint-plugin-security": "^3.0.1",
+    "jsdom": "^26.0.0",
+    "prettier": "^3.5.3",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.28.0",
+    "vite": "^6.2.3",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "3.0.9"
   }
 }