chore: update documentation and configuration for improved clarity and functionality

Author: iqbalhasandev

CHANGELOG.md

@@ -34,23 +34,27 @@ All notable changes to `@devwizard/laravel-localizer-vue` will be documented in
   - Automatic page props detection
 
 ### 📚 Documentation
+
 - Comprehensive README with usage examples
 - API documentation with TypeScript interfaces
 - Migration guide from v1 to v2
 
 ### 🧪 Testing
+
 - Vitest configuration
 - Comprehensive test suite with 100% coverage
 - Vue Test Utils for component testing
 - ESM module support
 
 ### 🛠️ Development Tools
+
 - ESLint configuration with TypeScript and Vue rules
 - Prettier for code formatting
 - tsup for building and bundling
 - GitHub Actions for CI/CD
 
 ### 📦 Package Configuration
+
 - ESM-only distribution
 - Tree-shakeable exports
 - Proper package.json exports field

README.md

@@ -23,6 +23,7 @@ yarn add @devwizard/laravel-localizer-vue
 ```
 
 **Backend (Composer):**
+
 ```bash
 composer require devwizardhq/laravel-localizer
 php artisan localizer:install --framework=vue
@@ -167,18 +168,18 @@ const { translations, locale } = useTranslation();
 
 Returns an object with the following properties and methods:
 
-| Property | Type | Description |
-|----------|------|-------------|
-| `__` | `(key, replacements?, fallback?) => string` | Main translation function |
-| `trans` | `(key, replacements?, fallback?) => string` | Alias for `__` |
-| `lang` | `(key, replacements?, fallback?) => string` | Alias for `__` |
-| `has` | `(key) => boolean` | Check if translation key exists |
-| `choice` | `(key, count, replacements?) => string` | Pluralization support |
-| `locale` | `ComputedRef<string>` | Current locale code (reactive) |
-| `dir` | `ComputedRef<'ltr' \| 'rtl'>` | Text direction (reactive) |
-| `availableLocales` | `ComputedRef<Record<string, LocaleInfo>>` | Available locales with metadata (reactive) |
-| `translations` | `ComputedRef<Record<string, string>>` | All translations for current locale (reactive) |
-| `getLocales` | `() => string[]` | Get all available locale codes |
+| Property           | Type                                        | Description                                    |
+| ------------------ | ------------------------------------------- | ---------------------------------------------- |
+| `__`               | `(key, replacements?, fallback?) => string` | Main translation function                      |
+| `trans`            | `(key, replacements?, fallback?) => string` | Alias for `__`                                 |
+| `lang`             | `(key, replacements?, fallback?) => string` | Alias for `__`                                 |
+| `has`              | `(key) => boolean`                          | Check if translation key exists                |
+| `choice`           | `(key, count, replacements?) => string`     | Pluralization support                          |
+| `locale`           | `ComputedRef<string>`                       | Current locale code (reactive)                 |
+| `dir`              | `ComputedRef<'ltr' \| 'rtl'>`               | Text direction (reactive)                      |
+| `availableLocales` | `ComputedRef<Record<string, LocaleInfo>>`   | Available locales with metadata (reactive)     |
+| `translations`     | `ComputedRef<Record<string, string>>`       | All translations for current locale (reactive) |
+| `getLocales`       | `() => string[]`                            | Get all available locale codes                 |
 
 ## Vite Plugin Options
 
