reedach-server 0.1.0 → 0.1.2

package/NOTICE.md

@@ -3,10 +3,11 @@
 ## Словарь правил
 
 Правила и формулировки подсказок в `packages/core/src/rules.js` написаны для проекта
-самостоятельно. Идеи взяты из открытых статей об информационном стиле: Максим Ильяхов,
-Бюро Горбунова и другие авторы. Тексты статей в проект не копировались.
+самостоятельно. Идеи взяты из открытых статей об информационном стиле:
+[Максим Ильяхов](https://maximilyahov.ru), [Бюро Горбунова](https://bureau.ru) и другие авторы.
+Тексты статей в проект не копировались.
 
-Проект не связан с сервисом «Главред» и его авторами и не заменяет профессиональную редактуру.
+Проверка не заменяет профессиональную редактуру.
 
 ## Сторонние данные и программы
 
@@ -17,10 +18,16 @@
 | Компонент | Лицензия | Источник |
 |---|---|---|
 | Az.js — морфологический анализ | MIT | https://github.com/deNULL/Az.js |
-| Словари Az.js — данные OpenCorpora, сборка pymorphy2 | CC BY-SA | http://opencorpora.org |
+| Словари Az.js — данные OpenCorpora, сборка pymorphy2 | CC BY-SA | https://opencorpora.org |
 | dictionary-ru — словарь hunspell, © 1997–2008 Alexander I. Lebedev | BSD-3-Clause | https://github.com/wooorm/dictionaries |
 | dictionary-en — словарь hunspell на основе SCOWL | MIT AND BSD | https://github.com/wooorm/dictionaries |
-| hunspell — проверка орфографии, запускается как отдельная программа | GPL-2.0 / LGPL-2.1 / MPL-1.1 на выбор | https://hunspell.github.io |
+| hunspell — проверка орфографии, запускается как отдельная программа | GPL-2.0 / LGPL-2.1 / MPL-1.1 на выбор | https://github.com/hunspell/hunspell |
+
+Hunspell не входит в код Reedach и не распространяется вместе с ним: сервер запускает
+установленную в системе программу `hunspell` отдельным процессом и передаёт ей слова. В
+Docker-образ она попадает из пакета Alpine `hunspell` со своей лицензией. Словари hunspell
+ставятся из npm вместе с `reedach-server` (пакеты `dictionary-ru` и `dictionary-en`) и
+используются без изменений.
 
 Словари OpenCorpora используются без изменений. Изменённые словари, если появятся,
 будут распространяться под той же лицензией CC BY-SA с указанием источника.

package/README.md

@@ -23,7 +23,7 @@ import {check} from 'reedach-server';
 
 const {issues} = await check({
   markdown: 'В настоящее время мы осуществляем доставку.',
-  ignore: ['Glaskraft'],          // слова автора: формы тоже принимаются
+  ignore: ['Reedach'],            // слова автора: формы тоже принимаются
   disable: ['intensifiers'],      // выключить правило по id или целую категорию
 });
 ```
@@ -41,6 +41,11 @@ docker run -d -p 3000:3000 -e REEDACH_KEYS="длинный-ключ-сайта=h
 
 ### Ключи
 
+Ключ — это пароль от вашего сервера Reedach. Его никто не выдаёт, регистрироваться нигде не
+нужно: вы придумываете ключ сами (любой случайный набор от 16 символов, например
+`openssl rand -hex 24`), передаёте серверу при запуске и сообщаете своему сайту. Без правильного
+ключа сервер текст не проверяет.
+
 `REEDACH_KEYS` — список ключей через `;`. Каждый ключ не короче 16 символов. После `=`
 через запятую перечисляются сайты, со страниц которых этот ключ можно использовать
 прямо из браузера.
@@ -112,8 +117,25 @@ docker run -d -p 3000:3000 -e REEDACH_KEYS="длинный-ключ-сайта=h
 
 ## Как устроена орфография
 
+Опечатки ищет [hunspell](https://github.com/hunspell/hunspell) — открытая программа проверки
+орфографии. Reedach запускает её отдельной программой на вашем сервере.
+
+Словари: русский — `dictionary-ru` на основе словаря Александра Лебедева, английский —
+`dictionary-en` на основе SCOWL. Оба подключены сразу, поэтому английские слова в русском тексте
+не считаются ошибками. Русскому словарю много лет: новых слов и заимствований в нём может не
+быть, для них есть слова автора.
+
+Проверяются слова из букв, в том числе через дефис. Пропускаются ссылки, адреса почты,
+аббревиатуры заглавными буквами, слова с цифрами, однобуквенные слова и английские
+сокращения вроде isn't.
+
+Слова автора (`ignore`) принимаются и в других формах: если у слова та же основа и после неё
+не больше пяти букв. У глаголов основа считается без -ть и -ться. Правило работает для слов
+от пяти букв, более короткие должны совпасть точно.
+
 Ошибки ищет короткий запуск `hunspell -l` на каждый запрос: это быстро, тысячи слов за
-доли секунды. Варианты подбирает один постоянно запущенный `hunspell -a`:
+доли секунды. Варианты подбирает один постоянно запущенный `hunspell -a`, до пяти на слово,
+готовые ответы запоминаются для 5000 слов:
 
 - в него уходят только слова из букв, каждое отдельной строкой со служебным знаком в
   начале, поэтому никакой текст не станет командой hunspell;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reedach-server",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Сервер Reedach: орфография (hunspell), морфология (Az.js + OpenCorpora) и подсказки по стилю для русского текста — библиотекой или по HTTP",
   "license": "MIT",
   "author": "Dima Faller <dima@dimafaller.ru>",
@@ -41,10 +41,10 @@
     "az": "0.2.3",
     "dictionary-en": "4.0.0",
     "dictionary-ru": "3.0.0",
-    "reedach": "0.1.0"
+    "reedach": "0.1.2"
   },
   "peerDependencies": {
-    "reedach-widget": "^0.1.0"
+    "reedach-widget": "^0.1.2"
   },
   "peerDependenciesMeta": {
     "reedach-widget": {