v3

Author: hcodes

.eslintignore

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20.x]
+        node-version: [24.x]
     steps:
     - uses: actions/checkout@v1
     - name: Use Node.js ${{ matrix.node-version }}

.eslintrc

@@ -0,0 +1 @@
+registry=https://registry.npmjs.org/

.github/workflow/nodejs.yml .github/workflows/nodejs.yml.github/workflow/nodejs.yml renamed to .github/workflows/nodejs.yml

@@ -1,5 +1,8 @@
 # Changelog
 
+## v3.0.0
+Переработано API для возможности использовать в браузере.
+
 ## v2.5.6
 В небезопасный словарь перенесены слова #22, #26:
 - протёкший;

.npmrc

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Denis Seleznev
+Copyright (c) 2025 Denis Seleznev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

CHANGELOG.md

@@ -17,29 +17,28 @@
 Отсутствуют.
 
 ## Использование
+
+### Node.js
 ```js
-const Eyo = require('eyo-kernel');
+import { Eyo } from 'eyo-kernel';
+import { loadSafeDictionary, loadNotSafeDictionary } from 'eyo-kernel/loadDictionary';
+
 const text = 'Мой текст...';
 
 // Работа с безопасным встроенным словарём.
 const safeEyo = new Eyo();
-safeEyo.dictionary.loadSafeSync(); // ./dict/safe.txt.gz
+const safeDictionary = await loadSafeDictionary() // ./dict/safe.txt
+safeEyo.dictionary.set(safeDictionary);
 console.log(safeEyo.restore(text));
 console.log(safeEyo.lint(text));
 
 // Работа с небезопасным встроенным словарём.
 const notSafeEyo = new Eyo();
-notSafeEyo.dictionary.loadNotSafeSync(); // ./dict/not_safe.txt.gz
+const notSafeDictionary = loadNotSafeDictionary(); // ./dict/not_safe.txt
+notSafeEyo.dictionary.set(notSafeDictionary);
 console.log(notSafeEyo.restore(text));
 console.log(notSafeEyo.lint(text));
 
-// Загрузка собственного словаря.
-const eyo = new Eyo();
-// Также поддерживаются словари, сжатые с помощью gzip, *.txt.gz
-eyo.dictionary.loadSync('./my_eyo_dict.txt');
-console.log(eyo.restore(text));
-console.log(eyo.lint(text));
-
 // Создание собственного словаря.
 const eyo = new Eyo();
 // Добавить слово в свой словарь.
@@ -50,6 +49,27 @@ eyo.dictionary.removeWord('словоСБуквойЁ');
 eyo.dictionary.clear();
 ```
 
+### Браузер
+```js
+import { Eyo } from 'eyo-kernel';
+
+const text = 'Мой текст...';
+
+// Работа с безопасным встроенным словарём.
+const safeEyo = new Eyo();
+const safeDictionary = await fetch('./dictionary/safe.txt').then(response => response.text());
+safeEyo.dictionary.set(safeDictionary);
+console.log(safeEyo.restore(text));
+console.log(safeEyo.lint(text));
+
+// Работа с небезопасным встроенным словарём.
+const notSafeEyo = new Eyo();
+const notSafeDictionary = await fetch('./dictionary/not_safe.txt').then(response => response.text());
+notSafeEyo.dictionary.set(notSafeDictionary);
+console.log(notSafeEyo.restore(text));
+console.log(notSafeEyo.lint(text));
+```
+
 ## Словарь
 Первоначально словарь взят из проекта [php-yoficator](https://github.com/rin-nas/php-yoficator/tree/master/Text). По доработкам словаря см. [CHANGELOG.md](./CHANGELOG.md).
 

LICENSE

@@ -0,0 +1,31 @@
+export declare class Dictionary {
+    private dict;
+    constructor();
+    /**
+     * Очищает словарь.
+     */
+    clear(): void;
+    /**
+     * Восстанавливает в слове букву «ё».
+     */
+    restoreWord(word: string): string;
+    /**
+     * Добавляет слово в словарь.
+     */
+    addWord(rawWord: string): void;
+    /**
+     * Удаляет слово из словаря.
+     */
+    removeWord(word: string): void;
+    /**
+     * Установить словарь.
+     */
+    set(dict: string | string[]): void;
+    /**
+     * Получить словарь.
+     */
+    get(): Record<string, string>;
+    private addWordInner;
+    private capitalize;
+    private replaceYo;
+}

README.md

@@ -0,0 +1,81 @@
+export class Dictionary {
+    dict = {};
+    constructor() {
+        this.dict = {};
+    }
+    /**
+     * Очищает словарь.
+     */
+    clear() {
+        this.dict = {};
+    }
+    /**
+     * Восстанавливает в слове букву «ё».
+     */
+    restoreWord(word) {
+        return this.dict[this.replaceYo(word)] || word;
+    }
+    /**
+     * Добавляет слово в словарь.
+     */
+    addWord(rawWord) {
+        let word = rawWord;
+        if (rawWord.search('#') > -1) {
+            word = word.split('#')[0].trim();
+        }
+        if (word.search(/\(/) > -1) {
+            const parts = word.split(/[(|)]/);
+            for (let i = 1, len = parts.length - 1; i < len; i++) {
+                this.addWordInner(parts[0] + parts[i]);
+            }
+        }
+        else {
+            this.addWordInner(word);
+        }
+    }
+    /**
+     * Удаляет слово из словаря.
+     */
+    removeWord(word) {
+        const wordE = this.replaceYo(word);
+        delete this.dict[wordE];
+        if (word.search(/^[А-ЯЁ]/) === -1) {
+            delete this.dict[this.capitalize(wordE)];
+        }
+    }
+    /**
+     * Установить словарь.
+     */
+    set(dict) {
+        this.clear();
+        if (!dict) {
+            return;
+        }
+        const buffer = Array.isArray(dict) ? dict : dict.trim().split(/\r?\n/);
+        buffer.forEach(word => this.addWord(word));
+    }
+    /**
+     * Получить словарь.
+     */
+    get() {
+        return this.dict;
+    }
+    addWordInner(word) {
+        // Слово может использоваться только со строчной буквы.
+        // Пример: _киёв. Киев и только киёв.
+        const hasUnderscore = word.search('_') === 0;
+        word = word.replace(/^_/, '');
+        const key = this.replaceYo(word);
+        this.dict[key] = word;
+        if (word.search(/^[А-ЯЁ]/) === -1 && !hasUnderscore) {
+            this.dict[this.capitalize(key)] = this.capitalize(word);
+        }
+    }
+    capitalize(text) {
+        return text.substr(0, 1).toUpperCase() + text.substr(1);
+    }
+    replaceYo(word) {
+        return word.replace(/Ё/g, 'Е').replace(/ё/g, 'е');
+    }
+}
+;

dist/dictionary.d.ts

@@ -0,0 +1,27 @@
+import { Dictionary } from './dictionary';
+type Position = {
+    line: number;
+    column: number;
+    index: number;
+};
+type Replacement = {
+    before: string;
+    after: string;
+    position: Position[];
+};
+export declare class Eyo {
+    dictionary: Dictionary;
+    /**
+     * Ищет варианты замены буквы «е» на «ё».
+     */
+    lint(text: string, groupByWords?: boolean): Replacement[];
+    /**
+     * Восстанавливает букву «ё» в тексте.
+     */
+    restore(text: string): string;
+    private hasEYo;
+    private getPosition;
+    private delDuplicates;
+    private sort;
+}
+export {};