@ukie-app/uk-lang-helpers

1.0.3 • Public • Published

uk-lang-helpers

A repo for storing helper functions needed to process the Ukrainian language in various ways

Contents:

Usage

Install the package via npm

npm i @ukie-app/uk-lang-helpers --save-dev

Import the specific function into your project

const { splitTheWordIntoSyllables } = require('@ukie-app/uk-lang-helpers')

Build

if you want to clone GitHub repo and test it locally you can run

npm run test

to run tests specified in the tests/testObj.js file

Available functions:

splitTheWordIntoSyllables(str: word, enableDebug: false)

This function splits the word into syllables

Syllable forming rules:

Based on rules specified in EdEra book

Main rule: vowels form syllables

  1. There are as many syllables as there are vowels
  2. A syllable cannot exist without a vowel

Cases to form a new syllable with the current consonant:

  1. both neighbors are vowels (г in кни-га)
  2. it's sonorant and its previous neighbor is sonorant as well (н in вiль-но, н in вiр-нiсть)
  3. it's voiced and its previous neighbor is voiceless (т in греб-ти, к in нiж-ка)
  4. the next consonant neighbor is the same type (voiced or voiceless) (с in го-спо-дар, ща-стя)
  5. it's voiced or voiceless consonant and its next neighbor is sonorant (з in бли-зня-та, д in му-дрець)
  6. its next neighbor is the same letter (doubling of consonants) (збi-жжя, бу-ття, во-ло-сся)

Misc

This package follows npm's semantic versioning guildelines

Package Sidebar

Install

npm i @ukie-app/uk-lang-helpers

Weekly Downloads

0

Version

1.0.3

License

GPL-3.0-or-later

Unpacked Size

47.3 kB

Total Files

4

Last publish

Collaborators

  • jellysquider