eyo-kernel
Advanced tools
eyo-kernel - npm Package Compare versions
Comparing version 1.0.0 to 1.0.1
@@ -109,3 +109,3 @@ // jshint maxlen:1024 | ||
| /** | ||
| * Восстановление «ё» в тексте. | ||
| * Безопасное восстановление «ё» в тексте. | ||
| * | ||
@@ -112,0 +112,0 @@ * @param {string} text |
| { | ||
| "name": "eyo-kernel", | ||
| "description": "Restoring the letter «ё» (yo) in russian texts", | ||
| "version": "1.0.0", | ||
| "version": "1.0.1", | ||
| "author": { | ||
@@ -12,8 +12,3 @@ "name": "Denis Seleznev", | ||
| "homepage": "https://github.com/hcodes/eyo-kernel", | ||
| "licenses": [ | ||
| { | ||
| "type": "MIT", | ||
| "url": "https://github.com/hcodes/eyo-kernel/blob/master/LICENSE" | ||
| } | ||
| ], | ||
| "license": "MIT", | ||
| "repository": { | ||
@@ -37,7 +32,7 @@ "type": "git", | ||
| "devDependencies": { | ||
| "chai": "~3.0.0", | ||
| "istanbul": "~0.3.5", | ||
| "jscs": "~1.13.1", | ||
| "jshint": "~2.8.0", | ||
| "mocha": "~2.2.1" | ||
| "chai": "~3.4.1", | ||
| "istanbul": "~0.4.2", | ||
| "jscs": "~2.8.0", | ||
| "jshint": "~2.9.1", | ||
| "mocha": "~2.3.4" | ||
| }, | ||
@@ -44,0 +39,0 @@ "scripts": { |
@@ -29,6 +29,55 @@ Восстановление буквы «ё» в русских текстах | ||
| var eyo = require('eyo-kernel'); | ||
| console.log(eyo.restore('Лед')); // Лёд | ||
| ``` | ||
| ## Методы | ||
| ### .restore(text) | ||
| Безопасно восстанавливает букву «ё» в тексте.<br/> | ||
| `text {string}` – текст. Обязательный аргумент.<br/> | ||
| Возвращаемое значение: `{string}`. | ||
| ```js | ||
| console.log(eyo.restore('Все лед')); // Все лёд. | ||
| ``` | ||
| ### .lint(text, [needSort]) | ||
| Поиск вариантов безопасной и небезопасной замены «ё».<br/> | ||
| `text {string}` – текст. Обязательный аргумент.<br/> | ||
| `needSort {boolean}` – Сортивать ли полученные варианты замены. Необязательный аргумент.<br/> | ||
| Возвращаемое значение: `{Object}`. | ||
| ```js | ||
| console.log(eyo.lint('Все лед.')); | ||
| /* { | ||
| safe: [ | ||
| { | ||
| before: 'Лед', | ||
| after: 'Лёд', | ||
| count: 1, | ||
| position: [ | ||
| { | ||
| line: 1, | ||
| column: 5 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| notSafe: [ | ||
| { | ||
| before: 'Все', | ||
| after: 'Всё', | ||
| count: 1, | ||
| position: [ | ||
| { | ||
| line: 1, | ||
| column: 1 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } */ | ||
| ``` | ||
| ## [Консольная утилита](https://github.com/hcodes/eyo) | ||
| ## Eyo в Yaspeller | ||
| В [yaspeller](https://github.com/hcodes/yaspeller/) добавлена поддержка eyo.<br/>Используйте опцию [`--check-yo`](https://github.com/hcodes/yaspeller/#--check-yo) в командной строке `yaspeller -l ru --check-yo my_file.txt` или параметр [`checkYo: true`](https://github.com/hcodes/yaspeller/#configuration) в конфигурационном файле. | ||
| ## Ссылки | ||
@@ -35,0 +84,0 @@ + [http://ru.wikipedia.org/wiki/Ёфикатор](https://ru.wikipedia.org/wiki/%D0%81%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80) |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.04%
3935171
- Number of lines in readme file
- increased by122.5%
89