Set up linter, introduce cst types, improve recovery

Author: emrberk

eslint.config.ts

@@ -0,0 +1,86 @@
+import js from "@eslint/js"
+import tseslint from "typescript-eslint"
+import prettier from "eslint-plugin-prettier"
+import prettierConfig from "eslint-config-prettier"
+import globals from "globals"
+import { Linter } from "eslint"
+
+export default [
+  {
+    ignores: ["dist/", "node_modules/", "eslint.config.ts", "src/parser/cst-types.d.ts"],
+  },
+  {
+    files: ["**/*.{js,ts}"],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.es2020,
+      },
+      ecmaVersion: 2020,
+      sourceType: "module",
+    },
+    plugins: {
+      prettier,
+    },
+    rules: {
+      "prettier/prettier": "warn",
+    },
+  },
+  {
+    files: ["src/**/*.ts"],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        project: "./tsconfig.json",
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    plugins: {
+      "@typescript-eslint": tseslint.plugin,
+    },
+    rules: {
+      ...js.configs.recommended.rules,
+      ...tseslint.configs.recommended.reduce(
+        (acc, config) => ({ ...acc, ...config.rules }),
+        {} as Linter.RulesRecord,
+      ),
+      ...tseslint.configs.recommendedTypeChecked.reduce(
+        (acc, config) => ({ ...acc, ...config.rules }),
+        {} as Linter.RulesRecord,
+      ),
+
+      "@typescript-eslint/explicit-function-return-type": "off",
+      "@typescript-eslint/explicit-module-boundary-types": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          caughtErrors: "none",
+          argsIgnorePattern: "^_",
+        },
+      ],
+      "@typescript-eslint/strict-boolean-expressions": "off",
+      "@typescript-eslint/consistent-type-definitions": "off",
+      "@typescript-eslint/no-misused-promises": [
+        "error",
+        {
+          checksVoidReturn: false,
+        },
+      ],
+
+      "quote-props": ["error", "as-needed"],
+      "object-shorthand": ["error", "always"],
+      "no-unused-vars": "off",
+      "no-var": ["error"],
+      "no-console": [
+        "warn",
+        {
+          allow: ["warn", "error", "info"],
+        },
+      ],
+      // NaN is used as a Chevrotain token name (SQL NaN keyword)
+      "no-shadow-restricted-names": "off",
+    },
+  },
+
+  prettierConfig,
+] satisfies Linter.Config[]

package.json

@@ -17,7 +17,9 @@
     "test": "vitest run",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
-    "clean": "rm -rf dist coverage"
+    "clean": "rm -rf dist coverage",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix"
   },
   "keywords": [
     "questdb",
@@ -41,9 +43,17 @@
     "chevrotain": "^11.1.1"
   },
   "devDependencies": {
+    "@eslint/js": "^10.0.1",
     "@types/jest": "^30.0.0",
     "@types/node": "^25.2.0",
+    "eslint": "^10.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "globals": "^17.3.0",
+    "jiti": "^2.6.1",
+    "prettier": "^3.8.1",
     "typescript": "^5.9.3",
+    "typescript-eslint": "^8.55.0",
     "vitest": "^4.0.18"
   }
 }

prettier.config.cjs

@@ -0,0 +1,33 @@
+module.exports = {
+  arrowParens: "always",
+  endOfLine: "auto",
+  proseWrap: "always",
+  trailingComma: "all",
+  semi: false,
+  overrides: [
+    {
+      files: "*.js",
+      options: {
+        parser: "babel",
+      },
+    },
+    {
+      files: "*.md",
+      options: {
+        parser: "markdown",
+      },
+    },
+    {
+      files: "*.ts",
+      options: {
+        parser: "typescript",
+      },
+    },
+    {
+      files: "*.yml",
+      options: {
+        parser: "yaml",
+      },
+    },
+  ],
+}