@i18n-micro/types-generator 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+ 
+ Copyright (c) 2016 
+ 
+ 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:
+ 
+ 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.

package/README.md

@@ -0,0 +1,62 @@
+# @i18n-micro/types-generator
+
+Type generator for i18n-micro translation keys. Automatically generates TypeScript types from JSON translation files.
+
+## Installation
+
+```bash
+npm install -D @i18n-micro/types-generator
+# or
+pnpm add -D @i18n-micro/types-generator
+# or
+yarn add -D @i18n-micro/types-generator
+```
+
+## Usage
+
+### Nuxt
+
+Add to `nuxt.config.ts`:
+
+```typescript
+export default defineNuxtConfig({
+  modules: [
+    'nuxt-i18n-micro',
+    '@i18n-micro/types-generator/nuxt',
+  ],
+})
+```
+
+### Vite/Vue
+
+Add to `vite.config.ts`:
+
+```typescript
+import { I18nTypesPlugin } from '@i18n-micro/types-generator'
+
+export default defineConfig({
+  plugins: [
+    I18nTypesPlugin({
+      srcDir: 'src',
+      translationDir: 'locales',
+    }),
+  ],
+})
+```
+
+## Features
+
+- 🔍 Automatic type generation from JSON files
+- ✅ Full type safety for translation keys
+- 🎯 IDE autocomplete support
+- 🔄 Hot reload on file changes
+- 🚀 Zero runtime overhead
+
+## Documentation
+
+See [full documentation](../../docs/integrations/types-generator.md) for detailed usage and examples.
+
+## License
+
+MIT
+

package/dist/core/generator.d.ts

@@ -0,0 +1,22 @@
+export interface GeneratorOptions {
+    srcDir: string;
+    translationDir: string;
+    outputFile?: string;
+}
+/**
+ * Генерирует строку с TypeScript типами для ключей переводов.
+ * Не записывает файл, только возвращает содержимое.
+ *
+ * @param options - Опции генератора
+ * @returns Строка с содержимым .d.ts файла
+ */
+export declare function getTypesString(options: GeneratorOptions): Promise<string>;
+/**
+ * Генерирует TypeScript типы для ключей переводов из JSON файлов.
+ * Записывает результат в файл.
+ *
+ * @param options - Опции генератора
+ * @returns Путь к сгенерированному файлу
+ */
+export declare function generateTypes(options: GeneratorOptions): Promise<string>;
+//# sourceMappingURL=generator.d.ts.map

package/dist/core/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/core/generator.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CA8C/E;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAkB9E"}

package/dist/core/parser.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Рекурсивно обходит JSON объект и создает плоский список ключей через точку.
+ *
+ * @param obj - JSON объект с переводами
+ * @param prefix - Префикс для вложенных ключей (используется рекурсивно)
+ * @returns Массив строк с плоскими ключами (например, ['greeting', 'header.title', 'errors.404'])
+ *
+ * @example
+ * ```typescript
+ * const obj = {
+ *   greeting: 'Hello',
+ *   header: {
+ *     title: 'Welcome',
+ *     subtitle: 'Subtitle'
+ *   }
+ * }
+ * flattenKeys(obj) // ['greeting', 'header.title', 'header.subtitle']
+ * ```
+ */
+export declare function flattenKeys(obj: Record<string, unknown>, prefix?: string): string[];
+//# sourceMappingURL=parser.d.ts.map

package/dist/core/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/core/parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,WAAW,CACzB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5B,MAAM,SAAK,GACV,MAAM,EAAE,CAsBV"}

package/dist/generator-D2pTueXl.cjs

@@ -0,0 +1,15 @@
+"use strict";const d=require("globby"),i=require("node:fs"),a=require("node:path");function y(e,s=""){const t=[];for(const n in e){if(!Object.hasOwn(e,n))continue;const o=e[n],r=s?`${s}.${n}`:n;typeof o=="object"&&o!==null&&!Array.isArray(o)?t.push(...y(o,r)):t.push(r)}return t}async function l(e){const s=a.resolve(e.srcDir,e.translationDir),t=await d.globby("**/*.json",{cwd:s,absolute:!0,ignore:["node_modules/**","dist/**",".nuxt/**"]}),n=new Set;for(const r of t)try{const c=JSON.parse(i.readFileSync(r,"utf-8")),u=y(c);for(const f of u)n.add(f)}catch(c){console.warn(`[i18n-types] Failed to parse ${r}:`,c)}return`/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// Generated by @i18n-micro/types-generator
+// DO NOT EDIT THIS FILE MANUALLY
+
+import '@i18n-micro/types';
+
+declare module '@i18n-micro/types' {
+  export interface DefineLocaleMessage {
+${Array.from(n).sort().map(r=>`    '${r}': string;`).join(`
+`)}
+  }
+}
+`}async function p(e){const s=await l(e),t=e.outputFile||a.resolve(e.srcDir,"i18n-micro.d.ts"),n=a.dirname(t);try{i.mkdirSync(n,{recursive:!0})}catch{}return i.writeFileSync(t,s,"utf-8"),t}exports.flattenKeys=y;exports.generateTypes=p;exports.getTypesString=l;

