@laisuk/opencc-fmmseg-wasm 0.2.2 → 0.2.3

package/README.md

@@ -54,16 +54,16 @@ console.log(cc.convert("汉字", false));
 ## Using Config Enums
 
 ```javascript
-import init, {
-    OpenccWasm,
-    WasmOpenccConfig
-} from "@laisuk/opencc-fmmseg-wasm";
-
-await init();
-
-const cc = OpenccWasm.newWithEnum(
-    WasmOpenccConfig.S2t
-);
+import init, {
+    OpenccWasm,
+    OpenccConfigWasm
+} from "@laisuk/opencc-fmmseg-wasm";
+
+await init();
+
+const cc = OpenccWasm.newWithEnum(
+    OpenccConfigWasm.S2t
+);
 
 console.log(cc.convert("汉字", false));
 // 漢字
@@ -356,11 +356,13 @@ If `-o, --output` is omitted, `office` writes:
 
 ---
 
-## TypeScript Support
-
-The package includes generated TypeScript definitions from `wasm-bindgen`.
-
----
+## TypeScript Support
+
+The package includes generated TypeScript definitions from `wasm-bindgen`.
+
+The WASM-facing enum is exported as `OpenccConfigWasm`, alongside `OpenccWasm`.
+
+---
 
 ## Performance Notes
 

package/bin/opencc.js

@@ -41,8 +41,8 @@ function printHelp() {
 opencc-fmmseg WASM CLI
 
 Usage:
-  opencc.js convert [options]
-  opencc.js office  [options]
+  npx opencc-fmmseg convert [options]
+  npx opencc-fmmseg office  [options]
 
 Commands:
   convert                     Convert plain text
@@ -70,12 +70,12 @@ General options:
   -h, --help                  Show help
 
 Examples:
-  node ./bin/opencc.js convert -i a.txt -o b.txt -c s2t
-  node ./bin/opencc.js convert -i a.txt -o b.txt -c s2tw -p
-  cat a.txt | node ./bin/opencc.js convert -c t2s
+  npx opencc-fmmseg convert -i a.txt -o b.txt -c s2t
+  npx opencc-fmmseg convert -i a.txt -o b.txt -c s2tw -p
+  cat a.txt | npx opencc-fmmseg convert -c t2s
 
-  node ./bin/opencc.js office -i a.docx -o b.docx -c s2t -p
-  node ./bin/opencc.js office -i a.epub -c s2tw --auto-ext
+  npx opencc-fmmseg office -i a.docx -o b.docx -c s2t -p
+  npx opencc-fmmseg office -i a.epub -c s2tw --auto-ext
 `);
 }
 
