sheet-i18n 0.1.9 → 0.1.10

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> sheet-i18n@0.1.9 build /Users/devanderson/Documents/dev/project/sheet-i18n/packages/sheet-i18n
+> sheet-i18n@0.1.10 build /Users/devanderson/Documents/dev/project/sheet-i18n/packages/sheet-i18n
 > tsup
 
 CLI Building entry: src/index.ts, src/exporter/index.ts
@@ -11,14 +11,14 @@
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-CJS dist/index.js          1.28 KB
-CJS dist/exporter/index.js 1.10 KB
-CJS ⚡️ Build success in 10ms
 ESM dist/chunk-7AQPNLGW.mjs 122.00 B
 ESM dist/index.mjs          102.00 B
 ESM dist/exporter/index.mjs 32.00 B
 ESM ⚡️ Build success in 11ms
+CJS dist/exporter/index.js 1.10 KB
+CJS dist/index.js          1.28 KB
+CJS ⚡️ Build success in 11ms
 DTS Build start
-DTS ⚡️ Build success in 543ms
+DTS ⚡️ Build success in 471ms
 DTS dist/exporter/index.d.ts 592.00 B
 DTS dist/index.d.ts          84.00 B

package/.turbo/turbo-changelog.log

@@ -0,0 +1,12 @@
+
+
+> sheet-i18n@0.1.9 changelog /Users/devanderson/Documents/dev/project/sheet-i18n/packages/sheet-i18n
+> standard-version
+
+✔ bumping version in package.json from 0.1.9 to 0.1.10
+✔ outputting changes to CHANGELOG.md
+✔ committing package.json and CHANGELOG.md
+→ No staged files match any configured task.
+
+✔ tagging release v0.1.10
+ℹ Run `git push --follow-tags origin feature && npm publish` to publish

