i18nya 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,84 @@
+# i18nya
+
+**i18n as small as a cat's paw** — `i18nya` is a minimal, fast, and easy-to-use internationalization library for Node.js and TypeScript projects.  
+Its tiny footprint and simple API make it perfect for projects that want localization without the bloat.
+
+## Features
+
+- 🐾 **Tiny**: Less than 100 lines of TypeScript, 0 dependencies.
+- ⏬️ **Flexible fallback**: Supports fallback languages out of the box.
+- 🧩 **Extensible**: Can be easily extended to integrate into other frameworks (e.g. `astro-i18nya`).
+- 🔨 **Typed**: Optional translation key completions for `t()`.
+
+## Installation
+
+```sh
+npm install i18nya
+```
+
+## Getting Started
+
+Project structure:
+
+```
+package.json
+src/
+└╴i18n.ts (or js)
+langs/
+├╴ja_JP.json
+└╴en.json
+```
+
+```ts
+// src/i18n.ts
+import { init } from "i18nya";
+
+const i18nya = await init({
+  langDir: "../langs", // only this is required
+  defaultLang: "en",
+  fallbackLangs: {
+    // all languages fallback to English, specify special fallbacks here
+    zh_HK: "zh_TW",
+  },
+  // if you use vite, you need to import manually using this:
+  viteImports: import.meta.glob("../langs/*.json", { eager: true }),
+  // otherwise, i18nya will search & import the json files using node modules (which vite does not ship)
+});
+
+export default i18nya;
+```
+
+```json
+// langs/en.json
+{
+  "i18nya.description": "{{emoji}} i18n as small as a cat's paw"
+}
+```
+
+```json
+// langs/ja_JP.json
+{
+  "i18nya.description": "{{emoji}} 猫の足くらいちっちゃい国際化ツール"
+}
+```
+
+```ts
+// usage
+import { makeT } from "i18n";
+const t = makeT("ja_JP");
+console.log(t("i18nya.description", { emoji: "🐾" })); // 🐾 猫の足くらいちっちゃい国際化ツール
+```
+
+### Typed Keys & Completions
+
+The type for the keys can be manually specified:
+
+```ts
+import { init } from "i18nya";
+// requires tsconfig `resolveJsonModule`
+import { defaultTranslations } from "../langs/en.json";
+
+const i18nya = init<keyof typeof defaultTranslations>(...);
+```
+
+Your editor will now show the translation keys when invoking `t()`.

package/astro-i18nya/README.md

@@ -1,15 +1,53 @@
 # astro-i18nya
 
-To install dependencies:
+I18n support for astro.
 
-```bash
-bun install
+## Features
+
+- Integration with `i18nya` and `astro`
+- A `<Trans />` component that works better than the one in `react-i18next`!
+
+## Installation
+
+```sh
+npx astro add astro-i18nya
+# or
+npm install astro-i18nya
 ```
 
-To run:
+Make sure you called `init()` from `i18nya` in `src/i18n.ts`:
+
+```ts
+import { init } from 'i18nya';
 
-```bash
-bun run index.ts
+const i18nya = await init({ ... });
+export default i18nya;
 ```
 
-This project was created using `bun init` in bun v1.3.2. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+Then in `astro.config.mjs`:
+
+```ts
+import i18nya from "./i18n";
+import astro_i18nya from "astro-i18nya";
+
+export default defineConfig({
+  integrations: [astro_i18nya(i18nya)],
+  // `i18n:` is not needed
+});
+```
+
+## Trans
+
+```tsx
+<Trans t={t("test", { user: "John" })}>
+  <b />
+  <a href="https://example.com" />
+</Trans>
+```
+
+With `"test": "Hello <1>{{user}}</1>, welcome to <2><1>my site</1></2>."`, the above element will become:
+
+```html
+<b>Hello John</b>, welcome to <a href="https://example.com"><b>my site</b></a
+>.
+```

package/astro-i18nya/babel.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', {targets: {node: 'current'}}],
+    '@babel/preset-typescript',
+
+    ['@babel/preset-react', {runtime: 'automatic'}],
+  ],
+};

package/astro-i18nya/jest.config.ts

@@ -0,0 +1,7 @@
+import type {Config} from 'jest';
+
+const config: Config = {
+  "testEnvironment": "jsdom"
+};
+
+export default config;