eslint-plugin-harlanzw 0.0.2 → 0.1.0

package/README.md

@@ -4,7 +4,7 @@
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 [![License][license-src]][license-href]
 
-Harlan's ESLint rules for Vue projects.
+Harlan's ESLint rules for Vue projects with focus on link hygiene, Nuxt best practices, and Vue reactivity patterns.
 
 <p align="center">
 <table>
@@ -26,12 +26,31 @@ Try the rules in action with a Nuxt ESLint interactive playground:
 
 > **Note:** These rules are experimental and may change. They will be submitted to the official Vue ESLint plugin for consideration.
 
+The rules are organized into the following categories:
+
+- **Link Rules** - Ensure link URLs are clean, accessible, and SEO-friendly
+- **Nuxt Rules** - Best practices for Nuxt applications
+- **Vue Rules** - Vue composition API and reactivity best practices
+
 <!-- rules:start -->
-- [`vue-no-faux-composables`](./src/rules/vue-no-faux-composables.md) - stop fake composables that don't use Vue reactivity
-- [`vue-no-nested-reactivity`](./src/rules/vue-no-nested-reactivity.md) - don't mix `ref()` and `reactive()` together
-- [`vue-no-passing-refs-as-props`](./src/rules/vue-no-passing-refs-as-props.md) - don't pass refs as props - unwrap them first
-- [`vue-no-ref-access-in-templates`](./src/rules/vue-no-ref-access-in-templates.md) - don't use `.value` in Vue templates
-- [`vue-no-torefs-on-props`](./src/rules/vue-no-torefs-on-props.md) - don't use `toRefs()` on the props object
+| Rule | Description |
+| --- | --- |
+| [`link-ascii-only`](./src/rules/link-ascii-only.md) | ensure link URLs contain only ASCII characters |
+| [`link-lowercase`](./src/rules/link-lowercase.md) | ensure link URLs do not contain uppercase characters |
+| [`link-no-double-slashes`](./src/rules/link-no-double-slashes.md) | ensure link URLs do not contain consecutive slashes |
+| [`link-no-whitespace`](./src/rules/link-no-whitespace.md) | ensure link URLs do not contain whitespace characters |
+| [`nuxt-await-navigate-to`](./src/rules/nuxt-await-navigate-to.md) | enforce awaiting `navigateTo()` calls |
+| [`nuxt-no-redundant-import-meta`](./src/rules/nuxt-no-redundant-import-meta.md) | disallow redundant `import.meta.server` or `import.meta.client` checks in scoped components |
+| [`nuxt-no-side-effects-in-async-data-handler`](./src/rules/nuxt-no-side-effects-in-async-data-handler.md) | disallow side effects in async data handlers |
+| [`nuxt-no-side-effects-in-setup`](./src/rules/nuxt-no-side-effects-in-setup.md) | disallow side effects in setup functions |
+| [`nuxt-prefer-navigate-to-over-router-push-replace`](./src/rules/nuxt-prefer-navigate-to-over-router-push-replace.md) | prefer `navigateTo()` over `router.push()` or `router.replace()` |
+| [`nuxt-prefer-nuxt-link-over-router-link`](./src/rules/nuxt-prefer-nuxt-link-over-router-link.md) | prefer `NuxtLink` over `RouterLink` |
+| [`vue-no-faux-composables`](./src/rules/vue-no-faux-composables.md) | stop fake composables that don't use Vue reactivity |
+| [`vue-no-nested-reactivity`](./src/rules/vue-no-nested-reactivity.md) | don't mix `ref()` and `reactive()` together |
+| [`vue-no-passing-refs-as-props`](./src/rules/vue-no-passing-refs-as-props.md) | don't pass refs as props - unwrap them first |
+| [`vue-no-reactive-destructuring`](./src/rules/vue-no-reactive-destructuring.md) | avoid destructuring reactive objects |
+| [`vue-no-ref-access-in-templates`](./src/rules/vue-no-ref-access-in-templates.md) | don't use `.value` in Vue templates |
+| [`vue-no-torefs-on-props`](./src/rules/vue-no-torefs-on-props.md) | don't use `toRefs()` on the props object |
 <!-- rules:end -->
 
 ## Installation
