--- name: lokalise-local-dev-loop-f0b55d7544a4 description: | Configure Lokalise local development with file sync and hot reload. Use when setting up a development environment, configuring translation sync, or establishing a fast iteration cycle with Lokalise. Trigger with phrases like "lokalise dev setup", "lokalise local development", "lokalise dev environment", "develop with lokalise", "lokalise sync". allowed-tools: Read, Write, Edit, Bash(npm:*), Bash(pnpm:*), Bash(lokalise2:*), Grep version: 1.0.0 license: MIT author: Jeremy Longshore --- # Lokalise Local Dev Loop ## Overview Set up a fast, reproducible local development workflow for Lokalise with automatic translation sync. ## Prerequisites - Completed `lokalise-install-auth` setup - Node.js 18+ with npm/pnpm - Lokalise CLI v2 (`lokalise2`) installed - Existing Lokalise project ## Instructions ### Step 1: Create Project Structure ``` my-lokalise-project/ ├── src/ │ ├── i18n/ │ │ ├── index.ts # i18n setup and exports │ │ └── config.ts # Lokalise configuration │ └── locales/ │ ├── en.json # English (base) │ ├── es.json # Spanish │ └── fr.json # French ├── scripts/ │ ├── lokalise-pull.sh # Download translations │ └── lokalise-push.sh # Upload source strings ├── .env.local # Local secrets (git-ignored) ├── .env.example # Template for team ├── lokalise.json # Lokalise CLI config └── package.json ``` ### Step 2: Create Lokalise CLI Config ```json // lokalise.json { "$schema": "https://json.schemastore.org/lokalise.json", "project_id": "YOUR_PROJECT_ID.abcdef", "export": { "format": "json", "original_filenames": false, "bundle_structure": "locales/%LANG_ISO%.json", "placeholder_format": "icu", "export_empty_as": "skip" }, "import": { "file_path": "./src/locales/en.json", "lang_iso": "en", "replace_modified": true, "convert_placeholders": true, "detect_icu_plurals": true } } ``` ### Step 3: Create Sync Scripts ```bash #!/bin/bash # scripts/lokalise-pull.sh - Download translations from Lokalise set -e PROJECT_ID="${LOKALISE_PROJECT_ID:-$(jq -r '.project_id' lokalise.json)}" echo "Pulling translations from Lokalise..." lokalise2 \ --token "$LOKALISE_API_TOKEN" \ --project-id "$PROJECT_ID" \ file download \ --format json \ --original-filenames=false \ --bundle-structure "src/locales/%LANG_ISO%.json" \ --placeholder-format icu \ --export-empty-as skip \ --unzip-to . echo "Translations downloaded to src/locales/" ``` ```bash #!/bin/bash # scripts/lokalise-push.sh - Upload source strings to Lokalise set -e PROJECT_ID="${LOKALISE_PROJECT_ID:-$(jq -r '.project_id' lokalise.json)}" echo "Pushing source strings to Lokalise..." lokalise2 \ --token "$LOKALISE_API_TOKEN" \ --project-id "$PROJECT_ID" \ file upload \ --file "./src/locales/en.json" \ --lang-iso en \ --replace-modified \ --convert-placeholders \ --detect-icu-plurals \ --poll \ --poll-timeout 120s echo "Source strings uploaded successfully!" ``` ### Step 4: Configure package.json Scripts ```json { "scripts": { "dev": "vite", "build": "vite build", "i18n:pull": "bash scripts/lokalise-pull.sh", "i18n:push": "bash scripts/lokalise-push.sh", "i18n:sync": "npm run i18n:push && npm run i18n:pull", "predev": "npm run i18n:pull", "prebuild": "npm run i18n:pull" } } ``` ### Step 5: Set Up File Watcher (Optional) ```typescript // scripts/watch-translations.ts import chokidar from "chokidar"; import { exec } from "child_process"; const watcher = chokidar.watch("./src/locales/en.json", { persistent: true, ignoreInitial: true, }); watcher.on("change", (path) => { console.log(`Source file changed: ${path}`); console.log("Pushing to Lokalise..."); exec("npm run i18n:push", (error, stdout, stderr) => { if (error) { console.error(`Push failed: ${error.message}`); return; } console.log(stdout); }); }); console.log("Watching for translation changes..."); ``` ## Output - Working development environment with translation sync - CLI scripts for push/pull operations - Optional file watcher for automatic uploads - Pre-build hooks ensure translations are current ## Error Handling | Error | Cause | Solution | |-------|-------|----------| | `project_id not found` | Missing config | Set LOKALISE_PROJECT_ID or lokalise.json | | `File not found` | Wrong path | Check bundle_structure matches src/locales | | `Rate limit 429` | Too many requests | Add delay between operations | | `Polling timeout` | Large file upload | Increase poll-timeout | ## Examples ### Quick Pull/Push Commands ```bash # Pull all translations npm run i18n:pull # Push source strings only npm run i18n:push # Full sync (push then pull) npm run i18n:sync ``` ### Environment Setup ```bash # .env.local LOKALISE_API_TOKEN=your-api-token LOKALISE_PROJECT_ID=123456789.abcdef ``` ### React i18n Integration ```typescript // src/i18n/index.ts import i18n from "i18next"; import { initReactI18next } from "react-i18next"; import en from "../locales/en.json"; import es from "../locales/es.json"; import fr from "../locales/fr.json"; i18n.use(initReactI18next).init({ resources: { en: { translation: en }, es: { translation: es }, fr: { translation: fr }, }, lng: "en", fallbackLng: "en", interpolation: { escapeValue: false }, }); export default i18n; ``` ### Git Hooks with Husky ```bash # .husky/pre-commit #!/bin/sh npm run i18n:push ``` ## Resources - [Lokalise CLI Documentation](https://docs.lokalise.com/en/articles/3401683-lokalise-cli-v2) - [File Upload API](https://developers.lokalise.com/reference/upload-a-file) - [File Download API](https://developers.lokalise.com/reference/download-files) ## Next Steps See `lokalise-sdk-patterns` for production-ready code patterns. --- Source attribution: Dicklesworthstone Original project: https://github.com/Dicklesworthstone/pi_agent_rust/blob/f28fc46ee0db8e710d95b8b55592cd38d60f2b26/tests/ext_conformance/artifacts/plugins-community/plugins/saas-packs/lokalise-pack/skills/lokalise-local-dev-loop/SKILL.md License: MIT License information: https://opensource.org/license/mit Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice MIT License (with OpenAI/Anthropic Rider) Copyright (c) 2026 Jeffrey Emanuel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: ADDITIONAL RIDER / RESTRICTION (OpenAI / Anthropic): This rider is part of the "conditions" of this License. In the event of any conflict between this rider and any other portion of this License, this rider controls. "Restricted Parties" means OpenAI, L.L.C.; Anthropic, PBC; any of their respective Affiliates; and any person or entity acting directly or indirectly on behalf of, for the benefit of, or under the direction of any of the foregoing (including any officer, director, employee, contractor, agent, consultant, service provider, or representative). Notwithstanding any other provision of this License, no rights are granted to any Restricted Party. Any purported license, sublicense, assignment, transfer, or other permission to any Restricted Party is null and void absent the express prior written permission of Jeffrey Emanuel. You may not provide, disclose, distribute, sublicense, sell, lease, lend, host, make available, or otherwise permit access to the Software or any derivative work of the Software (as defined in applicable copyright law) (collectively, "Derivative Works") to or for any Restricted Party. For purposes of this rider, "use" includes, without limitation: copying, modifying, merging, publishing, distributing, sublicensing, selling, transferring, making available, hosting, deploying, executing, benchmarking, testing, analyzing, indexing, or incorporating the Software or any Derivative Works into any dataset, training corpus, evaluation harness, or pipeline for machine learning or other automated systems. This rider applies to the Software and all Derivative Works. As a condition of use, you agree that this rider is a precondition to exercising any rights under this License, and you agree that any distribution of the Software or any Derivative Works must include this rider provision unmodified. Any breach of this rider automatically and immediately terminates the permissions granted by this License. Upon termination, you must immediately cease all use and distribution of the Software and any Derivative Works and destroy all copies under your control. You agree that a breach of this rider would cause irreparable harm and that Jeffrey Emanuel may seek injunctive or other equitable relief to enforce this rider, in addition to any other remedies available at law. To the maximum extent permitted by applicable law, the prevailing party in any action to enforce this rider shall be entitled to recover reasonable attorneys' fees and costs. For purposes of this rider, "Affiliate" means any entity that directly or indirectly controls, is controlled by, or is under common control with the specified party. "Control" means ownership of more than 50% of the voting securities or other ownership interest, or the power to direct management or policies by contract or otherwise. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # Mega AI Hub resource metadata Creator / publisher: Dicklesworthstone Original project: https://github.com/Dicklesworthstone/pi_agent_rust/blob/f28fc46ee0db8e710d95b8b55592cd38d60f2b26/tests/ext_conformance/artifacts/plugins-community/plugins/saas-packs/lokalise-pack/skills/lokalise-local-dev-loop/SKILL.md Attribution basis: Source repository record Fields of work: Design, Development & Engineering, Product Management Roles: Backend Developer, Frontend Developer, Growth Product Manager, Product Manager, UX Designer Specialties: API, Backend Tools: Lokalise, Node.Js Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 6cfcecf7102e910b5ce218d7e6695b54ac2a10576c44a9d7ccc38d56481fb656