feat: add eslint plugin

Author: zhiyuanzmj

.vscode/settings.json

@@ -1,4 +1,3 @@
 {
-  "editor.formatOnSave": true,
-  "eslint.experimental.useFlatConfig": true
+  "editor.formatOnSave": true
 }

README.md

@@ -117,14 +117,14 @@ export const useUserStore = defineStore$('user', () => {
 
 // convert to:
 export const useUserStore = defineStore('user', () => {
-  let token = $ref('')
+  const token = ref('')
   function login() {
-    token = 'TOKEN'
+    token.value = 'TOKEN'
   }
 
   return {
-    token: $$(token),
-    login: $$(login),
+    token,
+    login,
   }
 })
 ```
@@ -134,7 +134,7 @@ export const useUserStore = defineStore('user', () => {
 import { useBase64 } from '@vueuse/core'
 import { useUserStore } from '~/store/user'
 
-const { token, login } = $useUserStore()
+const { token, login } = useUserStore()
 ;[token]
 // convert to:
 const { token, login } = toRefs(useUserStore())
@@ -145,12 +145,14 @@ const text = $inject$('text', token)
 const text = inject('text', token)
 
 const { base64 } = $useBase64$(text)
+;[base64]
 // convert to:
-const { base64 } = useBase64(text)
+let { base64 } = $useBase64(text)
+;[base64.value]
 
 provide$('base64', base64)
 // convert to:
-provide('base64', base64)
+provide$('base64', base64)
 
 const stop = watch$(base64, () => {
   console.log(base64)
@@ -173,9 +175,11 @@ defineExpose({
 })
 
 let compRef = $useRef()
+;[compRef]
 defineRender(<Comp ref$={compRef} />)
 // convert to:
 let compRef = useRef()
+;[compRef.value]
 defineRender(<Comp ref={compRef} />)
 </script>
 ```
@@ -209,6 +213,17 @@ export default {
 }
 ```
 
+### ESLint
+
+Convert to reactivity function.
+
+```ts
+// ./eslint.config.js
+import reactivityFunction from 'unplugin-vue-reactivity-function/eslint'
+
+export default [reactivityFunction()]
+```
+
 ## License
 
 [MIT](./LICENSE) License © 2023-PRESENT [zhiyuanzmj](https://github.com/zhiyuanzmj)

eslint.config.js

@@ -0,0 +1,18 @@
+import { sxzz } from '@sxzz/eslint-config'
+import reactivityFunction from './dist/eslint.js'
+
+export default [
+  ...sxzz({
+    rules: {
+      'unused-imports/no-unused-vars': 'off',
+      'unused-imports/no-unused-imports': 'off',
+      'import/no-default-export': 'off',
+    },
+  }),
+  reactivityFunction({
+    ignores: ['**/*.md/**'],
+    rules: {
+      'reactivity-function': 1,
+    },
+  }),
+]

eslint.config.mjs

@@ -110,8 +110,10 @@
     "@sxzz/eslint-config": "^3.14.0",
     "@sxzz/prettier-config": "^2.0.2",
     "@types/babel__traverse": "^7.20.7",
+    "@types/eslint": "^9.6.1",
     "@types/node": "^20.14.11",
-    "@typescript-eslint/types": "^8.30.1",
+    "@typescript-eslint/types": "^8.31.0",
+    "@typescript-eslint/utils": "^8.30.1",
     "@vue-macros/reactivity-transform": "^0.4.6",
     "@vue-macros/test-utils": "^1.4.0",
     "bumpp": "^9.4.1",

package.json

@@ -0,0 +1,20 @@
+import rules, { type Rules } from './eslint/index'
+import type { Linter } from 'eslint'
+
+export const plugins = {
+  'reactivity-function': {
+    rules,
+  },
+}
+
+export { rules, type Rules }
+
+export default ({ rules = {}, ...options }: Linter.Config<Rules> = {}) => ({
+  name: 'reactivity-function',
+  plugins,
+  rules: {
+    'reactivity-function/reactivity-function':
+      rules['reactivity-function'] || 1,
+  } satisfies Rules & Record<string, unknown>,
+  ...options,
+})

patches/@typescript-eslint__scope-manager.patch

@@ -0,0 +1,18 @@
+import reactivityFunction, {
+  type ReactivityFunctionRuleOptions,
+} from './reactivity-function'
+import type { Linter } from '@typescript-eslint/utils/ts-eslint'
+
+export interface RuleOptions {
+  'reactivity-function': ReactivityFunctionRuleOptions
+}
+
+export type Rules = Partial<{
+  [K in keyof RuleOptions]:
+    | Linter.Severity
+    | [Linter.Severity, ...RuleOptions[K]]
+}>
+
+export default {
+  'reactivity-function': reactivityFunction,
+}