docs: eslint + definePage

See #511
posva · Sep 16, 2024 · 2126ea0 · 2126ea0
1 parent 6e5ae6b
commit 2126ea0
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/guide/eslint.md b/docs/guide/eslint.md
@@ -9,3 +9,15 @@ If you are not using auto imports, you will need to tell ESlint about `vue-route
   }
 }
 ```
+
+## `definePage()`
+
+Since `definePage()` is a global macro, you need to tell ESlint about it. Add these lines to your eslint configuration:
+
+```json{3}
+{
+  "globals": {
+    "definePage": "readonly"
+  }
+}
+```
diff --git a/docs/guide/extending-routes.md b/docs/guide/extending-routes.md
@@ -66,6 +66,8 @@ definePage({
 </template>
 ```
 
+If you are using ESLint, you will need [to declare it as a global variable](../guide/eslint.md#definepage).
+
 ::: danger
 You cannot use variables in `definePage()` as its passed parameter gets extracted at build time and is removed from `<script setup>`. Similar to other macros like `definePageMeta()` in Nuxt.
 :::