@gringow/gringow-nextjs 0.0.2

package/README.md

@@ -0,0 +1,95 @@
+# @gringow/gringow-nextjs
+
+⚠️ Experimental Next.js integration for Gringow. The current implementation is intentionally minimal and primarily
+targets Turbopack builds by running a cache build once at request time.
+
+## What it actually does today
+- Scans source files for `g\`...\`` template literals using the glob pattern from `gringow.config.*` (via
+  `@gringow/gringow` config loading).
+- On Turbopack, hooks into `headers()` and triggers a single cache build on first call.
+- The Webpack path currently returns the provided Next config unchanged (no hooks wired yet).
+- No CLI flags (`--gringow=build|clear|reset`) are implemented.
+
+If you need a production-ready workflow today, prefer the Vite plugin or the CLI cache builder.
+
+## Installation
+```bash
+pnpm add @gringow/gringow-nextjs
+# npm install @gringow/gringow-nextjs
+# yarn add @gringow/gringow-nextjs
+```
+
+## Usage (Turbopack-first)
+```ts
+// next.config.ts
+import type { NextConfig } from 'next'
+import GringowNextjsPlugin from '@gringow/gringow-nextjs'
+
+const withGringow = GringowNextjsPlugin({ debug: process.env.NODE_ENV === 'development' })
+
+const nextConfig: NextConfig = {
+  // your config
+}
+
+export default withGringow(nextConfig)
+```
+
+Run your app normally (`pnpm dev`). The first time the `headers` function resolves (Turbopack), the plugin will:
+
+1) read `gringow.config.*` for `globby` and LLM settings,
+2) globby-scan files, collecting `g\`...\`` occurrences,
+3) call the core Gringow runtime to populate `gringow/gringow.json`.
+
+## Options
+```ts
+type GringowNextjsPluginOptions = {
+  debug?: boolean // prints when cache building starts/completes
+}
+```
+
+## Status & limitations
+- Turbopack only, and even there it runs during `headers()` rather than build hooks.
+- Webpack integration is a stub (no cache build hooks yet).
+- Cache pruning and `--gringow` flags are not implemented.
+
+Contributions to complete the Webpack path or to add build-time hooks are welcome.
+
+## License
+MIT
+
+export default function HomePage() {
+  const name = 'John'
+  
+  return (
+    <div>
+      <h1>{Gringow`Welcome to our website, ${name}!`}</h1>
+      <p>{Gringow`This text will be automatically translated.`}</p>
+    </div>
+  )
+}
+```
+
+### 5. Build your cache
+```bash
+# Pre-populate the translation cache
+npm run build -- --gringow=build
+
+# Or clear and rebuild
+npm run build -- --gringow=reset
+```
+
+The translations will be stored in `./gringow/gringow.json` and automatically used in your application.
+
+## How it works
+- `transform`: checks each loaded module, finds `g\`...\`` usage, and seeds the translation cache via `@gringow/gringow`.
+- `buildEnd`: prunes cache entries that no longer exist in source and backfills any new strings discovered by static scanning.
+- `buildStart`: watches for the `--gringow=` flag to run cache maintenance chores outside of normal Vite flows.
+
+## Development scripts
+```bash
+pnpm run build   # Emit dist/ with tsup
+pnpm run watch   # Continuous rebuild for local development
+```
+
+## License
+MIT © Renato Gaspar

package/dist/build-gringow-cache.d.mts

@@ -0,0 +1,3 @@
+declare function buildGringowCache(): Promise<void>;
+
+export { buildGringowCache };

package/dist/build-gringow-cache.mjs