package/dist/generator-D56a37C-.js

@@ -0,0 +1,55 @@
+import { globby as u } from "globby";
+import { mkdirSync as f, writeFileSync as p, readFileSync as m } from "node:fs";
+import { resolve as c, dirname as d } from "node:path";
+function a(e, o = "") {
+  const t = [];
+  for (const n in e) {
+    if (!Object.hasOwn(e, n)) continue;
+    const s = e[n], r = o ? `${o}.${n}` : n;
+    typeof s == "object" && s !== null && !Array.isArray(s) ? t.push(...a(s, r)) : t.push(r);
+  }
+  return t;
+}
+async function g(e) {
+  const o = c(e.srcDir, e.translationDir), t = await u("**/*.json", {
+    cwd: o,
+    absolute: !0,
+    ignore: ["node_modules/**", "dist/**", ".nuxt/**"]
+  }), n = /* @__PURE__ */ new Set();
+  for (const r of t)
+    try {
+      const i = JSON.parse(m(r, "utf-8")), l = a(i);
+      for (const y of l)
+        n.add(y);
+    } catch (i) {
+      console.warn(`[i18n-types] Failed to parse ${r}:`, i);
+    }
+  return `/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// Generated by @i18n-micro/types-generator
+// DO NOT EDIT THIS FILE MANUALLY
+
+import '@i18n-micro/types';
+
+declare module '@i18n-micro/types' {
+  export interface DefineLocaleMessage {
+${Array.from(n).sort().map((r) => `    '${r}': string;`).join(`
+`)}
+  }
+}
+`;
+}
+async function h(e) {
+  const o = await g(e), t = e.outputFile || c(e.srcDir, "i18n-micro.d.ts"), n = d(t);
+  try {
+    f(n, { recursive: !0 });
+  } catch {
+  }
+  return p(t, o, "utf-8"), t;
+}
+export {
+  g as a,
+  a as f,
+  h as g
+};

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("unplugin"),i=require("./generator-D2pTueXl.cjs"),c=require("chokidar"),u=require("node:path");let r=null,e=null;function y(t,n){return function(...o){const a=()=>{e&&clearTimeout(e),e=null,t(...o)};e&&clearTimeout(e),e=setTimeout(a,n)}}const g=s.createUnplugin(t=>({name:"i18n-micro-types-generator",async buildStart(){try{await i.generateTypes(t)}catch(n){console.warn("[i18n-types] Failed to generate types:",n)}if(process.env.NODE_ENV==="development"||process.env.NODE_ENV!=="production"){const n=u.resolve(t.srcDir,t.translationDir),l=y(async()=>{try{await i.generateTypes(t)}catch(o){console.warn("[i18n-types] Failed to regenerate types:",o)}},300);r=c.watch(n,{ignoreInitial:!0,ignored:["node_modules/**","dist/**",".nuxt/**"]}),r.on("all",async(o,a)=>{a.endsWith(".json")&&l()})}},buildEnd(){r&&(r.close(),r=null),e&&(clearTimeout(e),e=null)}}));exports.flattenKeys=i.flattenKeys;exports.generateTypes=i.generateTypes;exports.getTypesString=i.getTypesString;exports.I18nTypesPlugin=g;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { I18nTypesPlugin } from './unplugin';
+export { generateTypes, getTypesString } from './core/generator';
+export type { GeneratorOptions } from './core/generator';
+export { flattenKeys } from './core/parser';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAChE,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA"}

package/dist/index.mjs

@@ -0,0 +1,48 @@
+import { createUnplugin as c } from "unplugin";
+import { g as l } from "./generator-D56a37C-.js";
+import { f as w, a as v } from "./generator-D56a37C-.js";
+import s from "chokidar";
+import { resolve as u } from "node:path";
+let r = null, e = null;
+function m(t, n) {
+  return function(...o) {
+    const i = () => {
+      e && clearTimeout(e), e = null, t(...o);
+    };
+    e && clearTimeout(e), e = setTimeout(i, n);
+  };
+}
+const g = c((t) => ({
+  name: "i18n-micro-types-generator",
+  async buildStart() {
+    try {
+      await l(t);
+    } catch (n) {
+      console.warn("[i18n-types] Failed to generate types:", n);
+    }
+    if (process.env.NODE_ENV === "development" || process.env.NODE_ENV !== "production") {
+      const n = u(t.srcDir, t.translationDir), a = m(async () => {
+        try {
+          await l(t);
+        } catch (o) {
+          console.warn("[i18n-types] Failed to regenerate types:", o);
+        }
+      }, 300);
+      r = s.watch(n, {
+        ignoreInitial: !0,
+        ignored: ["node_modules/**", "dist/**", ".nuxt/**"]
+      }), r.on("all", async (o, i) => {
+        i.endsWith(".json") && a();
+      });
+    }
+  },
+  buildEnd() {
+    r && (r.close(), r = null), e && (clearTimeout(e), e = null);
+  }
+}));
+export {
+  g as I18nTypesPlugin,
+  w as flattenKeys,
+  l as generateTypes,
+  v as getTypesString
+};