package/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### 0.1.10 (2024-12-23)
+
+
+### Features
+
+* add changelog script to track changes ([9a07986](https://github.com/chltjdrhd777/sheet-i18n/commit/9a07986b0da9a3ffaa702888284df5059c64f776))
+* add husky ([a55a51c](https://github.com/chltjdrhd777/sheet-i18n/commit/a55a51c7e1d279002dddcaf2b4e957d6180a83d5))
+* add ignore sheet by title params ([82fc9ed](https://github.com/chltjdrhd777/sheet-i18n/commit/82fc9edf52f201b74cc22c7a129d8d9fb5880dc8))
+* add lint-staged pre commit script ([53d3e0c](https://github.com/chltjdrhd777/sheet-i18n/commit/53d3e0c6aced647e3b47063cd23bf134345e73a5))
+* add vitest setting ([62e6562](https://github.com/chltjdrhd777/sheet-i18n/commit/62e65629c68b92766f4509039405330508ba1d93))
+* apply husky commit lint ([6ae99da](https://github.com/chltjdrhd777/sheet-i18n/commit/6ae99da9c448d23916ba97a6ae7d89546464dd75))
+* create exportSheet method for creating translation json data ([732786e](https://github.com/chltjdrhd777/sheet-i18n/commit/732786e5dd32d4a0d3ac28607fe92117720160e6))
+* create getTranslationData method to get translation data ([37faff0](https://github.com/chltjdrhd777/sheet-i18n/commit/37faff07f60af4369604ef36ed9ae5a06225a1d7))
+* create translation json data method ([d30774f](https://github.com/chltjdrhd777/sheet-i18n/commit/d30774fe86a5486008530f3c1bb80edcf58c9d0f))
+* create WorkSheetManager class ([522a65f](https://github.com/chltjdrhd777/sheet-i18n/commit/522a65f9f587c2fbbb5678dcac222fcc87beb1cc))
+* **create-turbo:** apply official-starter transform ([acfb9e3](https://github.com/chltjdrhd777/sheet-i18n/commit/acfb9e31fe9cc659700c6050d26f78a0065164f7))
+* **create-turbo:** apply pnpm-eslint transform ([9e76869](https://github.com/chltjdrhd777/sheet-i18n/commit/9e76869210372a92e1da13350f6bef42fbbba96b))
+* **create-turbo:** create basic ([1a5e142](https://github.com/chltjdrhd777/sheet-i18n/commit/1a5e1421e90b02efd1d8f5ff72bf83a9e2f4db78))
+* **create-turbo:** install dependencies ([ff1aeea](https://github.com/chltjdrhd777/sheet-i18n/commit/ff1aeeabbe3d5b704a170fb4974168d4ac9c334c))
+* init turbo-repo based repo ([2019285](https://github.com/chltjdrhd777/sheet-i18n/commit/20192855844fe8fb2b31ad00fdd6ab7714dd082a))
+* make sheet exporter base ([9fc56ba](https://github.com/chltjdrhd777/sheet-i18n/commit/9fc56ba8e24ce021dbc3f65c051549948f961608))
+* prepare publish all packages ([036eba2](https://github.com/chltjdrhd777/sheet-i18n/commit/036eba202cb23f928a91122f28623b70853e62dd))
+* prettier, plop file 적용 ([806fa60](https://github.com/chltjdrhd777/sheet-i18n/commit/806fa607754fb41a01a15303dee693087f6f0966))
+
+
+### Bug Fixes
+
+* add format flag on dev mode ([2abff0a](https://github.com/chltjdrhd777/sheet-i18n/commit/2abff0a580865361019dce3bb103e5aed01cf6e0))
+* change vscode eslint setting to format ([2c7513d](https://github.com/chltjdrhd777/sheet-i18n/commit/2c7513d6c37f57e9cf90fd5868ab40d61cda8366))
+* eslint global config migration ([2573251](https://github.com/chltjdrhd777/sheet-i18n/commit/25732516e70259e2dda2da4e787c63c3abc385c9))
+* eslint package 제거 및 모든 package에 공통 적용되도록 루트에서 적용 ([1d59989](https://github.com/chltjdrhd777/sheet-i18n/commit/1d5998911849dec4d312e4663c966306e5cf48a0))
+* eslint typescript 전역으로 설정되도록 수정 ([8ef2095](https://github.com/chltjdrhd777/sheet-i18n/commit/8ef2095e6fad44650d8179ce0f5408c06bd0ee2e))
+* package 이름 default 값 들어갔던 문제 수정 ([1ef984f](https://github.com/chltjdrhd777/sheet-i18n/commit/1ef984fc03b65a1397ad0d9ef91ab6fcffe58a44))
+* remove auto eslint fix option ([fd35b44](https://github.com/chltjdrhd777/sheet-i18n/commit/fd35b44bd532b13ecff405fbf3f4720a224cbaf0))
+* remove redundant types property in package.json ([2dcde8c](https://github.com/chltjdrhd777/sheet-i18n/commit/2dcde8c004405dd8f3ff72db1c5efd0fc69d08e5))
+
 ### [0.1.1](https://github.com/chltjdrhd777/sheet-i18n/compare/v0.1.2...v0.1.1) (2024-12-23)
 
 

package/README.md

@@ -0,0 +1,189 @@
+# sheet-i18n
+
+**An all-in-one package for sheet-based translations.**
+
+[![npm](https://img.shields.io/npm/v/sheet-i18n)](https://www.npmjs.com/package/sheet-i18n)  
+<a href="https://sheet-i18n.vercel.app/en" target="_blank">
+
+<!-- <img height="20px" src="https://img.shields.io/badge/📚-%20Docs-%23000000"/> -->
+</a>
+
+## Installation 🛠️
+
+You can install **sheet-i18n** via npm:
+
+```bash
+npm install sheet-i18n
+```
+
+## Usage 🚀
+
+### 📑 Main Package - `sheet-i18n`
+
+This is the core package for sheet-based translations. You can use it to work with Google Sheets and export translations.
+
+<details open>
+  <summary>📄 Server export function - `sheet-i18n/exporter`</summary>
+
+#### `sheet-i18n/exporter`
+
+The **server-side exporter** subpackage allows you to interact with Google Sheets and export translations directly into your project. This is primarily used in server-side environments, such as Next.js API routes or other backend frameworks, where you want to fetch and store translations from a Google Spreadsheet to be served to clients or used within your server application.
+
+```jsx
+import { googleSheetExporter } from 'sheet-i18n/exporter';
+
+const exporter = await googleSheetExporter({
+  credentials: {
+    sheetId: 'your-google-sheet-id',
+    clientEmail: 'your-client-email',
+    privateKey: 'your-private-key',
+  },
+  defaultLocale: 'default-language',
+});
+
+await exporter.exportTranslations();
+```
+
+### Configuration ⚙️
+
+The configuration object required for using the exporter is as follows:
+
+#### Required 📝
+
+- **`credentials`**: Google Sheets API credentials:
+  - `sheetId`: The ID of your Google Spreadsheet (extracted from the URL).
+  - `clientEmail`: The email of the Google Sheets API client.
+  - `privateKey`: The private key associated with the client.
+- **`defaultLocale`**: The default locale/language specified in your Google Sheet header.
+
+#### Optional 🔧
+
+- **`headerStartRowNumber`**: Specifies the row number where the headers begin (if not at the top).
+- **`ignoredSheets`**: A list of sheets to exclude by title. By default, sheets without the `defaultLocale` in headers will be ignored.
+- **`exportPath`**: Path to save exported translations. This is the location where the exported translations will be saved. By default, it will use the current working directory (cwd). This option is only used when calling the `exportTranslations` method.
+
+### Exporter Methods 🛠️
+
+#### `getTranslations` 📝
+
+- **Description**: This function retrieves the translation data, which is structured by locale keys (such as "ko", "en", etc.). It collects all translations from the specified sheet, replaces any placeholders, and prepares them to be sent to the client in the response body. Each key corresponds to a language, and the value for each key is an object containing the translated text for that locale.
+
+- **Type**: Function
+- **Parameters**: None
+- **Returns**: An object where each key is a locale (e.g., "ko", "en"), and the value is the respective translation data for that locale.
+
+#### Example:
+
+If the headers in your Google Sheets are `["ko", "en", ...]`, the result returned by `getTranslations` will look like this:
+
+```ts
+{
+  "ko": {
+    "greeting": "안녕하세요",
+    "farewell": "안녕히 가세요"
+  },
+  "en": {
+    "greeting": "Hello",
+    "farewell": "Goodbye"
+  }
+
+  ...
+}
+```
+
+In this example:
+
+- `"ko"` contains the translations for Korean.
+- `"en"` contains the translations for English.
+  Each locale’s object contains key-value pairs for individual translations.
+
+#### `exportTranslations` 📤
+
+- **Description**: This asynchronous function is used in a Node.js environment to export translations directly into your project. It is especially useful if your project includes server-side APIs (like Next.js API routes) and you need to update the locale JSON data in your project. It can be invoked to update or create the locale files within your project, ensuring that the translation data is synced with the local environment.
+
+- **Type**: Function
+- **Parameters**: None
+- **Returns**: `void`
+
+#### Example:
+
+If you call the `exportTranslations` function, it will update or create JSON files in your project for each locale. The result could look like this:
+
+```ts
+// ko.json
+{
+  "greeting": "안녕하세요",
+  "farewell": "안녕히 가세요"
+}
+
+// en.json
+{
+  "greeting": "Hello",
+  "farewell": "Goodbye"
+}
+```
+
+### API Documentation 📚
+
+This package provides a streamlined way to export data using sheets API. It is designed to simplify the integration of spreadsheet data into your applications, particularly for translation workflows and internationalization (i18n).
+
+[Google Sheets API Documentation](https://developers.google.com/sheets/api)<br>
+[Google Auth Library](https://www.npmjs.com/package/google-auth-library)<br>
+[Google Spreadsheet](https://www.npmjs.com/package/google-spreadsheet)
+
+### Exporting Data Format 🗂️
+
+The exported translations will be saved in a format that is easy to use for localization purposes. Each translation is stored in its respective locale folder, with a structured format.
+
+</details>
+
+<!--
+<details>
+  <summary>⚛️ React Component - `sheet-i18n/react`</summary>
+
+#### `sheet-i18n/react`
+
+The **React component** subpackage allows you to use translations within your React application. This is ideal for rendering dynamic translations on the frontend, where you may need to load and display translations from a Google Spreadsheet based on the current locale selected by the user.
+
+```jsx
+import { useState, useEffect } from 'react';
+import { googleSheetExporter } from 'sheet-i18n/react';
+
+const TranslationProvider = ({ children }) => {
+  const [translations, setTranslations] = useState({});
+
+  useEffect(() => {
+    const fetchTranslations = async () => {
+      const exporter = await googleSheetExporter({
+        credentials: {
+          sheetId: 'your-google-sheet-id',
+          clientEmail: 'your-client-email',
+          privateKey: 'your-private-key',
+        },
+        defaultLocale: 'en',
+      });
+      const data = await exporter.getTranslations();
+      setTranslations(data);
+    };
+
+    fetchTranslations();
+  }, []);
+
+  return (
+    <TranslationContext.Provider value={translations}>
+      {children}
+    </TranslationContext.Provider>
+  );
+};
+```
+
+This is useful for applications where translations need to be loaded and displayed dynamically from a backend (e.g., Google Sheets). You can use this provider to wrap your app and pass translations to components.
+
+</details>
+
+---
+
+## Additional Notes 📌
+
+- **Locales**: Ensure that the first row in your Google Sheet contains the locale headers (e.g., `["ko", "en", "fr"]`).
+- **Placeholders**: Any placeholders within the translation strings will be replaced during the export process. -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sheet-i18n",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "./dist/index.d.ts",