eslint-plugin-vue-setup-order 1.0.0 → 1.0.1

package/README.md

@@ -1,11 +1,8 @@
 # eslint-plugin-vue-setup-order
 
-[![npm version](https://badge.fury.io/js/eslint-plugin-vue-setup-order.svg)](https://www.npmjs.com/package/eslint-plugin-vue-setup-order)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+ESLint plugin to enforce a consistent order of statements within the Vue 3 `<script setup>` block.
 
-ESLint plugin to enforce consistent order of statements in Vue 3 `<script setup>`.
-
-## 📦 Installation
+## Installation
 
 ```bash
 npm install -D eslint-plugin-vue-setup-order
@@ -15,7 +12,7 @@ pnpm add -D eslint-plugin-vue-setup-order
 yarn add -D eslint-plugin-vue-setup-order
 ```
 
-## 🚀 Usage
+## Configuration
 
 ### ESLint Flat Config (ESLint 9+)
 
@@ -25,7 +22,7 @@ import vueSetupOrder from 'eslint-plugin-vue-setup-order';
 
 export default [
   vueSetupOrder.configs.flat.recommended,
-  // or manually:
+  // Or manual configuration:
   {
     plugins: {
       'vue-setup-order': vueSetupOrder,
@@ -44,50 +41,50 @@ export default [
 module.exports = {
   plugins: ['vue-setup-order'],
   extends: ['plugin:vue-setup-order/recommended'],
-  // or manually:
+  // Or manual configuration:
   rules: {
     'vue-setup-order/order': 'error',
   },
 };
 ```
 
-## 📋 Expected Order
+## Default Order
 
-The plugin enforces the following order in `<script setup>`:
+The plugin enforces the following default sequence:
 
-1. Imports - import statements
-2. Type declarations - type, interface, enum (TypeScript)
-3. Define macros - defineProps, defineEmits, defineOptions, defineSlots, defineExpose, defineModel
-4. Composables - useXxx() calls (useRouter, useStore, custom composables)
-5. Reactive state - ref, reactive, shallowRef, etc.
-6. Computed - computed properties
-7. Watchers - watch, watchEffect
-8. Lifecycle hooks - onMounted, onBeforeMount, etc.
-9. Functions - function declarations and arrow functions
-10. Provide - provide calls
+1.  **Imports**: All `import` statements.
+2.  **Type Declarations**: TypeScript `type`, `interface`, and `enum` declarations.
+3.  **Define Macros**: `defineProps`, `defineEmits`, `defineOptions`, `defineSlots`, `defineExpose`, `defineModel`, and `withDefaults`.
+4.  **Composables**: Function calls following the `useXxx` pattern (e.g., `useRouter`, `useStore`).
+5.  **Reactive State**: Vue reactivity APIs such as `ref`, `reactive`, and `shallowRef`.
+6.  **Computed Properties**: `computed` declarations.
+7.  **Watchers**: `watch` and `watchEffect` calls.
+8.  **Lifecycle Hooks**: `onMounted`, `onBeforeMount`, and other lifecycle functions.
+9.  **Functions**: Regular function declarations and arrow functions.
+10. **Provide**: `provide` calls.
 
-## ✅ Examples
+## Examples
 
-### ❌ Incorrect
+### Incorrect
 
 ```vue
 <script setup>
   import { ref, computed } from 'vue';
 
   function increment() {
-    // ❌ function before ref
+    // Error: function declared before reactive state
     count.value++;
   }
 
   const count = ref(0);
 
-  onMounted(() => {}); // ❌ lifecycle before computed
+  onMounted(() => {}); // Error: lifecycle hook before computed property
 
   const doubled = computed(() => count.value * 2);
 </script>
 ```
 
-### ✅ Correct
+### Correct
 
 ```vue
 <script setup lang="ts">
@@ -121,11 +118,11 @@ The plugin enforces the following order in `<script setup>`:
 </script>
 ```
 
-## ⚙️ Options
+## Options
 
-### `groupBlankLines`
+### groupBlankLines
 
-Add blank lines between different categories (default: `true`).
+Ensures blank lines are present between different categories. Defaults to `true`.
 
 ```javascript
 {
@@ -135,20 +132,20 @@ Add blank lines between different categories (default: `true`).
 }
 ```
 
-### `order`
+### order
 
-Customize the order of categories. You can specify a custom array of category names to enforce your preferred order.
+Allows customization of the category sequence. Provide an array of category names to define your preferred order.
 
 **Available categories:**
 
-- `import` - Import statements
-- `types` - TypeScript type declarations (type, interface, enum)
-- `defineProps`, `defineEmits`, `defineOptions`, `defineSlots`, `defineExpose`, `defineModel`, `withDefaults` - Vue define macros
-- `composable` - Composable functions (useXxx)
-- `ref`, `reactive`, `computed`, `watch`, `watchEffect` - Vue reactivity APIs
-- `onMounted`, `onBeforeMount`, etc. - Lifecycle hooks
-- `function` - Function declarations
-- `provide` - Provide calls
+*   `import`
+*   `types` (type, interface, enum)
+*   `defineProps`, `defineEmits`, `defineOptions`, `defineSlots`, `defineExpose`, `defineModel`, `withDefaults`
+*   `composable` (useXxx)
+*   `ref`, `reactive`, `computed`, `watch`, `watchEffect`
+*   `onMounted`, `onBeforeMount`, etc.
+*   `function`
+*   `provide`
 
 **Example: Custom order**
 
@@ -173,24 +170,14 @@ Customize the order of categories. You can specify a custom array of category na
 }
 ```
 
-**Example: Functions before reactive state**
-
-```javascript
-{
-  'vue-setup-order/order': ['error', {
-    order: ['import', 'types', 'defineProps', 'function', 'ref', 'computed']
-  }]
-}
-```
-
-## 🔧 Auto-fix
+## Auto-fix
 
-This rule supports auto-fix! Run ESLint with `--fix` flag:
+This rule supports automatic fixing. Run ESLint with the `--fix` flag to resolve ordering issues:
 
 ```bash
 npx eslint --fix "src/**/*.vue"
 ```
 
-## 📄 License
+## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-vue-setup-order",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "ESLint plugin to enforce consistent order of statements in Vue 3 <script setup>",
   "keywords": [
     "eslint",