feat: migrate to TypeScript and ESM

.github/workflows/ci.yml

@@ -6,31 +6,57 @@ on:
     branches: [main]
 
 jobs:
+  are-the-types-wrong:
+    name: 🤔 Are the types wrong?
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          check-latest: true
+
+      - name: Install Packages
+        run: npm ci
+
+      - name: Check package exports with are-the-types-wrong
+        run: npm run check-exports
+
+      - name: Run publint
+        run: npm run check-package-json
+
+      - run: npm run typecheck
+
   lint:
     name: Lint
     runs-on: ubuntu-latest
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           persist-credentials: false
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           node-version: lts/*
 
       - name: Install Packages
         run: npm install
 
+      - name: Build Project
+        run: npm run build
+
       - name: Lint Files
         run: npm run lint
 
   test:
     name: Test
     strategy:
+      fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        node: [18.18.0, 18.x, 20.x, 22.x, 24.x]
+        node: [22.x, 24.x, lts/*]
         include:
           - os: windows-latest
             node: lts/*
@@ -40,16 +66,19 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           persist-credentials: false
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node }}
 
       - name: Install Packages
         run: npm install
 
+      - name: Build Project
+        run: npm run build
+
       - name: Test
         run: npm test

.gitignore

@@ -1,2 +1,4 @@
 node_modules
 .idea
+.rolldown/
+dist/

eslint-doc-generator.config.ts

@@ -0,0 +1,13 @@
+import type { GenerateOptions } from 'eslint-doc-generator';
+import * as path from 'node:path';
+import { format, resolveConfig } from 'prettier';
+
+const config = {
+  ignoreConfig: ['recommended-legacy'],
+  postprocess: async (doc, pathToFile) => {
+    const prettierConfig = (await resolveConfig(pathToFile, { config: path.join(import.meta.dirname, '.prettierrc.json') })) ?? {};
+    return await format(doc, { ...prettierConfig, filepath: pathToFile, parser: 'markdown' });
+  },
+} as const satisfies GenerateOptions;
+
+export default config;

eslint.config.mts

@@ -0,0 +1,55 @@
+import jsPlugin from '@eslint/js';
+import prettierConfig from 'eslint-config-prettier';
+import eslintPluginRecommendedConfig from 'eslint-plugin-eslint-plugin';
+import { defineConfig } from 'eslint/config';
+import tsEslint from 'typescript-eslint';
+
+const eslintPluginConfigs = defineConfig([
+  eslintPluginRecommendedConfig.configs.recommended,
+  { ignores: ['dist/'] },
+  {
+    rules: {
+      'eslint-plugin/prefer-message-ids': 'off', // TODO: enable
+      'eslint-plugin/require-meta-docs-description': ['error', { pattern: '^(Detects|Enforces|Requires|Disallows) .+\\.$' }],
+      'eslint-plugin/require-meta-docs-url': [
+        'error',
+        {
+          pattern: 'https://github.com/eslint-community/eslint-plugin-security/blob/main/docs/rules/{{name}}.md',
+        },
+      ],
+      'eslint-plugin/require-meta-schema': 'off', // TODO: enable
+      'eslint-plugin/require-meta-type': 'off', // TODO: enable
+    },
+  },
+]);
+
+export default defineConfig([
+  jsPlugin.configs.recommended,
+  prettierConfig,
+  ...eslintPluginConfigs,
+  tsEslint.configs.strict,
+  tsEslint.configs.stylistic,
+  // tsEslint.configs.strictTypeChecked,
+  // tsEslint.configs.stylisticTypeChecked,
+  {
+    files: ['**/*.?(c|m)ts?(x)'],
+    languageOptions: {
+      sourceType: 'module',
+      parserOptions: {
+        projectService: true,
+      },
+    },
+    rules: {
+      '@typescript-eslint/consistent-type-definitions': [2, 'type'],
+    },
+  },
+  {
+    files: ['tests/**/*.tests.ts'],
+    languageOptions: {
+      globals: {
+        describe: 'readonly',
+        it: 'readonly',
+      },
+    },
+  },
+]);