package/dist/nuxt.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const s=require("@nuxt/kit"),p=require("./generator-D2pTueXl.cjs"),u=s.defineNuxtModule({meta:{name:"@i18n-micro/types-generator",configKey:"i18nTypes"},defaults:{translationDir:"locales"},async setup(l,t){var o;const n=(o=t.options.runtimeConfig)==null?void 0:o.public,r=n==null?void 0:n.i18nConfig,a=l.translationDir||(r==null?void 0:r.translationDir)||"locales";s.addTypeTemplate({filename:"types/i18n-micro.d.ts",getContents:async()=>{try{return await p.getTypesString({srcDir:t.options.rootDir,translationDir:a})}catch(e){return console.warn("[i18n-types] Failed to generate types:",e),`// Failed to generate types: ${e instanceof Error?e.message:String(e)}`}}}),t.hook("builder:watch",async(e,c)=>{const i=c.replace(/\\/g,"/"),d=a.replace(/\\/g,"/");i.includes(d)&&i.endsWith(".json")&&await t.callHook("builder:generateApp")})}});exports.default=u;

package/dist/nuxt.d.ts

@@ -0,0 +1,7 @@
+export interface I18nTypesGeneratorOptions {
+    translationDir?: string;
+    outputFile?: string;
+}
+declare const _default: import('@nuxt/schema').NuxtModule<I18nTypesGeneratorOptions, I18nTypesGeneratorOptions, false>;
+export default _default;
+//# sourceMappingURL=nuxt.d.ts.map

package/dist/nuxt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nuxt.d.ts","sourceRoot":"","sources":["../src/nuxt.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,yBAAyB;IACxC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;;AAED,wBAoDE"}

package/dist/nuxt.mjs

@@ -0,0 +1,34 @@
+import { defineNuxtModule as p, addTypeTemplate as d } from "@nuxt/kit";
+import { a as m } from "./generator-D56a37C-.js";
+const u = p({
+  meta: {
+    name: "@i18n-micro/types-generator",
+    configKey: "i18nTypes"
+  },
+  defaults: {
+    translationDir: "locales"
+  },
+  async setup(s, t) {
+    var o;
+    const n = (o = t.options.runtimeConfig) == null ? void 0 : o.public, a = n == null ? void 0 : n.i18nConfig, r = s.translationDir || (a == null ? void 0 : a.translationDir) || "locales";
+    d({
+      filename: "types/i18n-micro.d.ts",
+      getContents: async () => {
+        try {
+          return await m({
+            srcDir: t.options.rootDir,
+            translationDir: r
+          });
+        } catch (e) {
+          return console.warn("[i18n-types] Failed to generate types:", e), `// Failed to generate types: ${e instanceof Error ? e.message : String(e)}`;
+        }
+      }
+    }), t.hook("builder:watch", async (e, l) => {
+      const i = l.replace(/\\/g, "/"), c = r.replace(/\\/g, "/");
+      i.includes(c) && i.endsWith(".json") && await t.callHook("builder:generateApp");
+    });
+  }
+});
+export {
+  u as default
+};

package/dist/unplugin.d.ts

@@ -0,0 +1,3 @@
+import { GeneratorOptions } from './core/generator';
+export declare const I18nTypesPlugin: import('unplugin').UnpluginInstance<GeneratorOptions, boolean>;
+//# sourceMappingURL=unplugin.d.ts.map

package/dist/unplugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unplugin.d.ts","sourceRoot":"","sources":["../src/unplugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAuBvE,eAAO,MAAM,eAAe,gEAkD1B,CAAA"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@i18n-micro/types-generator",
+  "version": "1.0.0",
+  "description": "Type generator for i18n-micro translation keys",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./nuxt": {
+      "types": "./dist/nuxt.d.ts",
+      "import": "./dist/nuxt.mjs",
+      "require": "./dist/nuxt.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "i18n",
+    "typescript",
+    "type-generator",
+    "translation"
+  ],
+  "author": {
+    "name": "s00d",
+    "email": "Virus191288@gmail.com",
+    "url": "https://s00d.github.io/"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/s00d/nuxt-i18n-micro"
+  },
+  "dependencies": {
+    "globby": "^14.0.0",
+    "chokidar": "^3.6.0",
+    "unplugin": "^1.0.0"
+  },
+  "peerDependencies": {
+    "@nuxt/kit": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=18.17.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.17.10",
+    "vite": "^5.0.0",
+    "vite-plugin-dts": "^4.3.0",
+    "typescript": "^5.0.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "@types/jest": "^29.5.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "test": "jest",
+    "typecheck": "tsc --noEmit"
+  }
+}