@lunarisapp/hyphen 0.0.1

package/.turbo/turbo-build.log

@@ -0,0 +1,23 @@
+
+
+> @lunarisapp/hyphen@0.0.1 build /Users/rsirokov/Projects/Lunaris/text-tools/packages/hyphen
+> tsup src/index.ts --format cjs,esm --dts && copyfiles -u 1 src/dictionaries/*.dic dist
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: ../../tsconfig.json
+CLI tsup v8.3.6
+CLI Target: esnext
+CJS Build start
+ESM Build start
+CJS You have emitDecoratorMetadata enabled but @swc/core was not installed, skipping swc plugin
+ESM You have emitDecoratorMetadata enabled but @swc/core was not installed, skipping swc plugin
+ESM dist/index.mjs 5.59 KB
+ESM ⚡️ Build success in 44ms
+CJS dist/index.js 7.26 KB
+CJS ⚡️ Build success in 44ms
+DTS Build start
+error TS18003: No inputs were found in config file 'tsconfig.json'. Specified 'include' paths were '["src/**/*.ts"]' and 'exclude' paths were '["node_modules","dist"]'.
+
+DTS ⚡️ Build success in 816ms
+DTS dist/index.d.ts  1.27 KB
+DTS dist/index.d.mts 1.27 KB

package/.turbo/turbo-lint.log

@@ -0,0 +1,12 @@
+
+
+> @lunaris/hyphen@0.0.1 lint /Users/rsirokov/Projects/Lunaris/text-tools/packages/hyphen
+> eslint "{src,tests}/**/*.ts" --fix
+
+(node:65030) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///Users/rsirokov/Projects/Lunaris/text-tools/packages/hyphen/eslint.config.js?mtime=1739479673334 is not specified and it doesn't parse as CommonJS.
+Reparsing as ES module because module syntax was detected. This incurs a performance overhead.
+To eliminate this warning, add "type": "module" to /Users/rsirokov/Projects/Lunaris/text-tools/packages/hyphen/package.json.
+(Use `node --trace-warnings ...` to show where the warning was created)
+(node:65030) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///Users/rsirokov/Projects/Lunaris/text-tools/eslint.config.js is not specified and it doesn't parse as CommonJS.
+Reparsing as ES module because module syntax was detected. This incurs a performance overhead.
+To eliminate this warning, add "type": "module" to /Users/rsirokov/Projects/Lunaris/text-tools/package.json.

package/.turbo/turbo-test.log

