kotori 6.1.2 → 6.1.4

package/README.md

@@ -8,10 +8,13 @@
   <img src="https://img.shields.io/badge/bundle%20size-0.28kB-emerald" alt="Bundle Size">
   <a href="https://github.com/tylim88/Kotori/blob/main/LICENSE"><img src="https://img.shields.io/github/license/tylim88/Kotori?color=blue" alt="License"></a>
   <img src="https://img.shields.io/badge/dependencies-0-success" alt="Dependencies">
+  <a href="https://snyk.io/test/github/tylim88/Kotori">
+    <img src="https://snyk.io/test/github/tylim88/Kotori/badge.svg" alt="Snyk Vulnerabilities for npm package">
+  </a>
 </p>
 
 <p align="center">
-🕊️ Kotori is a zero-config, fully type-safe, and modular internationalization library for React that compiles down to just 0.29kB. No JSON, no external CLI tools, no codegen—just live type inference from your strings.
+🕊️ Kotori is a zero-config, fully type-safe, and modular internationalization library for React that compiles down to just 0.28kB. No JSON, no external CLI tools, no codegen—just live type inference from your strings.
 </p>
 
 ```ts
@@ -55,13 +58,13 @@ const Component = () => {
 - No JSON
 - No dependencies
 - No build step
-- 0.29kB minified and gzipped
+- 0.28kB minified and gzipped
 - Modular and tree-shakeable
 - Language change in one page rerenders all pages
 - Variables typed and inferred from string literals — no more string typos
 - Maximum type safety with minimum types
 
-Demo: <https://stackblitz.com/edit/kotori?file=src%2FApp.tsx>
+Demo: <https://github.com/tylim88/kotori-demo>
 
 ## Installation
 
@@ -81,7 +84,7 @@ export const { useT, d, setLanguage } = kotori({
     secondaries: ['zh', 'ja', 'ms'],
 })
 
-// you can define your dicts in the same file or separate them by component, it's up to you
+// you can define your dicts in the same file/folder or separate them by component, it's up to you
 export const intro = d({
     en: 'my name is {{name}}, I am {{age}} years old.',
     zh: '我叫{{name}}，我今年{{age}}岁了。',
@@ -163,7 +166,7 @@ export const Page2 = () => {
 
 ![how kotori works](image.webp) 
 
-### `kotori(options)` (0.29kB)
+### `kotori(options)` (0.28kB)
 
 Creates a scoped i18n instance.
 
@@ -248,9 +251,16 @@ Detects the user's preferred language from browser settings and sets it on the k
 
 ```ts
 import { detectLanguage } from 'kotori'
-import { i18n } from './locales'
+import { kotori } from 'kotori'
+
+const i18n = kotori({
+    primary: 'en',
+    secondaries: ['zh', 'ja', 'ms'],
+})
 
 detectLanguage(i18n)
+
+export const { useT, d, setLanguage } = i18n
 ```
 
 | option | type | default | description |
@@ -289,7 +299,8 @@ kotori({ primary: 'klingon', secondaries: ['zh'] })       // ❌ compile error
 ## Tips
 
 - If you plan to add new languages frequently, consider colocating all your dicts in a single file or multiple files in one folder. It is easier to copy the entire files and hand it to an AI to translate.
-- If your supported languages are fixed, consider splitting dicts by page or component. Translations stay close to the code that uses them and are easier to maintain.
+- If your supported languages are fixed, consider splitting dicts by page or component. This keeps translations close to the code that uses them and makes them easier to maintain.
+- For large or rarely used components, you can also reduce your bundle size by dynamically importing them only when they are needed on the page.
 
 ## Roadmap
 

package/dist/index.cjs

@@ -35,6 +35,8 @@ let react = require("react");
 *
 * detectLanguage(i18n, { fallbackToSubtag: false })
 * // browser: ['zh-CN'] → no exact match → no-op, stays 'en'
+*
+* export const { useT, d, setLanguage } = i18n
 * ```
 *
 * @example
@@ -110,7 +112,7 @@ const kotori = (config) => {
 	*     )
 	* }
 	*/
-	const t = (dictionary, ...args) => (dictionary().d[snapshot.language] || "").replace(/\{\{\s*([\w-]+)\s*\}\}/g, (_, key) => String(args[0]?.[key]));
+	const t = (dictionary, ...args) => (dictionary().d[snapshot.language] + "").replace(/\{\{\s*([\w-]+)\s*\}\}/g, (_, key) => args[0]?.[key] + "");
 	let snapshot = {
 		language: config.primary,
 		t
@@ -145,15 +147,11 @@ const kotori = (config) => {
 			language,
 			t: (...args) => t(...args)
 		};
-		listeners.forEach((listener) => {
-			listener();
-		});
+		listeners.forEach((listener) => listener());
 	};
 	const subscribe = (listener) => {
 		listeners.add(listener);
-		return () => {
-			listeners.delete(listener);
-		};
+		return () => listeners.delete(listener);
 	};
 	return {
 		config,

package/dist/index.d.cts

@@ -208,6 +208,8 @@ declare const kotori: <const Primary extends BCP47LanguageTagNameWithSubTag, con
  *
  * detectLanguage(i18n, { fallbackToSubtag: false })
  * // browser: ['zh-CN'] → no exact match → no-op, stays 'en'
+ *
+ * export const { useT, d, setLanguage } = i18n
  * ```
  *
  * @example

package/dist/index.d.mts

@@ -208,6 +208,8 @@ declare const kotori: <const Primary extends BCP47LanguageTagNameWithSubTag, con
  *
  * detectLanguage(i18n, { fallbackToSubtag: false })
  * // browser: ['zh-CN'] → no exact match → no-op, stays 'en'
+ *
+ * export const { useT, d, setLanguage } = i18n
  * ```
  *
  * @example

package/dist/index.mjs

@@ -34,6 +34,8 @@ import { useSyncExternalStore } from "react";
 *
 * detectLanguage(i18n, { fallbackToSubtag: false })
 * // browser: ['zh-CN'] → no exact match → no-op, stays 'en'
+*
+* export const { useT, d, setLanguage } = i18n
 * ```
 *
 * @example
@@ -109,7 +111,7 @@ const kotori = (config) => {
 	*     )
 	* }
 	*/
-	const t = (dictionary, ...args) => (dictionary().d[snapshot.language] || "").replace(/\{\{\s*([\w-]+)\s*\}\}/g, (_, key) => String(args[0]?.[key]));
+	const t = (dictionary, ...args) => (dictionary().d[snapshot.language] + "").replace(/\{\{\s*([\w-]+)\s*\}\}/g, (_, key) => args[0]?.[key] + "");
 	let snapshot = {
 		language: config.primary,
 		t
@@ -144,15 +146,11 @@ const kotori = (config) => {
 			language,
 			t: (...args) => t(...args)
 		};
-		listeners.forEach((listener) => {
-			listener();
-		});
+		listeners.forEach((listener) => listener());
 	};
 	const subscribe = (listener) => {
 		listeners.add(listener);
-		return () => {
-			listeners.delete(listener);
-		};
+		return () => listeners.delete(listener);
 	};
 	return {
 		config,

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "kotori",
 	"description": "0.29kB Strongly-typed and tree-shakeable internationalization library for React",
-	"version": "6.1.2",
+	"version": "6.1.4",
 	"scripts": {
 		"setup": "rm -rf node_modules && npm i && git init && husky",
 		"prepublishOnly": "npm i && npx tsc && npm run build",