yaspeller

You can instruct yaspeller to skip certain parts of your code or text using special comment markers or HTML comments.

Ignore a single line: Use // yaspeller ignore, /* yaspeller ignore */, or <!-- yaspeller ignore --> on the same line as the text.

Ignore a block of text: Wrap the block with yaspeller ignore:start and yaspeller ignore:end.

Example (JS):

/* yaspeller ignore:start */
const reUpper = /A-Z/;
/* yaspeller ignore:end */

Example (HTML):

<!-- yaspeller ignore:start -->
<span>A-Z</span>
<!-- yaspeller ignore:end -->

You can instruct yaspeller to ignore specific lines or blocks of text using special comments.

Ignore a single line: Use // yaspeller ignore, /* yaspeller ignore */, or <!-- yaspeller ignore -->.

var re = /А-ЯЁ/; // yaspeller ignore

var re = /А-ЯЁ/; /* yaspeller ignore */

<span>А-ЯЁ</span> <!-- yaspeller ignore -->

Ignore a block of text: Use yaspeller ignore:start and yaspeller ignore:end.

/* yaspeller ignore:start */
const reUpper = /А-ЯЁ/;
const reLower = /а-яё/;
/* yaspeller ignore:end */

<!-- yaspeller ignore:start -->
<span>А-ЯЁ</span>
<div>а-яё</div>
<!-- yaspeller ignore:end -->

Custom dictionaries are provided as JSON files. You can include plain words or regular expressions.

• A word like someword1 matches both someword1 and Someword1.
• A word like Someword2 matches exactly Someword2.
• Regular expressions allow for complex matching patterns.

Example my_dict.json:

[
    "someword1",
    "Someword2",
    "unknown(W|w)ord[12]?"
]

Usage: yaspeller --dictionary my_dict.json . To use multiple dictionaries: yaspeller --dictionary my_dict.json:my_dict2.json .

To run yaspeller as a git hook, add the following to your .pre-commit-config.yaml:

- repo: https://github.com/hcodes/yaspeller.git
  rev: '' # Use the sha / tag you want to point at
  hooks:
    - id: yaspeller

Run the CLI by passing files, directories, or URLs as arguments. You can also use standard input or glob patterns.

Basic Usage: yaspeller [options] <file-or-directory-or-link...>

Common Examples:

• Search a specific file: yaspeller README.md
• Search using glob syntax (Windows): yaspeller "*.md"
• Search specific extensions in a folder: yaspeller -e ".md,.html,.txt" ./texts/
• Search a website: yaspeller https://ru.wikipedia.org/wiki/Example
• Search a sitemap: yaspeller http://bem.info/sitemap.xml
• Process from STDIN: echo "Hello, world!" | yaspeller --stdin
• Process from STDIN with a specific filename: echo "Hello, world!" | yaspeller --stdin --stdin-filename hello.txt

You can install yaspeller globally via npm to use it as a CLI tool, or as a development dependency in your project.

Global installation:

npm install yaspeller -g

Project installation:

npm install yaspeller --save-dev

You can extend yaspeller by providing your own report module. An external report must be a module that exports an object satisfying the Report interface.

Required Properties and Methods

• name: A unique string identifier for the report.
• At least one of the following lifecycle methods must be implemented:
  • onStart()
  • onResourceComplete(hasError, data, dictionary)
  • onComplete(buffer, stats, configPath)

Report Interface Type Definition

/**
 * @typedef Report
 * @type {Object}
 * @property {string} name
 * @property {Function?} onStart
 * @property {Function?} onResourceComplete
 * @property {Function?} onComplete
 */

Yaspeller can be configured using a JSON file located at the project root. Supported filenames include:

• .yaspellerrc
• .yaspellerrc.js
• .yaspellerrc.json
• .yaspeller.json
• package.json (using the yaspeller field)

Example .yaspeller.json:

{
  "excludeFiles": [
    ".git",
    "node_modules"
  ],
  "lang": "en",
  "fileExtensions": [
    ".md",
    ".css"
  ],
  "dictionary": [
    "someword1"
  ],
  "ignoreUrls": true,
  "findRepeatWords": true
}

Use the initialization action to create a default .yaspellerrc file in your current working directory. This file contains the defaultConfig required for yaspeller to operate. If a .yaspellerrc file already exists, the process will warn you and exit without overwriting your existing configuration.

# Note: The specific CLI command to trigger cliActionInit is not explicitly defined in this file,
# but it is used to generate the .yaspellerrc file.

To use yaspeller in a Grunt workflow, use grunt-shell to execute the CLI command.

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']);
};

To use yaspeller in a Gulp workflow, use gulp-run to execute the CLI binary.

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);
});