@@ -0,0 +1,372 @@
+
+
+> @lunaris/hyphen@0.0.1 test /Users/rsirokov/Projects/Lunaris/text-tools/packages/hyphen
+> jest
+
+Determining test suites to run...
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+    TextHyphen {
+      left: 2,
+      right: 2,
+      dictionaries: {
+        af_ZA: 'hyph_af_ZA.dic',
+        af: 'hyph_af_ZA.dic',
+        as_IN: 'hyph_as_IN.dic',
+        as: 'hyph_as_IN.dic',
+        be_BY: 'hyph_be_BY.dic',
+        be: 'hyph_be_BY.dic',
+        bg_BG: 'hyph_bg_BG.dic',
+        bg: 'hyph_bg_BG.dic',
+        ca: 'hyph_ca.dic',
+        cs_CZ: 'hyph_cs_CZ.dic',
+        cs: 'hyph_cs_CZ.dic',
+        da_DK: 'hyph_da_DK.dic',
+        da: 'hyph_da_DK.dic',
+        de_AT: 'hyph_de_AT.dic',
+        de: 'hyph_de_AT.dic',
+        de_CH: 'hyph_de_CH.dic',
+        de_DE: 'hyph_de_DE.dic',
+        el_GR: 'hyph_el_GR.dic',
+        el: 'hyph_el_GR.dic',
+        en_GB: 'hyph_en_GB.dic',
+        en: 'hyph_en_GB.dic',
+        en_US: 'hyph_en_US.dic',
+        eo: 'hyph_eo.dic',
+        es: 'hyph_es.dic',
+        et_EE: 'hyph_et_EE.dic',
+        et: 'hyph_et_EE.dic',
+        fr: 'hyph_fr.dic',
+        gl: 'hyph_gl.dic',
+        hr_HR: 'hyph_hr_HR.dic',
+        hr: 'hyph_hr_HR.dic',
+        hu_HU: 'hyph_hu_HU.dic',
+        hu: 'hyph_hu_HU.dic',
+        id_ID: 'hyph_id_ID.dic',
+        id: 'hyph_id_ID.dic',
+        is: 'hyph_is.dic',
+        it_IT: 'hyph_it_IT.dic',
+        it: 'hyph_it_IT.dic',
+        kn_IN: 'hyph_kn_IN.dic',
+        kn: 'hyph_kn_IN.dic',
+        lt: 'hyph_lt.dic',
+        lv_LV: 'hyph_lv_LV.dic',
+        lv: 'hyph_lv_LV.dic',
+        mn_MN: 'hyph_mn_MN.dic',
+        mn: 'hyph_mn_MN.dic',
+        mr_IN: 'hyph_mr_IN.dic',
+        mr: 'hyph_mr_IN.dic',
+        nb_NO: 'hyph_nb_NO.dic',
+        nb: 'hyph_nb_NO.dic',
+        nl_NL: 'hyph_nl_NL.dic',
+        nl: 'hyph_nl_NL.dic',
+        nn_NO: 'hyph_nn_NO.dic',
+        nn: 'hyph_nn_NO.dic',
+        pa_IN: 'hyph_pa_IN.dic',
+        pa: 'hyph_pa_IN.dic',
+        pl_PL: 'hyph_pl_PL.dic',
+        pl: 'hyph_pl_PL.dic',
+        pt_BR: 'hyph_pt_BR.dic',
+        pt: 'hyph_pt_BR.dic',
+        pt_PT: 'hyph_pt_PT.dic',
+        ro_RO: 'hyph_ro_RO.dic',
+        ro: 'hyph_ro_RO.dic',
+        ru_RU: 'hyph_ru_RU.dic',
+        ru: 'hyph_ru_RU.dic',
+        sa_IN: 'hyph_sa_IN.dic',
+        sa: 'hyph_sa_IN.dic',
+        sk_SK: 'hyph_sk_SK.dic',
+        sk: 'hyph_sk_SK.dic',
+        sl_SI: 'hyph_sl_SI.dic',
+        sl: 'hyph_sl_SI.dic',
+        sq_AL: 'hyph_sq_AL.dic',
+        sq: 'hyph_sq_AL.dic',
+        sr_Latn: 'hyph_sr-Latn.dic',
+        sr: 'hyph_sr.dic',
+        sv: 'hyph_sv.dic',
+        te_IN: 'hyph_te_IN.dic',
+        te: 'hyph_te_IN.dic',
+        th_TH: 'hyph_th_TH.dic',
+        th: 'hyph_th_TH.dic',
+        uk_UA: 'hyph_uk_UA.dic',
+        uk: 'hyph_uk_UA.dic',
+        zu_ZA: 'hyph_zu_ZA.dic',
+        zu: 'hyph_zu_ZA.dic'
+      },
+      lowercaseLangs: {
+        af_za: 'af_ZA',
+        af: 'af',
+        as_in: 'as_IN',
+        as: 'as',
+        be_by: 'be_BY',
+        be: 'be',
+        bg_bg: 'bg_BG',
+        bg: 'bg',
+        ca: 'ca',
+        cs_cz: 'cs_CZ',
+        cs: 'cs',
+        da_dk: 'da_DK',
+        da: 'da',
+        de_at: 'de_AT',
+        de: 'de',
+        de_ch: 'de_CH',
+        de_de: 'de_DE',
+        el_gr: 'el_GR',
+        el: 'el',
+        en_gb: 'en_GB',
+        en: 'en',
+        en_us: 'en_US',
+        eo: 'eo',
+        es: 'es',
+        et_ee: 'et_EE',
+        et: 'et',
+        fr: 'fr',
+        gl: 'gl',
+        hr_hr: 'hr_HR',
+        hr: 'hr',
+        hu_hu: 'hu_HU',
+        hu: 'hu',
+        id_id: 'id_ID',
+        id: 'id',
+        is: 'is',
+        it_it: 'it_IT',
+        it: 'it',
+        kn_in: 'kn_IN',
+        kn: 'kn',
+        lt: 'lt',
+        lv_lv: 'lv_LV',
+        lv: 'lv',
+        mn_mn: 'mn_MN',
+        mn: 'mn',
+        mr_in: 'mr_IN',
+        mr: 'mr',
+        nb_no: 'nb_NO',
+        nb: 'nb',
+        nl_nl: 'nl_NL',
+        nl: 'nl',
+        nn_no: 'nn_NO',
+        nn: 'nn',
+        pa_in: 'pa_IN',
+        pa: 'pa',
+        pl_pl: 'pl_PL',
+        pl: 'pl',
+        pt_br: 'pt_BR',
+        pt: 'pt',
+        pt_pt: 'pt_PT',
+        ro_ro: 'ro_RO',
+        ro: 'ro',
+        ru_ru: 'ru_RU',
+        ru: 'ru',
+        sa_in: 'sa_IN',
+        sa: 'sa',
+        sk_sk: 'sk_SK',
+        sk: 'sk',
+        sl_si: 'sl_SI',
+        sl: 'sl',
+        sq_al: 'sq_AL',
+        sq: 'sq',
+        sr_latn: 'sr_Latn',
+        sr: 'sr',
+        sv: 'sv',
+        te_in: 'te_IN',
+        te: 'te',
+        th_th: 'th_TH',
+        th: 'th',
+        uk_ua: 'uk_UA',
+        uk: 'uk',
+        zu_za: 'zu_ZA',
+        zu: 'zu'
+      },
+      hd: HyphenDict {
+        patterns: Map(16199) {
+          'ISO-' => [Array],
+          '.a' => [Array],
+          '.aan' => [Array],
+          '.aa' => [Array],
+          '.aarts' => [Array],
+          '.aart' => [Array],
+          '.aat' => [Array],
+          '.abl' => [Array],
+          '.ab' => [Array],
+          '.achtend' => [Array],
+          '.acht' => [Array],
+          '.achten' => [Array],
+          '.achte' => [Array],
+          '.acre' => [Array],
+          '.acr' => [Array],
+          '.adi' => [Array],
+          '.af' => [Array],
+          '.afl' => [Array],
+          '.afs' => [Array],
+          '.afture' => [Array],
+          '.aft' => [Array],
+          '.aftu' => [Array],
+          '.aftur' => [Array],
+          '.alee' => [Array],
+          '.ale' => [Array],
+          '.alf' => [Array],
+          '.alk' => [Array],
+          '.alko' => [Array],
+          '.alkov' => [Array],
+          '.alma' => [Array],
+          '.alm' => [Array],
+          '.alom' => [Array],
+          '.alo' => [Array],
+          '.alst' => [Array],
+          '.als' => [Array],
+          '.anas' => [Array],
+          '.ana' => [Array],
+          '.and' => [Array],
+          '.anen' => [Array],
+          '.ane' => [Array],
+          '.angl' => [Array],
+          '.ang' => [Array],
+          '.anth' => [Array],
+          '.ant' => [Array],
+          '.ard' => [Array],
+          '.artr' => [Array],
+          '.art' => [Array],
+          '.ash' => [Array],
+          '.asl' => [Array],
+          '.ast' => [Array],
+          '.astra' => [Array],
+          '.astr' => [Array],
+          '.asu' => [Array],
+          '.ata' => [Array],
+          '.at' => [Array],
+          '.aven' => [Array],
+          '.av' => [Array],
+          '.ave' => [Array],
+          '.b' => [Array],
+          '.bela' => [Array],
+          '.be' => [Array],
+          '.bera' => [Array],
+          '.beri' => [Array],
+          '.bos' => [Array],
+          '.bo' => [Array],
+          '.c' => [Array],
+          '.coo' => [Array],
+          '.co' => [Array],
+          '.coro' => [Array],
+          '.cus' => [Array],
+          '.cu' => [Array],
+          '.d' => [Array],
+          '.daar' => [Array],
+          '.da' => [Array],
+          '.daa' => [Array],
+          '.dagi' => [Array],
+          '.dag' => [Array],
+          '.dagr' => [Array],
+          '.dak' => [Array],
+          '.dan' => [Array],
+          '.debe' => [Array],
+          '.de' => [Array],
+          '.deb' => [Array],
+          '.dek' => [Array],
+          '.dekl' => [Array],
+          '.deks' => [Array],
+          '.denkr' => [Array],
+          '.denk' => [Array],
+          '.deod' => [Array],
+          '.deo' => [Array],
+          '.dero' => [Array],
+          '.desta' => [Array],
+          '.des' => [Array],
+          '.dest' => [Array],
+          '.dia' => [Array],
+          '.di' => [Array],
+          '.diep' => [Array],
+          '.die' => [Array],
+          '.dio' => [Array],
+          '.doet' => [Array],
+          ... 16099 more items
+        },
+        cache: Map(0) {},
+        maxLen: 8
+      }
+    }
+
+      at Object.log (tests/hyphen.test.ts:19:13)
+
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+
+ RUNS  tests/hyphen.test.ts
+
+Tests:       12 passed, 12 total
+Snapshots:   0 total
+Time:        3.24 s
+Ran all test suites.

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @lunarisapp/hyphen
+
+## 0.0.1
+
+### Patch Changes
+
+- Initial release

