معرفی شرکت ها
yaspeller-8.0.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Search tool typos in the text, files and websites
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | yaspeller-8.0.1 |
| نام | yaspeller |
| نسخه کتابخانه | 8.0.1 |
| نگهدارنده | ['hcodes'] |
| ایمیل نگهدارنده | ['hcodes@yandex.ru'] |
| نویسنده | Denis Seleznev |
| ایمیل نویسنده | hcodes@yandex.ru |
| آدرس صفحه اصلی | git://github.com/hcodes/yaspeller.git |
| آدرس اینترنتی | https://github.com/hcodes/yaspeller |
| مجوز | MIT |
yaspeller
=========
[](https://www.npmjs.com/package/yaspeller)
[](https://www.npmjs.org/package/yaspeller)
[](https://coveralls.io/r/hcodes/yaspeller)
[](https://packagephobia.com/result?p=yaspeller)
<img align="right" width="200" src="https://raw.githubusercontent.com/hcodes/yaspeller/master/images/logo.png" />
This README is also available [in Russian](./README.ru.md).
Search tool typos in the text, files and websites.
Used API [Yandex.Speller](https://tech.yandex.ru/speller/doc/dg/concepts/About-docpage/).
## Installation
`npm install yaspeller -g`
## Using CLI
`yaspeller [options] <file-or-directory-or-link...>`
## Using with [pre-commit](https://pre-commit.com/)
Add this to your `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/hcodes/yaspeller.git
rev: '' # Use the sha / tag you want to point at
hooks:
- id: yaspeller
```
### Examples
+ `yaspeller README.md` — search typos in the file.
+ `yaspeller "*.md"` — node glob syntax for Windows.
+ `yaspeller -e ".md,.html,.txt" ./texts/` — finding typos in files in the folder.
+ `yaspeller https://ru.wikipedia.org/wiki/%D0%9E%D0%BF%D0%B5%D1%87%D0%B0%D1%82%D0%BA%D0%B0` — search typos in the page.
+ `yaspeller http://bem.info/sitemap.xml` — search typos at the addresses specified in the sitemap.xml.
+ `echo "Hello, world!" | yaspeller --stdin`
+ `echo "Hello, world!" | yaspeller --stdin --stdin-filename hello.txt`
### Options
#### `-f, --format <value>`
Formats: `plain`, `html`, `markdown` or `auto`.<br/>
Default: `auto`.
#### `-l, --lang <value>`
Languages: `en`, `ru` or `uk`.<br/>
Default: `en,ru`.
#### `-c, --config <path>`
Configuration file path.
#### `-e, --file-extensions <value>`
Set file extensions to search for files in a folder.<br/>
Example: `.md,.htm,.txt`.
#### `--dictionary <file>`
JSON file for own dictionary.
```js
[
"someword1", // someword1 = someword1 and Someword1
"Someword2", // Someword2 = Someword2
"someword3"
]
```
Regular expressions are supported:
```js
[
"unknownword",
"unknown(W|w)ord[12]?", // unknown(W|w)ord[12]? = unknown(W|w)ord[12]? and Unknown(W|w)ord[12]?
"Unknown(W|w)ord[34]?" // Unknown(W|w)ord[34]? = Unknown(W|w)ord[34]?
]
```
Examples:<br/>
`yaspeller --dictionary my_dict.json .`<br/>
`yaspeller --dictionary my_dict.json:my_dict2.json .`
If you have tons of markdown and introduce this linter, you're likely to want
generation of initial dictionary with [yaspeller-dictionary-builder](https://github.com/razum2um/yaspeller-dictionary-builder),
so one line will cover all word's forms.
#### `--report <type>`
Set type of report: `console`, `html`, `markdown`, `junit` or `json`.<br/>
Default: `console`<br/>
Example: `console,html,custom_report.js`
#### `--check-yo`
Check the correctness of using the letter “Ё” (Yo) in Russian texts.
#### `--by-words`
Do not use a dictionary environment (context) during the scan.<br/>
This is useful in cases where the service is transmitted to the input of a list of individual words.
#### `--find-repeat-words`
Highlight repetitions of words, consecutive. For example, `I flew to to to Cyprus`.
#### `--flag-latin`
Flag words, written in Latin, as erroneous.
#### `--ignore-tags <tags>`
Ignore HTML tags.<br/>
Default: `code,kbd,object,samp,script,style,var`<br/>
Option to formats `html` and` markdown`.
#### `--ignore-text <regexp>`
Remove the text from the scan using regular expressions.
#### `--ignore-capitalization`
Ignore the incorrect use of UPPERCASE / lowercase letters, for example, in the word `moscow`.
#### `--ignore-digits`
Ignore words with numbers, such as `avp17h4534`.
#### `--ignore-latin`
Ignore words, written in Latin, for example, `madrid`.
#### `--ignore-roman-numerals`
Ignore Roman numerals `I, II, III, ...`.
#### `--ignore-uppercase`
Ignore words written in capital letters.
#### `--ignore-urls`
Ignore Internet addresses, email addresses and filenames.
#### `--max-requests <value>`
Max count of requests in parallel.<br/>
Default: `2`.
#### `--no-color`
Clean output without colors.
#### `--only-errors`
Output only errors.
#### `--stdin`
Process files on `<STDIN>`. Default: false
#### `--stdin-filename <file>`
Specify filename to process `<STDIN>` as. Used in reports.
#### `--debug`
Debug mode.
## Configuration
`npm install yaspeller --save-dev`
Add the text in `package.json` / `scripts`:<br/>
` "yaspeller": "yaspeller .",`
To run the linter:<br/>
`npm run yaspeller`
`yaspeller` is configured using JSON file at the root of the project:
- `.yaspellerrc`
- `.yaspellerrc.js`
- `.yaspellerrc.json`
- `.yaspeller.json`
- `package.json`, field `yaspeller`
```JSON
{
"excludeFiles": [
".git",
"libs",
"node_modules",
"yaspeller"
],
"lang": "ru",
"fileExtensions": [
".md",
".css"
],
"dictionary": [
"someword1"
]
}
```
**Advanced example:**
```js
{
"excludeFiles": [
".git",
"yaspeller",
"node_modules",
"libs"
],
"format": "html",
"lang": "en",
"fileExtensions": [
".md",
".css"
],
"report": ["console", "html"],
"dictionary": [
// JSON comments
"someword1", // someword1 = someword1 and Someword1
"Someword2", // Someword2 = Someword2
"some(w|W)ord[23]", // some(w|W)ord[23] = some(w|W)ord[23] and Some(w|W)ord[23]
"Some(w|W)ord" // Some(w|W)ord = Some(w|W)ord
],
"ignoreText": [
"<php\?[^]*?\?>", // Shortly
["<php\?[^]*?\?>", "g"] // Longly
],
"ignoreTags": ["code", "script"],
"ignoreUrls": true,
"findRepeatWords": true,
"maxRequests": 5
}
```
| Property | Type | Details |
|----------|------|---------|
| `format` | `String` | [`--format`](#-f---format-value) |
| `lang` | `String` | [`--lang`](#-l---lang-value) |
| `excludeFiles` | `Array` | |
| `fileExtensions` | `Array` | [`--file-extension`](#--file-extensions-value) |
| `dictionary` | `Array` | [`--dictionary`](#--dictionary-file) |
| `report` | `Array` | [`--report`](#--report-type) |
| `checkYo` | `Boolean` | [`--check-yo`](#--check-yo) |
| `byWords` | `Boolean` | [`--by-words`](#--by-words) |
| `findRepeatWords` | `Boolean` | [`--find-repeat-words`](#--find-repeat-words) |
| `flagLatin` | `Boolean` | [`--flag-latin`](#--flag-latin) |
| `ignoreTags` | `Array` | [`--ignore-tags`](#--ignore-tags-tags) |
| `ignoreText` | `Array` | [`--ignore-text`](#--ignore-text-regexp) |
| `ignoreCapitalization` | `Boolean` | [`--ignore-capitalization`](#--ignore-capitalization) |
| `ignoreDigits` | `Boolean` | [`--ignore-digits`](#--ignore-digits) |
| `ignoreLatin` | `Boolean` | [`--ignore-latin`](#--ignore-latin) |
| `ignoreRomanNumerals` | `Boolean` | [`--ignore-roman-numerals`](#--ignore-roman-numerals) |
| `ignoreUppercase` | `Boolean` | [`--ignore-uppercase`](#--ignore-uppercase) |
| `ignoreUrls` | `Boolean` | [`--ignore-urls`](#--ignore-urls) |
| `maxRequests` | `Number` | [`--max-requests`](#--max-requests-value) |
## Ignore text from checking
### Ignore a line
```js
var re = /a-z/; // yaspeller ignore
```
```js
var re = /a-z/; /* yaspeller ignore */
```
```html
<span>a-z</span> <!-- yaspeller ignore -->
```
### Ignore a block
```js
/* yaspeller ignore:start */
const reUpper = /A-Z/;
const reLower = /a-z/;
/* yaspeller ignore:end */
```
```html
<!-- yaspeller ignore:start -->
<span>A-Z</span>
<div>a-z</div>
<!-- yaspeller ignore:end -->
```
## [Gulp](http://gulpjs.com) plugin
```js
const gulp = require('gulp');
const run = require('gulp-run'); // npm install gulp-run --save-dev
gulp.task('yaspeller', function (cb) {
run('./node_modules/.bin/yaspeller .').exec()
.on('error', function (err) {
console.error(err.message);
cb();
})
.on('finish', cb);
});
```
## [Grunt](http://gruntjs.com) plugin
```js
module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-shell'); // npm install grunt-shell --save-dev
grunt.initConfig({
shell: {
yaspeller: {
options: {stderr: false},
command: './node_modules/.bin/yaspeller .'
}
}
});
grunt.registerTask('lint', ['shell:yaspeller']);
};
```
## [Restrictions API Yandex.Speller](http://legal.yandex.ru/speller_api/)
## Links
- [Yaspeller for CI](https://github.com/ai/yaspeller-ci)
- [Github Action for Yaspeller](https://github.com/heytitle/github-action-yaspeller)
## [License](./LICENSE.md)
MIT License
نیازمندی
| مقدار | نام |
|---|---|
| ^3.2.3 | async |
| ^3.0.0 | commander |
| ^3.0.1 | entities |
| ^1.0.3 | escape-html |
| ^2.5.6 | eyo-kernel |
| ^7.2.0 | glob |
| ^4.0.0 | isutf8 |
| ^2.0.4 | lilconfig |
| ^4.0.12 | marked |
| ^5.0.0 | minimatch |
| ^2.6.7 | node-fetch |
| ^1.0.0 | picocolors |
| ^2.4.0 | secure-json-parse |
| ^3.1.1 | strip-json-comments |
| ^0.4.23 | xml2js |
| ^4.1.0 | yandex-speller |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| 16.13.2 | Npm |
نحوه نصب
نصب پکیج tgz yaspeller-8.0.1:
npm install yaspeller-8.0.1.tgz