@@ -191,6 +191,11 @@ async function runConvert(args) {
 
     const cc = new OpenccWasm(config);
 
+    // Prompt user if reading from interactive terminal
+    if (!input && process.stdin.isTTY) {
+        console.error("Input text to convert, <Ctrl+Z>/<Ctrl+D> to submit:");
+    }
+
     const inputText = readInputText(input, inEnc);
     const outputText = cc.convert(inputText, punct);
 

package/opencc_fmmseg_wasm.d.ts

@@ -1,23 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 
-export class OpenccWasm {
-    free(): void;
-    [Symbol.dispose](): void;
-    convert(text: string, punctuation: boolean): string;
-    debugPing(): string;
-    getConfig(): string;
-    getConfigId(): number;
-    static getSupportedConfigs(): string[];
-    static isValidConfig(config: string): boolean;
-    constructor(config?: string | null);
-    static newWithEnum(config?: WasmOpenccConfig | null): OpenccWasm;
-    setConfig(config: string): boolean;
-    setConfigEnum(config: WasmOpenccConfig): void;
-    zhoCheck(text: string): number;
-}
-
-export enum WasmOpenccConfig {
+export enum OpenccConfigWasm {
     S2t = 1,
     S2tw = 2,
     S2twp = 3,
@@ -36,6 +20,22 @@ export enum WasmOpenccConfig {
     T2jp = 16,
 }
 
+export class OpenccWasm {
+    free(): void;
+    [Symbol.dispose](): void;
+    convert(text: string, punctuation: boolean): string;
+    debugPing(): string;
+    getConfig(): string;
+    getConfigId(): number;
+    static getSupportedConfigs(): string[];
+    static isValidConfig(config: string): boolean;
+    constructor(config?: string | null);
+    static newWithEnum(config?: OpenccConfigWasm | null): OpenccWasm;
+    setConfig(config: string): boolean;
+    setConfigEnum(config: OpenccConfigWasm): void;
+    zhoCheck(text: string): number;
+}
+
 export function convert_office_bytes(input: Uint8Array, format: string, config: string, punctuation: boolean, keep_font: boolean): Uint8Array;
 
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;

package/opencc_fmmseg_wasm.js

@@ -1,5 +1,27 @@
 /* @ts-self-types="./opencc_fmmseg_wasm.d.ts" */
 
+/**
+ * @enum {1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16}
+ */
+export const OpenccConfigWasm = Object.freeze({
+    S2t: 1, "1": "S2t",
+    S2tw: 2, "2": "S2tw",
+    S2twp: 3, "3": "S2twp",
+    S2hk: 4, "4": "S2hk",
+    T2s: 5, "5": "T2s",
+    T2tw: 6, "6": "T2tw",
+    T2twp: 7, "7": "T2twp",
+    T2hk: 8, "8": "T2hk",
+    Tw2s: 9, "9": "Tw2s",
+    Tw2sp: 10, "10": "Tw2sp",
+    Tw2t: 11, "11": "Tw2t",
+    Tw2tp: 12, "12": "Tw2tp",
+    Hk2s: 13, "13": "Hk2s",
+    Hk2t: 14, "14": "Hk2t",
+    Jp2t: 15, "15": "Jp2t",
+    T2jp: 16, "16": "T2jp",
+});
+
 export class OpenccWasm {
     static __wrap(ptr) {
         const obj = Object.create(OpenccWasm.prototype);
@@ -107,7 +129,7 @@ export class OpenccWasm {
         return this;
     }
     /**
-     * @param {WasmOpenccConfig | null} [config]
+     * @param {OpenccConfigWasm | null} [config]
      * @returns {OpenccWasm}
      */
     static newWithEnum(config) {
@@ -128,7 +150,7 @@ export class OpenccWasm {
         return ret !== 0;
     }
     /**
-     * @param {WasmOpenccConfig} config
+     * @param {OpenccConfigWasm} config
      */
     setConfigEnum(config) {
         wasm.openccwasm_setConfigEnum(this.__wbg_ptr, config);
@@ -146,28 +168,6 @@ export class OpenccWasm {
 }
 if (Symbol.dispose) OpenccWasm.prototype[Symbol.dispose] = OpenccWasm.prototype.free;
 
-/**
- * @enum {1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16}
- */
-export const WasmOpenccConfig = Object.freeze({
-    S2t: 1, "1": "S2t",
-    S2tw: 2, "2": "S2tw",
-    S2twp: 3, "3": "S2twp",
-    S2hk: 4, "4": "S2hk",
-    T2s: 5, "5": "T2s",
-    T2tw: 6, "6": "T2tw",
-    T2twp: 7, "7": "T2twp",
-    T2hk: 8, "8": "T2hk",
-    Tw2s: 9, "9": "Tw2s",
-    Tw2sp: 10, "10": "Tw2sp",
-    Tw2t: 11, "11": "Tw2t",
-    Tw2tp: 12, "12": "Tw2tp",
-    Hk2s: 13, "13": "Hk2s",
-    Hk2t: 14, "14": "Hk2t",
-    Jp2t: 15, "15": "Jp2t",
-    T2jp: 16, "16": "T2jp",
-});
-
 /**
  * @param {Uint8Array} input
  * @param {string} format

package/package.json

@@ -1,38 +1,36 @@
-{
-  "name": "@laisuk/opencc-fmmseg-wasm",
-  "type": "module",
-  "description": "WebAssembly bindings for opencc-fmmseg, a high-performance OpenCC-compatible Simplified/Traditional Chinese converter.",
-  "version": "0.2.2",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/laisuk/opencc-fmmseg-wasm.git"
-  },
-  "keywords": [
-    "opencc",
-    "chinese",
-    "simplified-chinese",
-    "traditional-chinese",
-    "wasm",
-    "webassembly",
-    "opencc-fmmseg",
-    "text-conversion",
-    "cjk",
-    "zh-hans",
-    "zh-hant"
-  ],
-  "bin": {
-    "opencc-fmmseg": "bin/opencc.js"
-  },
-  "files": [
-    "bin/",
-    "opencc_fmmseg_wasm_bg.wasm",
-    "opencc_fmmseg_wasm.js",
-    "opencc_fmmseg_wasm.d.ts"
-  ],
-  "main": "opencc_fmmseg_wasm.js",
-  "types": "opencc_fmmseg_wasm.d.ts",
-  "sideEffects": [
-    "./snippets/*"
-  ]
-}
+{
+  "name": "@laisuk/opencc-fmmseg-wasm",
+  "type": "module",
+  "description": "WebAssembly bindings for opencc-fmmseg, a high-performance OpenCC-compatible Simplified/Traditional Chinese converter.",
+  "version": "0.2.3",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/laisuk/opencc-fmmseg-wasm.git"
+  },
+  "bin": {
+    "opencc-fmmseg": "bin/opencc.js"
+  },
+  "files": [
+    "bin/",
+    "opencc_fmmseg_wasm_bg.wasm",
+    "opencc_fmmseg_wasm.js",
+    "opencc_fmmseg_wasm.d.ts"
+  ],
+  "main": "opencc_fmmseg_wasm.js",
+  "types": "opencc_fmmseg_wasm.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ],
+  "keywords": [
+    "opencc",
+    "chinese",
+    "simplified-chinese",
+    "traditional-chinese",
+    "wasm",
+    "webassembly",
+    "opencc-fmmseg",
+    "text-conversion",
+    "cjk"
+  ]
+}