@@ -60,9 +79,20 @@ export default antfu(
       harlanzw
     },
     rules: {
+      'harlanzw/link-ascii-only': 'error',
+      'harlanzw/link-lowercase': 'error',
+      'harlanzw/link-no-double-slashes': 'error',
+      'harlanzw/link-no-whitespace': 'error',
+      'harlanzw/nuxt-await-navigate-to': 'error',
+      'harlanzw/nuxt-no-redundant-import-meta': 'error',
+      'harlanzw/nuxt-no-side-effects-in-async-data-handler': 'error',
+      'harlanzw/nuxt-no-side-effects-in-setup': 'error',
+      'harlanzw/nuxt-prefer-navigate-to-over-router-push-replace': 'error',
+      'harlanzw/nuxt-prefer-nuxt-link-over-router-link': 'error',
       'harlanzw/vue-no-faux-composables': 'error',
       'harlanzw/vue-no-nested-reactivity': 'error',
       'harlanzw/vue-no-passing-refs-as-props': 'error',
+      'harlanzw/vue-no-reactive-destructuring': 'error',
       'harlanzw/vue-no-ref-access-in-templates': 'error',
       'harlanzw/vue-no-torefs-on-props': 'error'
     }
@@ -82,9 +112,20 @@ export default withNuxt([{
     harlanzw
   },
   rules: {
+    'harlanzw/link-ascii-only': 'error',
+    'harlanzw/link-lowercase': 'error',
+    'harlanzw/link-no-double-slashes': 'error',
+    'harlanzw/link-no-whitespace': 'error',
+    'harlanzw/nuxt-await-navigate-to': 'error',
+    'harlanzw/nuxt-no-redundant-import-meta': 'error',
+    'harlanzw/nuxt-no-side-effects-in-async-data-handler': 'error',
+    'harlanzw/nuxt-no-side-effects-in-setup': 'error',
+    'harlanzw/nuxt-prefer-navigate-to-over-router-push-replace': 'error',
+    'harlanzw/nuxt-prefer-nuxt-link-over-router-link': 'error',
     'harlanzw/vue-no-faux-composables': 'error',
     'harlanzw/vue-no-nested-reactivity': 'error',
     'harlanzw/vue-no-passing-refs-as-props': 'error',
+    'harlanzw/vue-no-reactive-destructuring': 'error',
     'harlanzw/vue-no-ref-access-in-templates': 'error',
     'harlanzw/vue-no-torefs-on-props': 'error'
   }
@@ -110,9 +151,20 @@ export default [
       harlanzw
     },
     rules: {
+      'harlanzw/link-ascii-only': 'error',
+      'harlanzw/link-lowercase': 'error',
+      'harlanzw/link-no-double-slashes': 'error',
+      'harlanzw/link-no-whitespace': 'error',
+      'harlanzw/nuxt-await-navigate-to': 'error',
+      'harlanzw/nuxt-no-redundant-import-meta': 'error',
+      'harlanzw/nuxt-no-side-effects-in-async-data-handler': 'error',
+      'harlanzw/nuxt-no-side-effects-in-setup': 'error',
+      'harlanzw/nuxt-prefer-navigate-to-over-router-push-replace': 'error',
+      'harlanzw/nuxt-prefer-nuxt-link-over-router-link': 'error',
       'harlanzw/vue-no-faux-composables': 'error',
       'harlanzw/vue-no-nested-reactivity': 'error',
       'harlanzw/vue-no-passing-refs-as-props': 'error',
+      'harlanzw/vue-no-reactive-destructuring': 'error',
       'harlanzw/vue-no-ref-access-in-templates': 'error',
       'harlanzw/vue-no-torefs-on-props': 'error'
     }

package/dist/index.d.mts

@@ -10,9 +10,20 @@ declare const plugin: {
         version: string;
     };
     rules: {
+        'link-ascii-only': RuleModule<[]>;
+        'link-lowercase': RuleModule<[]>;
+        'link-no-double-slashes': RuleModule<[]>;
+        'link-no-whitespace': RuleModule<[]>;
+        'nuxt-await-navigate-to': RuleModule<[]>;
+        'nuxt-no-redundant-import-meta': RuleModule<[]>;
+        'nuxt-no-side-effects-in-async-data-handler': RuleModule<[]>;
+        'nuxt-no-side-effects-in-setup': RuleModule<[]>;
+        'nuxt-prefer-navigate-to-over-router-push-replace': RuleModule<[]>;
+        'nuxt-prefer-nuxt-link-over-router-link': RuleModule<[]>;
         'vue-no-faux-composables': RuleModule<[]>;
         'vue-no-nested-reactivity': RuleModule<[]>;
         'vue-no-passing-refs-as-props': RuleModule<[]>;
+        'vue-no-reactive-destructuring': RuleModule<[]>;
         'vue-no-ref-access-in-templates': RuleModule<[]>;
         'vue-no-torefs-on-props': RuleModule<[]>;
     };