@lingo.dev/compiler 0.1.0

package/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2024 Lingo.dev
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,192 @@
+# @lingo.dev/compiler
+
+See the main [README](../../README.md) for general information.
+
+Lingo.dev compiler with automatic translation support for React applications.
+
+This package provides plugins for multiple bundlers (Vite, Webpack) and Next.js that
+automatically transforms React components to inject translation calls.
+
+## Features
+
+- **Automatic JSX text transformation** - Automatically detects and transforms translatable text in JSX
+- **Opt-in or automatic** - Configure whether to require `'use i18n'` directive or transform all files
+- **Multi-bundler support** - Works with Vite, Webpack and Next.js (both Webpack and Turbopack builds)
+- **Translation server** - On-demand translation generation during development
+- **AI-powered translations** - Support for multiple LLM providers and Lingo.dev Engine
+
+## Getting started
+
+Install the package - `pnpm install @lingo.dev/compiler`
+
+### Vite
+
+- Configure the plugin in your vite config.
+
+  ```ts
+  import { defineConfig } from "vite";
+  import { lingoCompilerPlugin } from "@lingo.dev/compiler/vite";
+
+  export default defineConfig({
+    plugins: [
+      lingoCompilerPlugin({
+        sourceRoot: "src",
+        sourceLocale: "en",
+        targetLocales: ["es", "de", "fr"],
+        models: "lingo.dev",
+        dev: {
+          usePseudotranslator: true,
+        },
+      }), // ...other plugins
+    ],
+  });
+  ```
+
+- Wrap your app with `LingoProvider`. It should be used as early as possible in your app.
+  e.g. in vite example with tanstack-router `LingoProvider` should be above `RouterProvider`, otherwise code-splitting breaks contexts.
+  ```tsx
+  // Imports and other tanstack router setup
+  if (rootElement && !rootElement.innerHTML) {
+    const root = ReactDOM.createRoot(rootElement);
+    root.render(
+      <StrictMode>
+        <LingoProvider>
+          <RouterProvider router={router} />
+        </LingoProvider>
+      </StrictMode>,
+    );
+  }
+  ```
+
+See `demo/vite-react-spa` for the working example
+
+### Next.js
+
+- Use `withLingo` function to wrap your existing next config. You will have to make your config async.
+
+  ```ts
+  import type { NextConfig } from "next";
+  import { withLingo } from "@lingo.dev/compiler/next";
+
+  const nextConfig: NextConfig = {};
+
+  export default async function (): Promise<NextConfig> {
+    return await withLingo(nextConfig, {
+      sourceRoot: "./app",
+      sourceLocale: "en",
+      targetLocales: ["es", "de", "ru"],
+      models: "lingo.dev",
+      dev: {
+        usePseudotranslator: true,
+      },
+      buildMode: "cache-only",
+    });
+  }
+  ```
+
+- Wrap your app with `LingoProvider`. It should be used as early as possible in your app, root `Layout` is a good place.
+  ```tsx
+  export default function RootLayout({
+    children,
+  }: Readonly<{ children: React.ReactNode }>) {
+    return (
+      <LingoProvider>
+        <html>
+          <body className="antialiased">{children}</body>
+        </html>
+      </LingoProvider>
+    );
+  }
+  ```
+
+## Development
+
+`pnpm install` from project root
+`pnpm turbo dev --filter=@lingo.dev/compile` to compile and watch for compiler changes
+
+Choose the demo you want to work with and run it from the corresponding folder.
+`tsdown` in compiler is configured to cleanup the output folder before compilation, which works fine with next, but vite
+seems to be dead every time and has to be restarted.
+
+## Structure
+
+The compiler is organized into several key modules:
+
+### Core Directories
+
+#### `src/plugin/` - Build-time transformation
+
+- **`transform/`** - Babel AST transformation logic for JSX text extraction
+- **`unplugin.ts`** - Universal plugin implementation (Vite, Webpack)
+- **`next.ts`** - Next.js-specific plugin with Turbopack and Webpack support
+- **`build-translator.ts`** - Batch translation generation at build time
+- **`virtual-modules-code-generator.ts`** - Generates code for virtual modules, dev config and locale resolvers for client and server
+
+#### `src/metadata/` - Translation metadata management
+
+- **`manager.ts`** - CRUD operations for `.lingo/metadata.json`
+- Thread-safe metadata file operations with file locking
+- Manages translation entries with hash-based identifiers
+
+#### `src/translators/` - Translation provider abstraction
+
+- **`lcp/`** - Lingo.dev Engine integration
+- **`pseudotranslator/`** - Development-mode fake translator
+- **`pluralization/`** - Automatic ICU MessageFormat detection
+- **`translator-factory.ts`** - Provider selection and initialization
+
+#### `src/translation-server/` - Development server
+
+- **`translation-server.ts`** - HTTP server for on-demand translations
+- **`cli.ts`** - Standalone CLI for translation generation
+- WebSocket support for real-time dev widget updates
+- Port management (60000-60099 range)
+
+#### `src/react/` - Runtime translation hooks
+
+- **`client/`** - Client-side Context-based hooks
+- **`server/`** - Server component cache-based hooks (isomorphic)
+- **`server-only/`** - Async server-only API (`getServerTranslations`)
+- **`shared/`** - Shared utilities (RichText rendering, Context)
+- **`next/`** - Next.js-specific middleware and locale switcher
+
+#### `src/utils/` - Shared utilities
+
+- **`hash.ts`** - Stable hash generation for translation keys
+- **`config-factory.ts`** - Configuration defaults and merging
+- **`logger.ts`** - Structured logging utilities
+- **`path-helpers.ts`** - File path resolution
+
+#### `src/widget/` - Development widget
+
+- In-browser translation editor overlay for development mode
+
+### Support Directories
+
+#### `tests/` - End-to-end testing
+
+- **`e2e/`** - Playwright tests for full build workflows
+- **`fixtures/`** - Test applications (Vite, Next.js)
+- **`helpers/`** - Test utilities and assertions
+
+#### `benchmarks/` - Performance benchmarks
+
+- Translation speed benchmarks
+- Metadata I/O performance tests
+
+#### `old-docs/` - Legacy documentation
+
+- Historical design documents and notes
+
+### Entry Points
+
+- **`src/index.ts`** - Main package exports (plugins, types)
+- **`src/types.ts`** - Core TypeScript types
+
+## Contributing
+
+This is a beta package under active development. Feedback and contributions are welcome!
+
+## License
+
+ISC

