Starter Kits Laravel Package

Getting Started

Minimal Steps

1. Installation (unchanged):

   composer require laravel-lang/starter-kits --dev
   

2. Update Translations (updated for 1.15.0): Run the Artisan command to pull the latest translations, including new keys for teams and workos-teams across all frameworks (Livewire, Vue, React, Svelte):

   php artisan lang:update
   

   Verify the updated files in:

   resources/lang/vendor/laravel-lang/starter-kits/livewire/
   resources/lang/vendor/laravel-lang/starter-kits/vue/
   resources/lang/vendor/laravel-lang/starter-kits/react/
   resources/lang/vendor/laravel-lang/starter-kits/svelte/
   

3. Verify New Keys: Check for new keys like:

   • laravel-lang/starter-kits.livewire::workos-teams.*
   • laravel-lang/starter-kits.vue::teams.* (and other frameworks) Example:

   grep "workos-teams" resources/lang/vendor/laravel-lang/starter-kits/livewire/en.json
   

First Use Case (updated)

Use the new workos-teams keys in your components. Example for Livewire:

// Updated for workos-teams support
public function render()
{
    return view('livewire.example', [
        'title' => __('laravel-lang/starter-kits.livewire::workos-teams.title'),
        'description' => __('laravel-lang/starter-kits.livewire::teams.description'),
    ]);
}

Or in Blade:

<p>{{ __('laravel-lang/starter-kits.vue::teams.create') }}</p>
<p>{{ __('laravel-lang/starter-kits.svelte::workos-teams.invite') }}</p>

Implementation Patterns

Workflows (updated)

1. Pulling Updates (emphasize new keys): After updating to 1.15.0, run:

   php artisan lang:update
   

   Focus on:

   • workos-teams keys (new in this release) for all frameworks.
   • French (fr) and Japanese (ja) locales (updated for passkeys and missing keys).

2. Language-Specific Overrides (updated): Override new keys in your project’s resources/lang/. Example for Spanish:

   // resources/lang/es/livewire.json
   {
       "workos-teams": {
           "title": "Equipos de trabajo personalizados",
           "invite": "Invitar a colaboradores"
       }
   }
   

3. Integration with Starter Kits (updated):

   • Livewire/React/Svelte/Vue: Use the new workos-teams keys in your components. Example for Vue:

     <template>
         <h1>{{ $t('laravel-lang/starter-kits.vue::workos-teams.title') }}</h1>
     </template>
     

   • Frontend Frameworks: Ensure your build process includes the updated translations. For Vite:

     // resources/js/app.js
     import workosTeamsTranslations from '@/lang/livewire/workos-teams.json';
     

4. Dynamic Language Switching (unchanged): Use middleware to handle locale changes, especially for new locales like ja (Japanese) which now has updated keys.

Integration Tips (updated)

• Namespace Conflicts: Prefix new keys (e.g., laravel-lang/starter-kits.svelte::workos-teams.*) to avoid clashes.
• Frontend Integration: For SPAs, recompile assets after updating translations to include new keys:

  npm run dev
  

• Testing: Test new keys in all locales, especially fr (passkeys updates) and ja (missing keys filled). Example test case:

  $this->assertEquals(
      'Clés d’accès', // Updated French term
      __('laravel-lang/starter-kits.livewire::teams.passkeys')
  );
  

Gotchas and Tips

Pitfalls (updated)

1. Missing Keys in 1.15.0:

   • If a key like laravel-lang/starter-kits.livewire::workos-teams.xyz is missing, verify it exists in the latest release.
   • French (fr) locale: Some terms (e.g., "passkeys") were updated. Check for deprecated keys in your overrides.

2. Caching (emphasized): After running lang:update, clear caches and rebuild frontend assets:

   php artisan view:clear
   php artisan config:clear
   npm run dev  # For Vite/Webpack
   

3. Locale-Specific Issues:

   • Japanese (ja): Now includes missing keys but may need UI testing for RTL/LTR alignment.
   • French (fr): Updated passkey terminology may break existing translations. Review overrides in resources/lang/fr/.

4. Artisan Command Failures:

   • If lang:update fails, check:
     • New keys in workos-teams are valid JSON.
     • Permissions for resources/lang/vendor/.

Debugging (updated)

• Log Missing Keys: Enable debug mode and check logs for new keys like workos-teams:

  // config/app.php
  'debug' => true,
  

  Example log entry:

  translation missing: en.laravel-lang/starter-kits.svelte::workos-teams.invite
  

• Validate JSON: Manually validate new files (e.g., workos-teams.json) for syntax errors:

  jsonlint resources/lang/vendor/laravel-lang/starter-kits/livewire/workos-teams.json
  

Tips (updated)

1. Contribute Translations: Help fill gaps in Japanese (ja) or French (fr) for new workos-teams keys:

   git clone https://github.com/Laravel-Lang/starter-kits.git
   # Edit resources/lang/ja/livewire/workos-teams.json
   

2. Extend for Custom Starter Kits: Create a custom namespace for workos-teams:

   resources/lang/vendor/my-starter-kit/workos-teams/
   

   Load via a service provider:

   $this->loadTranslationsFrom(__DIR__.'/../lang/vendor/my-starter-kit', 'my-starter-kit');
   

3. Performance: Use fallbacks for new keys to avoid errors:

   __('laravel-lang/starter-kits.livewire::workos-teams.title', [], 'en');
   

4. CI/CD Integration (updated): Add steps to update translations and rebuild assets in your pipeline:

   - name: Update translations and assets
     run: |
       php artisan lang:update
       npm install && npm run build