Publish to npm

Author: lekoOwO

.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish to NPM
+
+on:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish to NPM
+        run: npm publish --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1 +1,3 @@
 .vscode/
+node_modules/
+dist/

README.md

@@ -1,3 +1,42 @@
-# opencc-rust-lib
+# OpenCC Rust Library
 
-將 [polyproline/opencc-rust](https://github.com/polyproline/opencc-rust) 封裝為 ES6 模組，使 OpenCC 可以直接被瀏覽器引用。
+這是基於 Rust + WebAssembly 的 OpenCC 中文轉換工具。
+
+## 安裝
+
+```sh
+npm install opencc-rust
+```
+
+## 使用方式
+
+### ESM/現代瀏覽器/Node.js
+
+```js
+import { initOpenccRust, getConverter } from 'opencc-rust';
+// 或是 import { initOpenccRust, getConverter } from 'https://cdn.jsdelivr.net/npm/opencc-rust/dist/opencc-rust.mjs';
+
+await initOpenccRust();
+const converter = getConverter();
+const result = await converter.convert('漢字');
+```
+
+### UMD/CDN
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/opencc-rust/dist/opencc-rust.umd.js"></script>
+<script>
+OpenccRust.initOpenccRust().then(() => {
+  const converter = OpenccRust.getConverter();
+  converter.convert('漢字').then(result => {
+    console.log(result);
+  });
+});
+</script>
+```
+## 授權
+MIT
+
+## 致謝
+
+[polyproline/opencc-rust](https://github.com/polyproline/opencc-rust)

js/opencc-rust-lib.mjs dist/opencc-rust-lib.mjsjs/opencc-rust-lib.mjs renamed to dist/opencc-rust-lib.mjs

@@ -1,4 +1,4 @@
-import { Converter, ConverterBuild, init } from "./opencc-rust-lib.mjs"
+import { Converter, ConverterBuild, init } from "./opencc-rust-lib.mjs";
 
 const RESOURCES = {
     opencc_wasm: "https://cdn.jsdelivr.net/gh/polyproline/opencc-wasm@main/opencc_gc.wasm",
@@ -47,21 +47,29 @@ const CONVERTION_MAP = {
 
 const SELECTED_DICT = CONVERTION_MAP.ToTaiwan;
 
-const wasm = await fetch(RESOURCES.opencc_wasm);
-await init(wasm);
+let _converter = null;
 
-const build = ConverterBuild.new();
-for (let dict of SELECTED_DICT) {
-    if (Array.isArray(dict)) {
-        for(let d of dict) {
-            build.adddict(await fetch(RESOURCES[d]).then(response => response.text()));
+async function initOpenccRust() {
+    const wasm = await fetch(RESOURCES.opencc_wasm);
+    await init(wasm);
+
+    const build = ConverterBuild.new();
+    for (let dict of SELECTED_DICT) {
+        if (Array.isArray(dict)) {
+            for(let d of dict) {
+                build.adddict(await fetch(RESOURCES[d]).then(response => response.text()));
+            }
+        } else {
+            build.adddict(await fetch(RESOURCES[dict]).then(response => response.text()));
         }
-    } else {
-        build.adddict(await fetch(RESOURCES[dict]).then(response => response.text()));
+        build.group();
     }
-    build.group();
+    _converter = build.build();
 }
 
-const converter = build.build();
+function getConverter() {
+    if (!_converter) throw new Error("You must call and await initOpenccRust() first.");
+    return _converter;
+}
 
-export { converter };
+export { initOpenccRust, getConverter };

js/opencc-rust.mjs dist/opencc-rust.mjsjs/opencc-rust.mjs renamed to dist/opencc-rust.mjs

@@ -46,12 +46,21 @@
 
         </style>
         <script type="module">
-            import { converter } from "./js/opencc-rust.mjs"
+            import { initOpenccRust, getConverter } from "./dist/opencc-rust.mjs";
+
+            let converter;
+            (async () => {
+                await initOpenccRust();
+                converter = getConverter();
+            })();
 
             window.convert = async function() {
-                const text = document.getElementById("text").value
+                if (!converter) {
+                    alert("OpenCC 尚未初始化完成，請稍後再試。");
+                    return;
+                }
+                const text = document.getElementById("text").value;
                 const converted = await converter.convert(text);
-
                 document.getElementById("result").value = converted;
             }
         </script>

index.html

@@ -0,0 +1,41 @@
+{
+  "name": "opencc-rust",
+  "version": "1.1.2",
+  "description": "OpenCC Rust WebAssembly/JS Converter Library",
+  "main": "dist/opencc-rust.mjs",
+  "module": "dist/opencc-rust.mjs",
+  "exports": {
+    ".": {
+      "import": "./dist/opencc-rust.mjs",
+      "require": "./dist/opencc-rust.mjs",
+      "types": "./dist/opencc-rust.d.ts"
+    }
+  },
+  "files": [
+    "dist/"
+  ],
+  "keywords": [
+    "opencc",
+    "rust",
+    "wasm",
+    "converter",
+    "chinese"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lekoOwO/opencc-rust-lib"
+  },
+  "scripts": {
+    "build:umd": "rollup -c",
+    "build:esm": "npx cpx \"src/**/*\" dist/",
+    "build": "npm run build:esm && npm run build:umd"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "cpx": "^1.5.0",
+    "rollup": "^4.43.0"
+  },
+  "types": "dist/opencc-rust.d.ts"
+}