@@ -0,0 +1,38 @@
+import Gringow, { awaitedConfig } from '@gringow/gringow';
+import { globby } from 'globby';
+import fs from 'fs/promises';
+
+// src/build-gringow-cache.ts
+
+// src/get-matches-in-code.ts
+function getMatchesInCode(code) {
+  const regex = /g`((?:\\`|[^`])+)`/g;
+  return [...new Set([...code.matchAll(regex)].map(([, value = ""]) => value))];
+}
+
+// src/get-matches-from-file.ts
+async function getMatchesFromFile(filePath) {
+  const code = await fs.readFile(filePath, "utf-8");
+  return getMatchesInCode(code);
+}
+
+// src/plugin.ts
+var localCache = /* @__PURE__ */ new Set();
+
+// src/build-gringow-cache.ts
+async function buildGringowCache() {
+  const gringowConfig = await awaitedConfig;
+  const files = await globby(String(gringowConfig.globby) ?? "./src/**/*.{js,jsx,ts,tsx}");
+  for await (const file of files) {
+    const matches = await getMatchesFromFile(file);
+    for await (const match of matches) {
+      if (!String(match).trim()) continue;
+      const { cacheId } = await Gringow(String(match).trim());
+      if (!localCache.has(cacheId)) {
+        localCache.add(cacheId);
+      }
+    }
+  }
+}
+
+export { buildGringowCache };

package/dist/get-matches-from-file.d.mts

@@ -0,0 +1,3 @@
+declare function getMatchesFromFile(filePath: string): Promise<string[]>;
+
+export { getMatchesFromFile };

package/dist/get-matches-from-file.mjs

@@ -0,0 +1,17 @@
+import fs from 'fs/promises';
+
+// src/get-matches-from-file.ts
+
+// src/get-matches-in-code.ts
+function getMatchesInCode(code) {
+  const regex = /g`((?:\\`|[^`])+)`/g;
+  return [...new Set([...code.matchAll(regex)].map(([, value = ""]) => value))];
+}
+
+// src/get-matches-from-file.ts
+async function getMatchesFromFile(filePath) {
+  const code = await fs.readFile(filePath, "utf-8");
+  return getMatchesInCode(code);
+}
+
+export { getMatchesFromFile };

package/dist/get-matches-in-code.d.mts

@@ -0,0 +1,3 @@
+declare function getMatchesInCode(code: string): string[];
+
+export { getMatchesInCode };

package/dist/get-matches-in-code.mjs

@@ -0,0 +1,7 @@
+// src/get-matches-in-code.ts
+function getMatchesInCode(code) {
+  const regex = /g`((?:\\`|[^`])+)`/g;
+  return [...new Set([...code.matchAll(regex)].map(([, value = ""]) => value))];
+}
+
+export { getMatchesInCode };

package/dist/get-source-ids.d.mts

@@ -0,0 +1,3 @@
+declare function getSourceIds(): Promise<Map<string, string>>;
+
+export { getSourceIds };

package/dist/get-source-ids.mjs

@@ -0,0 +1,35 @@
+import { awaitedConfig, createCacheId } from '@gringow/gringow';
+import { globby } from 'globby';
+import fs from 'fs/promises';
+
+// src/get-source-ids.ts
+
+// src/get-matches-in-code.ts
+function getMatchesInCode(code) {
+  const regex = /g`((?:\\`|[^`])+)`/g;
+  return [...new Set([...code.matchAll(regex)].map(([, value = ""]) => value))];
+}
+
+// src/get-matches-from-file.ts
+async function getMatchesFromFile(filePath) {
+  const code = await fs.readFile(filePath, "utf-8");
+  return getMatchesInCode(code);
+}
+
+// src/get-source-ids.ts
+async function getSourceIds() {
+  const gringowConfig = await awaitedConfig;
+  const files = await globby(String(gringowConfig.globby) ?? "./src/**/*.{js,jsx,ts,tsx}");
+  const sourceIds = /* @__PURE__ */ new Map();
+  for await (const file of files) {
+    const matches = await getMatchesFromFile(file);
+    for await (const match of matches) {
+      if (!String(match).trim()) continue;
+      const cacheId = createCacheId(String(match).trim());
+      sourceIds.set(cacheId, String(match).trim());
+    }
+  }
+  return sourceIds;
+}
+
+export { getSourceIds };

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+export { GringowNextjsPlugin, GringowNextjsPluginOptions, localCache } from './plugin.mjs';
+import '@gringow/gringow';
+import 'next';

package/dist/index.mjs

@@ -0,0 +1,105 @@
+import Gringow, { awaitedConfig } from '@gringow/gringow';
+import { globby } from 'globby';
+import fs from 'fs/promises';
+
+// src/build-gringow-cache.ts
+
+// src/get-matches-in-code.ts
+function getMatchesInCode(code) {
+  const regex = /g`((?:\\`|[^`])+)`/g;
+  return [...new Set([...code.matchAll(regex)].map(([, value = ""]) => value))];
+}
+
+// src/get-matches-from-file.ts
+async function getMatchesFromFile(filePath) {
+  const code = await fs.readFile(filePath, "utf-8");
+  return getMatchesInCode(code);
+}
+
+// src/build-gringow-cache.ts
+async function buildGringowCache() {
+  const gringowConfig = await awaitedConfig;
+  const files = await globby(String(gringowConfig.globby) ?? "./src/**/*.{js,jsx,ts,tsx}");
+  for await (const file of files) {
+    const matches = await getMatchesFromFile(file);
+    for await (const match of matches) {
+      if (!String(match).trim()) continue;
+      const { cacheId } = await Gringow(String(match).trim());
+      if (!localCache.has(cacheId)) {
+        localCache.add(cacheId);
+      }
+    }
+  }
+}
+
+// src/plugin.ts
+var localCache = /* @__PURE__ */ new Set();
+async function buildCache(options) {
+  if (options.debug) {
+    console.log(`[Gringow] Scanning source files...`);
+  }
+  try {
+    await buildGringowCache();
+    if (options.debug) {
+      console.log("[Gringow] Cache build completed");
+    }
+  } catch (error) {
+    console.error("[Gringow] Error building cache:", error);
+    throw error;
+  }
+}
+function turbopackConfig(options, nextConfig) {
+  if (options.debug) {
+    console.log(`[Gringow] Detected bundler: Turbopack}`);
+  }
+  console.log("localCache.size", localCache.size);
+  return {
+    ...nextConfig,
+    // For Turbopack, use the headers hook to run cache build
+    // This is called during the build process
+    async headers() {
+      if (localCache.size === 0) {
+        await buildCache(options);
+      }
+      console.log("nextConfig.headers", await nextConfig.headers);
+      return nextConfig.headers ? await nextConfig.headers() : [];
+    }
+  };
+}
+function webpackConfig(options, nextConfig) {
+  if (options.debug) {
+    console.log(`[Gringow] Detected bundler: Webpack`);
+  }
+  return {
+    ...nextConfig
+    // Webpack configuration (Next.js 15 and earlier, or when explicitly using --webpack)
+    // webpack(config: WebpackConfig, context: any) {
+    //   const userWebpack = nextConfig.webpack
+    //   if (userWebpack) {
+    //     config = userWebpack(config, context)
+    //   }
+    //   // Skip if using Turbopack
+    //   if (isTurbopack) {
+    //     return config
+    //   }
+    //   // Only run on client-side production build
+    //   if (!context.isServer && !context.dev) {
+    //     config.plugins = config.plugins || []
+    //     config.plugins.push({
+    //       apply(compiler: any) {
+    //         compiler.hooks.beforeCompile.tapPromise('GringowNextjsPlugin', async () => {
+    //           await buildCache('webpack')
+    //         })
+    //       },
+    //     })
+    //   }
+    //   return config
+    // },
+  };
+}
+function GringowNextjsPlugin(options = {}) {
+  const isTurbopack = process.env.TURBOPACK !== "0" && !process.env.WEBPACK;
+  return isTurbopack ? turbopackConfig.bind(null, options) : webpackConfig.bind(null, options);
+}
+
+export { GringowNextjsPlugin, localCache };

package/dist/is-source-code.d.mts

@@ -0,0 +1,3 @@
+declare function isSourceCode(filePath: string): boolean;
+
+export { isSourceCode };

package/dist/is-source-code.mjs

@@ -0,0 +1,6 @@
+// src/is-source-code.ts
+function isSourceCode(filePath) {
+  return /\.(js|jsx|ts|tsx)$/.test(filePath) && !filePath.includes("node_modules");
+}
+
+export { isSourceCode };

package/dist/plugin.d.mts

@@ -0,0 +1,25 @@
+import { GringowConfig } from '@gringow/gringow';
+import { NextConfig } from 'next';
+
+type GringowNextjsPluginOptions = {
+    /**
+     * Enable debug logging
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Gringow configuration override
+     * If not provided, will use cosmiconfig to find config
+     */
+    config?: Partial<GringowConfig>;
+};
+type GringowBundlerBind = (nextConfig: NextConfig) => NextConfig;
+declare const localCache: Set<string>;
+/**
+ * Gringow plugin for Next.js 15+
+ * Automatically detects and supports both Webpack and Turbopack
+ * Note: Turbopack became stable in Next.js 15 and is the default bundler in Next.js 16
+ */
+declare function GringowNextjsPlugin(options?: GringowNextjsPluginOptions): GringowBundlerBind;
+
+export { GringowNextjsPlugin, type GringowNextjsPluginOptions, GringowNextjsPlugin as default, localCache };

package/dist/plugin.mjs

@@ -0,0 +1,105 @@
+import Gringow, { awaitedConfig } from '@gringow/gringow';
+import { globby } from 'globby';
+import fs from 'fs/promises';
+
+// src/build-gringow-cache.ts
+
+// src/get-matches-in-code.ts
+function getMatchesInCode(code) {
+  const regex = /g`((?:\\`|[^`])+)`/g;
+  return [...new Set([...code.matchAll(regex)].map(([, value = ""]) => value))];
+}
+
+// src/get-matches-from-file.ts
+async function getMatchesFromFile(filePath) {
+  const code = await fs.readFile(filePath, "utf-8");
+  return getMatchesInCode(code);
+}
+
+// src/build-gringow-cache.ts
+async function buildGringowCache() {
+  const gringowConfig = await awaitedConfig;
+  const files = await globby(String(gringowConfig.globby) ?? "./src/**/*.{js,jsx,ts,tsx}");
+  for await (const file of files) {
+    const matches = await getMatchesFromFile(file);
+    for await (const match of matches) {
+      if (!String(match).trim()) continue;
+      const { cacheId } = await Gringow(String(match).trim());
+      if (!localCache.has(cacheId)) {
+        localCache.add(cacheId);
+      }
+    }
+  }
+}
+
+// src/plugin.ts
+var localCache = /* @__PURE__ */ new Set();
+async function buildCache(options) {
+  if (options.debug) {
+    console.log(`[Gringow] Scanning source files...`);
+  }
+  try {
+    await buildGringowCache();
+    if (options.debug) {
+      console.log("[Gringow] Cache build completed");
+    }
+  } catch (error) {
+    console.error("[Gringow] Error building cache:", error);
+    throw error;
+  }
+}
+function turbopackConfig(options, nextConfig) {
+  if (options.debug) {
+    console.log(`[Gringow] Detected bundler: Turbopack}`);
+  }
+  console.log("localCache.size", localCache.size);
+  return {
+    ...nextConfig,
+    // For Turbopack, use the headers hook to run cache build
+    // This is called during the build process
+    async headers() {
+      if (localCache.size === 0) {
+        await buildCache(options);
+      }
+      console.log("nextConfig.headers", await nextConfig.headers);
+      return nextConfig.headers ? await nextConfig.headers() : [];
+    }
+  };
+}
+function webpackConfig(options, nextConfig) {
+  if (options.debug) {
+    console.log(`[Gringow] Detected bundler: Webpack`);
+  }
+  return {
+    ...nextConfig
+    // Webpack configuration (Next.js 15 and earlier, or when explicitly using --webpack)
+    // webpack(config: WebpackConfig, context: any) {
+    //   const userWebpack = nextConfig.webpack
+    //   if (userWebpack) {
+    //     config = userWebpack(config, context)
+    //   }
+    //   // Skip if using Turbopack
+    //   if (isTurbopack) {
+    //     return config
+    //   }
+    //   // Only run on client-side production build
+    //   if (!context.isServer && !context.dev) {
+    //     config.plugins = config.plugins || []
+    //     config.plugins.push({
+    //       apply(compiler: any) {
+    //         compiler.hooks.beforeCompile.tapPromise('GringowNextjsPlugin', async () => {
+    //           await buildCache('webpack')
+    //         })
+    //       },
+    //     })
+    //   }
+    //   return config
+    // },
+  };
+}
+function GringowNextjsPlugin(options = {}) {
+  const isTurbopack = process.env.TURBOPACK !== "0" && !process.env.WEBPACK;
+  return isTurbopack ? turbopackConfig.bind(null, options) : webpackConfig.bind(null, options);
+}
+
+export { GringowNextjsPlugin, GringowNextjsPlugin as default, localCache };

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@gringow/gringow-nextjs",
+  "version": "0.0.2",
+  "description": "A Next.js plugin for Gringow AI-powered translation tool",
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    "./plugin": {
+      "types": "./dist/plugin.d.mts",
+      "import": "./dist/plugin.mjs",
+      "require": "./dist/plugin.mjs"
+    }
+  },
+  "keywords": [
+    "gringow",
+    "nextjs",
+    "next",
+    "translation",
+    "i18n",
+    "internationalization",
+    "llm",
+    "ai",
+    "nextjs-plugin",
+    "react"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rntgspr/gringow.git",
+    "directory": "gringow-nextjs"
+  },
+  "author": "Renato Gaspar <rntgspr@gmail.com>",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "globby": "14.1.0",
+    "react": "^19.2.0",
+    "webpack": "^5.102.1",
+    "@gringow/gringow": "0.1.3",
+    "@gringow/gringow-react": "0.0.7"
+  },
+  "peerDependencies": {
+    "next": ">=15.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "22.15.0",
+    "@types/react": "^19.2.7",
+    "tsc-alias": "1.8.16",
+    "tsup": "8.5.0",
+    "typescript": "5.8.3"
+  },
+  "scripts": {
+    "build": "rm -rf ./dist/* ./tsconfig.tsbuildinfo && tsup",
+    "watch": "pnpm run build && tsup --watch --config ../tsup.config.ts",
+    "prepublish": "pnpm install && pnpm build",
+    "__postinstall": "pnpm run build",
+    "test": "echo \"Warning: no test specified\" && exit 0"
+  }
+}