feat: custom eslint parser for Vue Vine (#56)

* chore: resolve lint issues

* chore: playwright deps

* wip: eslint-parser html utils

* wip: more detailed description

* feat: adjust token pos based on global offset

* chore: remove duplicated import

* fix: use basic tokens instead of intermediate

* feat: init VineESLintAnalyzer

* wip: refactor some names and orders

* feat(eslint): basically implemented template root

* fix(eslint): template root range

* fix(eslint): build process

* wip: ready for global analyze scope manager

* wip: ready for global analyze scope manager

* feat(eslint): basically implemented eslint-parser

* fix: validate eslint in IDE

Author: ShenQingchuan

.eslintignore

@@ -11,4 +11,4 @@ scripts/*.sh
 # because we didn't implement `.vine.ts`
 # template ESTree support yet
 packages/create-vue-vine/**/*.vine.ts
-packages/playground/**/*.vine.ts
+

.eslintrc

@@ -1,8 +1,6 @@
 {
   "extends": "@antfu",
   "rules": {
-    // "no-console": "off",
-    // "no-useless-return": "off",
     "curly": "off",
     "prefer-const": "off"
   }

.vscode/settings.json

@@ -1,3 +1,5 @@
 {
-  "prettier.enable": false
+  "prettier.enable": false,
+  "cSpell.enabled": false,
+  "testing.automaticallyOpenPeekView": "never"
 }

package.json

@@ -8,19 +8,24 @@
   "scripts": {
     "play": "pnpm --filter @vue-vine/playground run dev",
     "dev": "esno scripts/run-dev.js",
-    "build": "pnpm build:compiler && pnpm build:vite && pnpm build:main",
+    "build": "pnpm build:compiler && pnpm build:vite && pnpm build:main && pnpm build:eslint-parser",
     "dev:compiler": "cross-env NODE_ENV=development pnpm --filter @vue-vine/compiler run dev",
     "dev:vite": "cross-env NODE_ENV=development pnpm --filter @vue-vine/vite-plugin run dev",
     "dev:main": "cross-env NODE_ENV=development pnpm --filter vue-vine run dev",
-    "build:compiler": "cross-env NODE_ENV=development pnpm --filter @vue-vine/compiler run build",
-    "build:vite": "cross-env NODE_ENV=development pnpm --filter @vue-vine/vite-plugin run build",
-    "build:main": "cross-env NODE_ENV=development pnpm --filter vue-vine run build",
-    "ext:dev": "cross-env NODE_ENV=development esno scripts/ext-dev.js dev",
-    "ext:build": "cross-env NODE_ENV=production esno scripts/ext-dev.js build",
-    "test": "pnpm test:compiler --run && pnpm test:e2e --run",
+    "build:compiler": "cross-env NODE_ENV=production pnpm --filter @vue-vine/compiler run build",
+    "build:vite": "cross-env NODE_ENV=production pnpm --filter @vue-vine/vite-plugin run build",
+    "build:lsp": "cross-env NODE_ENV=production pnpm --filter @vue-vine/language-server run build",
+    "build:eslint-parser": "cross-env NODE_ENV=production pnpm --filter @vue-vine/eslint-parser run build",
+    "build:main": "cross-env NODE_ENV=production pnpm --filter vue-vine run build",
+    "ext:dev": "cross-env NODE_ENV=development esno scripts/ext-dev.js",
+    "ext:tsc": "cross-env NODE_ENV=production pnpm --filter vue-vine-extension run build:tsc",
+    "ext:esbuild": "cross-env NODE_ENV=production pnpm --filter vue-vine-extension run build:esbuild",
+    "ext:build": "cross-env NODE_ENV=production pnpm build:compiler && pnpm ext:tsc && pnpm ext:esbuild && pnpm build:lsp",
+    "test": "esno scripts/run-test.js",
     "test:compiler": "pnpm --filter @vue-vine/compiler run test",
     "test:e2e": "pnpm --filter @vue-vine/e2e-test run test",
-    "lint": "eslint . --cache",
+    "test:eslint-parser": "pnpm --filter @vue-vine/eslint-parser run test",
+    "lint": "pnpm run build:eslint-parser && eslint . --cache",
     "lint:fix": "pnpm lint --fix",
     "docs:dev": "pnpm --filter vue-vine-docs run dev",
     "docs:build": "pnpm --filter vue-vine-docs run build",
@@ -31,7 +36,7 @@
     "update:deps": "esno scripts/update-deps.js"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.38.6",
+    "@antfu/eslint-config": "^0.41.0",
     "@baiwusanyu/utils-log": "^1.0.15",
     "@changesets/cli": "^2.26.2",
     "concurrently": "^8.2.1",
@@ -40,7 +45,6 @@
     "eslint": "^8.48.0",
     "esno": "^0.16.3",
     "lint-staged": "^13.3.0",
-    "pkgroll": "^1.11.0",
     "playwright-chromium": "^1.37.1",
     "rimraf": "^5.0.1",
     "rollup": "^3.28.1",
@@ -51,6 +55,11 @@
     "typescript": "^5.2.2",
     "vitest": "^0.31.4"
   },
+  "pnpm": {
+    "overrides": {
+      "vscode-uri": "^3.0.8"
+    }
+  },
   "simple-git-hooks": {
     "pre-commit": "pnpm esno scripts/pre-commit.js"
   },

packages/compiler/index.ts

@@ -27,7 +27,7 @@ export type {
 } from './src/types'
 
 export function createCompilerCtx(
-  options: VineCompilerOptions,
+  options: VineCompilerOptions = {},
 ): VineCompilerCtx {
   return {
     fileCtxMap: new Map(),

packages/compiler/package.json

@@ -12,8 +12,8 @@
     ".": {
       "dev": "./index.ts",
       "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs"
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
     }
   },
   "main": "./dist/index.js",

packages/compiler/src/style/analyze-css-vars.ts

@@ -2,8 +2,8 @@
  * Implementation from vue
  * https://github.com/vuejs/core/blob/main/packages/compiler-sfc/src/style/cssVars.ts
  */
-const enum LexerState {
-  inParens,
+enum LexerState {
+  inParens = 1,
   inSingleQuoteString,
   inDoubleQuoteString,
 }

packages/compiler/src/style/trim-plugin.ts

@@ -1,6 +1,6 @@
 import type { PluginCreator } from 'postcss'
 
-const trimPlugin: PluginCreator<{}> = () => {
+const trimPlugin: PluginCreator<object> = () => {
   return {
     postcssPlugin: 'vine-style-trim',
     Once(root) {

packages/create-vue-vine/src/commands/create.ts

@@ -1,5 +1,6 @@
 import { join, relative } from 'node:path'
 import { rm } from 'node:fs/promises'
+import process from 'node:process'
 import { intro, log, outro, spinner } from '@clack/prompts'
 import { Root, defineCommand } from 'clerc'
 import gradient from 'gradient-string'

packages/create-vue-vine/src/utils/clack.ts

@@ -1,3 +1,4 @@
+import process from 'node:process'
 import { cancel as _cancel, confirm as _confirm, text as _text, isCancel } from '@clack/prompts'
 
 export function cancel(...args: Parameters<typeof _cancel>): never {