package/build/_virtual/rolldown_runtime.cjs

@@ -0,0 +1,29 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+exports.__toESM = __toESM;

package/build/_virtual/rolldown_runtime.mjs

@@ -0,0 +1,7 @@
+import { createRequire } from "node:module";
+
+//#region rolldown:runtime
+var __require = /* @__PURE__ */ createRequire(import.meta.url);
+
+//#endregion
+export { __require };

package/build/index.d.cts

@@ -0,0 +1,2 @@
+import { PartialLingoConfig } from "./types.cjs";
+export { type PartialLingoConfig };

package/build/index.d.mts

@@ -0,0 +1,2 @@
+import { PartialLingoConfig } from "./types.mjs";
+export { type PartialLingoConfig };

package/build/index.mjs

@@ -0,0 +1 @@
+export {  };

package/build/metadata/manager.cjs

@@ -0,0 +1,131 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_logger = require('../utils/logger.cjs');
+const require_timeout = require('../utils/timeout.cjs');
+const require_path_helpers = require('../utils/path-helpers.cjs');
+let fs_promises = require("fs/promises");
+fs_promises = require_rolldown_runtime.__toESM(fs_promises);
+let path = require("path");
+path = require_rolldown_runtime.__toESM(path);
+let fs = require("fs");
+fs = require_rolldown_runtime.__toESM(fs);
+let proper_lockfile = require("proper-lockfile");
+proper_lockfile = require_rolldown_runtime.__toESM(proper_lockfile);
+
+//#region src/metadata/manager.ts
+function createEmptyMetadata() {
+	return {
+		entries: {},
+		stats: {
+			totalEntries: 0,
+			lastUpdated: (/* @__PURE__ */ new Date()).toISOString()
+		}
+	};
+}
+function loadMetadata(path$2) {
+	return new MetadataManager(path$2).loadMetadata();
+}
+function cleanupExistingMetadata(metadataFilePath) {
+	require_logger.logger.debug(`Attempting to cleanup metadata file: ${metadataFilePath}`);
+	try {
+		fs.default.unlinkSync(metadataFilePath);
+		require_logger.logger.info(`🧹 Cleaned up build metadata file: ${metadataFilePath}`);
+	} catch (error) {
+		if (error.code === "ENOENT") require_logger.logger.debug(`Metadata file already deleted or doesn't exist: ${metadataFilePath}`);
+		else require_logger.logger.warn(`Failed to cleanup metadata file: ${error.message}`);
+	}
+}
+/**
+* Get the absolute path to the metadata file
+*
+* @param config - Config with sourceRoot, lingoDir, and environment
+* @returns Absolute path to metadata file
+*/
+function getMetadataPath(config) {
+	const filename = config.environment === "development" ? "metadata-dev.json" : "metadata-build.json";
+	return path.default.join(require_path_helpers.getLingoDir(config), filename);
+}
+var MetadataManager = class {
+	constructor(filePath) {
+		this.filePath = filePath;
+	}
+	/**
+	* Load metadata from disk
+	* Creates empty metadata if file doesn't exist
+	* Times out after 15 seconds to prevent indefinite hangs
+	*/
+	async loadMetadata() {
+		try {
+			const content = await require_timeout.withTimeout(fs_promises.default.readFile(this.filePath, "utf-8"), require_timeout.DEFAULT_TIMEOUTS.METADATA, "Load metadata");
+			return JSON.parse(content);
+		} catch (error) {
+			if (error.code === "ENOENT") return createEmptyMetadata();
+			throw error;
+		}
+	}
+	/**
+	* Save metadata to disk
+	* Times out after 15 seconds to prevent indefinite hangs
+	*/
+	async saveMetadata(metadata) {
+		await require_timeout.withTimeout(fs_promises.default.mkdir(path.default.dirname(this.filePath), { recursive: true }), require_timeout.DEFAULT_TIMEOUTS.FILE_IO, "Create metadata directory");
+		metadata.stats = {
+			totalEntries: Object.keys(metadata.entries).length,
+			lastUpdated: (/* @__PURE__ */ new Date()).toISOString()
+		};
+		const dir = path.default.dirname(this.filePath);
+		const base = path.default.basename(this.filePath);
+		const tmpPath = path.default.join(dir, `.${base}.tmp-${process.pid}-${Date.now()}`);
+		const json = JSON.stringify(metadata, null, 2);
+		await require_timeout.withTimeout(fs_promises.default.writeFile(tmpPath, json, "utf-8"), require_timeout.DEFAULT_TIMEOUTS.METADATA, "Save metadata (tmp write)");
+		try {
+			await require_timeout.withTimeout(fs_promises.default.rename(tmpPath, this.filePath), require_timeout.DEFAULT_TIMEOUTS.METADATA, "Save metadata (atomic rename)");
+		} catch (error) {
+			if (error && typeof error === "object" && "code" in error && error.code === "EPERM") {
+				await require_timeout.withTimeout(fs_promises.default.writeFile(this.filePath, json, "utf-8"), require_timeout.DEFAULT_TIMEOUTS.METADATA, "Save metadata (EPERM fallback direct write)");
+				return;
+			}
+			throw error;
+		} finally {
+			await fs_promises.default.unlink(tmpPath).catch(() => {});
+		}
+	}
+	/**
+	* Thread-safe save operation that atomically updates metadata with new entries
+	* Uses file locking to prevent concurrent write corruption
+	*
+	* @param entries - Translation entries to add/update
+	* @returns The updated metadata schema
+	*/
+	async saveMetadataWithEntries(entries) {
+		const lockDir = path.default.dirname(this.filePath);
+		await fs_promises.default.mkdir(lockDir, { recursive: true });
+		try {
+			await fs_promises.default.access(this.filePath);
+		} catch {
+			await fs_promises.default.writeFile(this.filePath, JSON.stringify(createEmptyMetadata(), null, 2), "utf-8");
+		}
+		const release = await proper_lockfile.default.lock(this.filePath, {
+			retries: {
+				retries: 10,
+				minTimeout: 50,
+				maxTimeout: 1e3
+			},
+			stale: 2e3
+		});
+		try {
+			const currentMetadata = await this.loadMetadata();
+			for (const entry of entries) currentMetadata.entries[entry.hash] = entry;
+			await this.saveMetadata(currentMetadata);
+			return currentMetadata;
+		} finally {
+			await release();
+		}
+	}
+};
+
+//#endregion
+exports.MetadataManager = MetadataManager;
+exports.cleanupExistingMetadata = cleanupExistingMetadata;
+exports.createEmptyMetadata = createEmptyMetadata;
+exports.getMetadataPath = getMetadataPath;
+exports.loadMetadata = loadMetadata;