@@ -227,8 +228,8 @@ The package is fully typed. Generated translation files include TypeScript defin
 ```typescript
 // Generated by localizer:generate
 export const en = {
-  "welcome": "Welcome",
-  "validation.required": "This field is required",
+  welcome: 'Welcome',
+  'validation.required': 'This field is required',
 } as const;
 
 export type TranslationKeys = keyof typeof en;

composables/useTranslation.ts

@@ -94,7 +94,9 @@ export interface UseTranslationReturn {
   /**
    * Available locales with metadata (reactive)
    */
-  availableLocales: ComputedRef<Record<string, { label: string; flag: string; dir: 'ltr' | 'rtl' }>>;
+  availableLocales: ComputedRef<
+    Record<string, { label: string; flag: string; dir: 'ltr' | 'rtl' }>
+  >;
 
   /**
    * All translations for current locale (reactive)
@@ -157,9 +159,7 @@ export function useTranslation(): UseTranslationReturn {
 
   const locale = computed(() => page.props.locale?.current || 'en');
   const dir = computed(() => page.props.locale?.dir || 'ltr');
-  const availableLocales = computed(
-    () => page.props.locale?.available || {}
-  );
+  const availableLocales = computed(() => page.props.locale?.available || {});
 
   // Dynamically import translations from generated files
   // Note: Users need to set up path alias '@/lang' -> 'resources/js/lang'
@@ -171,7 +171,9 @@ export function useTranslation(): UseTranslationReturn {
       interface WindowWithTranslations extends Window {
         __LARAVEL_LOCALIZER_TRANSLATIONS__?: Record<string, Record<string, string>>;
       }
-      return (window as WindowWithTranslations).__LARAVEL_LOCALIZER_TRANSLATIONS__?.[locale.value] || {};
+      return (
+        (window as WindowWithTranslations).__LARAVEL_LOCALIZER_TRANSLATIONS__?.[locale.value] || {}
+      );
     } catch {
       console.warn(`[Laravel Localizer] Could not load translations for locale: ${locale.value}`);
       return {};

eslint.config.js

@@ -1,21 +1,13 @@
 import js from '@eslint/js';
 import tseslint from 'typescript-eslint';
 import vuePlugin from 'eslint-plugin-vue';
-import vueParser from 'vue-eslint-parser';
 
 export default tseslint.config(
   js.configs.recommended,
   ...tseslint.configs.recommended,
   ...vuePlugin.configs['flat/recommended'],
   {
-    files: ['**/*.ts', '**/*.vue'],
-    languageOptions: {
-      parser: vueParser,
-      parserOptions: {
-        parser: tseslint.parser,
-        extraFileExtensions: ['.vue'],
-      },
-    },
+    files: ['**/*.ts', '**/*.tsx', '**/*.vue'],
     rules: {
       '@typescript-eslint/no-explicit-any': 'warn',
       '@typescript-eslint/no-unused-vars': [
@@ -29,7 +21,7 @@ export default tseslint.config(
     },
   },
   {
-    files: ['**/__tests__/**'],
+    files: ['**/__tests__/**', '**/*.test.ts', '**/*.spec.ts'],
     rules: {
       '@typescript-eslint/no-explicit-any': 'off',
     },

eslint.config.min.js

@@ -1 +1,24 @@
-import js from"@eslint/js";import tseslint from"typescript-eslint";import vuePlugin from"eslint-plugin-vue";import vueParser from"vue-eslint-parser";export default tseslint.config(js.configs.recommended,...tseslint.configs.recommended,...vuePlugin.configs["flat/recommended"],{files:["**/*.ts","**/*.vue"],languageOptions:{parser:vueParser,parserOptions:{parser:tseslint.parser,extraFileExtensions:[".vue"]}},rules:{"@typescript-eslint/no-explicit-any":"warn","@typescript-eslint/no-unused-vars":["error",{argsIgnorePattern:"^_",varsIgnorePattern:"^_"}],"vue/multi-word-component-names":"off"}},{files:["**/__tests__/**"],rules:{"@typescript-eslint/no-explicit-any":"off"}},{ignores:["dist/**","node_modules/**","coverage/**","*.config.*","eslint.config.js"]});
+import js from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import vuePlugin from 'eslint-plugin-vue';
+export default tseslint.config(
+  js.configs.recommended,
+  ...tseslint.configs.recommended,
+  ...vuePlugin.configs['flat/recommended'],
+  {
+    files: ['**/*.ts', '**/*.tsx', '**/*.vue'],
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ],
+      'vue/multi-word-component-names': 'off',
+    },
+  },
+  {
+    files: ['**/__tests__/**', '**/*.test.ts', '**/*.spec.ts'],
+    rules: { '@typescript-eslint/no-explicit-any': 'off' },
+  },
+  { ignores: ['dist/**', 'node_modules/**', 'coverage/**', '*.config.*', 'eslint.config.js'] }
+);

package-lock.json

@@ -79,8 +79,8 @@
   "homepage": "https://github.com/DevWizardHQ/laravel-localizer#readme",
   "peerDependencies": {
     "@inertiajs/vue3": "^1.0.0 || ^2.0.0",
-    "vue": "^3.0.0",
-    "vite": "^5.0.0 || ^6.0.0 || ^7.0.0"
+    "vite": "^5.0.0 || ^6.0.0 || ^7.0.0",
+    "vue": "^3.0.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.17.0",
@@ -96,6 +96,7 @@
     "typescript-eslint": "^8.41.0",
     "vite": "^7.2.2",
     "vitest": "^4.0.8",
-    "vue": "^3.5.13"
+    "vue": "^3.5.13",
+    "vue-eslint-parser": "^10.2.0"
   }
 }

package.json

@@ -37,14 +37,6 @@
     "noUncheckedIndexedAccess": true,
     "skipLibCheck": true
   },
-  "include": [
-    "**/*.ts",
-    "**/*.tsx"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist",
-    "__tests__",
-    "**/*.test.ts"
-  ]
+  "include": ["**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules", "dist", "__tests__", "**/*.test.ts"]
 }

tsconfig.json

@@ -32,14 +32,14 @@ export interface LocalizerPluginOptions {
 
 /**
  * Vite plugin for Laravel Localizer
- * 
+ *
  * Automatically regenerates TypeScript translation files when Laravel language files change.
- * 
+ *
  * @example
  * ```ts
  * import { defineConfig } from 'vite';
  * import { laravelLocalizer } from '@devwizard/laravel-localizer-vue/vite';
- * 
+ *
  * export default defineConfig({
  *   plugins: [
  *     laravelLocalizer({