feat(cli): lingo.dev init cursor Command for .cursorrules Setup (#1101) (#1409)

* feat: add init cursor command

* feat: add init cursor command

* feat: add init cursor command

* Delete package-lock.json

* Rename cursor.md to agents.md

* Delete package-lock.json

* feat(cli): lingo.dev init cursor Command for .cursorrules Setup (#1101) refactored

* Delete agents.md

* feat(cli): lingo.dev init cursor Command for .cursorrules Setup (#1101) changeset

* feat(cli): lingo.dev init cursor Command for .cursorrules Setup (#1101) minor fixes

* Update packages/cli/src/cli/cmd/init/cursor.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update packages/cli/src/cli/cmd/init/cursor.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update packages/cli/src/cli/cmd/init/cursor.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update packages/cli/src/cli/cmd/init/cursor.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Restore accidentally deleted file

* Restore accidentally deleted file

* Add i18n rules for Cursor AI agents

* Update localization guidelines for Lingo.dev CLI

Change after discussion with The-Best-Codes over Discord

* Removing out of scope changes

* remove out of scope changes

* remove out of scope changes

* feat(cli): add agents.md in package.json

Signed-off-by: SK8-infi <shivansh.katiyar1712@gmail.com>

* feat(cli): add agents.md in package.json

Signed-off-by: SK8-infi <shivansh.katiyar1712@gmail.com>

* Refactor path resolution for agents.md

Updated path resolution for AGENTS_MD to handle both development and production environments.

Was causing error of "agents.md not found"
with help from @the_best_codes resolved the issue

---------

Signed-off-by: SK8-infi <shivansh.katiyar1712@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: SK8-infi

.changeset/nasty-nails-repair.md

@@ -0,0 +1,5 @@
+---
+"lingo.dev": minor
+---
+
+feat: add init cursor command for .cursorrules setup

packages/cli/agents.md

@@ -0,0 +1,12 @@
+# Lingo.dev CLI Localization Guidelines
+
+The following rules and guidelines should be followed to ensure effective AI-powered localization using the Lingo.dev CLI in projects using Lingo.dev:
+
+1. **Structure content for translation**: Organize user-facing strings in supported formats (e.g., JSON locale files, ARB, PO, Markdown) to allow the Lingo.dev CLI to efficiently extract and translate content. Avoid hardcoding text directly in code where possible; use structured keys or files that the CLI can process.
+2. **Locale files**: Store source content and translations in locale-specific files or directories (e.g., `en.json`, `app/i18n/fr.json`). The Lingo.dev CLI will automatically generate and keep target locale files in sync by translating only new or changed content.
+3. **Source language as fallback**: Use a primary source language (usually English) as the base. The CLI treats your project files as the source of truth and provides fallbacks naturally through your runtime i18n setup for any missing translations.
+4. **Pluralization and formatting**: Use i18n formats and libraries that support pluralization, placeholders, and locale-specific date/number formatting (e.g., ICU MessageFormat). The CLI preserves these structures during AI translation for accurate results.
+5. **Avoid concatenation**: Do not concatenate translatable strings. Provide complete messages with interpolation placeholders so the AI translator can produce natural, contextually accurate results.
+6. **Contextual translations**: Add context or translator notes in your configuration (via buckets or comments in supported formats) for ambiguous terms. This helps the AI generate higher-quality translations.
+7. **Testing and review**: Run the Lingo.dev CLI regularly (e.g., in CI/CD) to generate translations, then test your application in multiple locales. Review AI-generated translations for accuracy and tone, using features like key locking to preserve approved versions.
+_For more details, refer to the Lingo.dev CLI documentation at lingo.dev or join the community Discord._

packages/cli/package.json

@@ -113,7 +113,8 @@
   "files": [
     "bin",
     "build",
-    "assets"
+    "assets",
+    "agents.md"
   ],
   "scripts": {
     "lingo.dev": "node --inspect=9229 ./bin/cli.mjs",

packages/cli/src/cli/cmd/init.ts

@@ -19,6 +19,7 @@ import { ensurePatterns } from "../utils/ensure-patterns";
 import updateGitignore from "../utils/update-gitignore";
 import initCICD from "../utils/init-ci-cd";
 import open from "open";
+import cursorInitCmd from "./init/cursor";
 
 const openUrl = (path: string) => {
   const settings = getSettings(undefined);
@@ -116,8 +117,8 @@ export default new InteractiveCommand()
             throw new Error(`Invalid path: ${p}`);
           }
         }
-
         return values;
+        
       })
       .prompt(undefined) // make non-interactive
       .default([]),
@@ -258,4 +259,5 @@ export default new InteractiveCommand()
     if (!isInteractive) {
       Ora().info("Please see https://lingo.dev/cli");
     }
-  });
+  })
+  .addCommand(cursorInitCmd);

packages/cli/src/cli/cmd/init/cursor.ts

@@ -0,0 +1,58 @@
+import { InteractiveCommand, InteractiveOption } from "interactive-commander";
+import Ora from "ora";
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+import { confirm } from "@inquirer/prompts";
+
+// Get the directory of this file
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+// Access agents.md from package root (works in both dev and production)
+// Resolve from current file location: try both paths to handle dev and bundled environments
+const AGENTS_MD = fs.existsSync(path.resolve(__dirname, "../agents.md"))
+  ? path.resolve(__dirname, "../agents.md")
+  : path.resolve(__dirname, "../../../../agents.md");
+// Create .cursorrules in user's current working directory
+const CURSORRULES = path.resolve(process.cwd(), ".cursorrules");
+
+export default new InteractiveCommand()
+  .command("cursor")
+  .description("Initialize .cursorrules with i18n-specific instructions for Cursor AI.")
+  .addOption(
+    new InteractiveOption("-f, --force", "Overwrite .cursorrules without prompt.")
+      .default(false)
+  )
+  .action(async (options) => {
+    const spinner = Ora();
+    // Read agents.md
+    let template: string;
+    try {
+      template = fs.readFileSync(AGENTS_MD, "utf-8");
+    } catch (err) {
+      spinner.fail("Template file agents.md not found. Please reinstall the package.");
+      return process.exit(1);
+    }
+    // Check for existing .cursorrules
+    const exists = fs.existsSync(CURSORRULES);
+    let shouldWrite;
+    if (exists && !options.force) {
+      shouldWrite = await confirm({
+        message: ".cursorrules already exists. Overwrite?",
+      });
+      if (!shouldWrite) {
+        spinner.info("Skipped: .cursorrules left unchanged.");
+        return;
+      }
+    }
+    try {
+      fs.writeFileSync(CURSORRULES, template);
+      spinner.succeed("Created .cursorrules");
+      spinner.info(
+        ".cursorrules has been created with i18n-specific instructions for Cursor AI.",
+      );
+    } catch (err) {
+      spinner.fail(`Failed to write .cursorrules: ${err}`);
+      process.exit(1);
+    }
+  });