package/README.md

@@ -0,0 +1,43 @@
+# Lunaris Hyphen
+
+A hyphenation library based on [LibreOffice dictionaries](https://git.libreoffice.org/dictionaries), inspired by [pyphen](https://github.com/Kozea/Pyphen).
+
+> [!TIP]
+> See also:
+>   - [@lunarisapp/stats](https://github.com/LunarisApp/text-tools/tree/main/packages/stats) for text statistics (e.g. word count, sentence count, etc.).
+>   - [@lunarisapp/readability](https://github.com/LunarisApp/text-tools/tree/main/packages/readability) for text readability scores (e.g. Flesch Reading Ease).
+
+## Installation
+
+```bash
+npm install @lunarisapp/hyphen
+```
+
+## Usage
+
+```typescript
+import { TextHyphen } from '@lunarisapp/hyphen';
+
+const hyphen = new TextHyphen({
+    lang: 'en_US',
+    left: 2,
+    right: 2,
+});
+
+// Gets the hyphenation points for a word.
+// Result: [2, 6]
+hyphen.positions('hyphenation');
+
+// Wraps a word with hyphens at the given positions.
+// Result: 'hy-phenation'
+hyphen.wrap('hy-phenation', 3);
+
+// Gets the hyphenation variants for a word.
+// Result: [['hy', 'phenation'], ['hyphen', 'ation']]
+hyphen.variants('hyphenation');
+
+// Inserts hyphens in all possible positions.
+// Result: 'hy-phen-ation'
+hyphen.inserted('hyphenation');
+```
+

package/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ["@babel/preset-env", { targets: { node: "current" } }],
+    "@babel/preset-typescript",
+  ],
+};