@gringow/gringow-vite 0.0.2 → 0.0.3

package/README.md

@@ -0,0 +1,63 @@
+# @gringow/gringow-vite
+
+Vite plugin that scans your project for Gringow template literals, keeps the translation cache in sync, and lets you drive builds with the Gringow CLI-style flags. Pair it with the core `@gringow/gringow` package to automate translation discovery during development or CI builds.
+
+## Highlights
+- Pre-transform hook that extracts every `g` tagged template literal from your source graph
+- Automatically calls the Gringow runtime to populate `gringow/gringow.json`
+- Removes stale cache entries when strings disappear from source
+- Supports fast cache bootstrap via `--gringow=build|clear|reset` flags
+- Small surface area: Vite 7 compatible, tree-shakeable ESM/CJS exports
+
+## Installation
+```bash
+pnpm add -D @gringow/gringow @gringow/gringow-vite
+# npm install -D @gringow/gringow @gringow/gringow-vite
+# yarn add -D @gringow/gringow @gringow/gringow-vite
+```
+
+## Usage
+Add the plugin to your Vite config and run Vite as usual. The plugin relies on the Gringow config file (`gringow.config.js` or similar) to know which files to scan.
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite'
+import Gringow from '@gringow/gringow-vite'
+
+export default defineConfig({
+  plugins: [Gringow({ debug: false })],
+})
+```
+
+During development the plugin parses transformed modules, calculates cache IDs, and asks the Gringow core library to ensure translations exist. The generated cache lives at `./gringow/gringow.json` by default.
+
+### Command line helpers
+Run Vite with extra flags to control the cache lifecycle without leaving your workflow:
+
+```bash
+vite build --gringow=build  # Scan all sources up front and build the cache
+vite build --gringow=clear  # Delete the cache file and exit
+vite build --gringow=reset  # Clear then rebuild the cache in one go
+```
+
+These commands exit after completing the requested action so they can be used in CI scripts.
+
+## Configuration reference
+- `debug?: boolean` (default `false`): log plugin options during startup for troubleshooting.
+
+The plugin reads the Gringow workspace configuration to locate files:
+- `globby`: glob pattern that determines which source files are scanned (defaults to `./src/**/*.{js,jsx,ts,tsx}`).
+
+## 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/index.d.mts

@@ -4,6 +4,6 @@ type GringowVitePluginOptions = {
     debug?: boolean;
 };
 declare const localCache: Set<string>;
-declare function GringowVitePlugin(options?: GringowVitePluginOptions): Plugin;
+declare function GringowVitePlugin(options?: GringowVitePluginOptions): Plugin<unknown>;
 
 export { type GringowVitePluginOptions, GringowVitePlugin as default, localCache };

package/dist/index.mjs

@@ -53,8 +53,8 @@ function isSourceCode(filePath) {
 
 // src/index.ts
 var localCache = /* @__PURE__ */ new Set();
-function GringowVitePlugin(options = { debug: false }) {
-  const { debug } = options;
+function GringowVitePlugin(options = {}) {
+  const { debug = false } = options;
   if (debug) {
     console.log("GringowVitePlugin, loaded with options:");
     Object.keys(options).forEach((key) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gringow/gringow-vite",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A Vite plugin for Gringow AI-powered translation tool",
   "main": "dist/index.js",
   "module": "dist/index.mjs",