Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: prepare to publish eslint-plugin #2620

Merged
merged 1 commit into from Mar 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 9 additions & 3 deletions packages/cspell-eslint-plugin/README.md
@@ -1,10 +1,16 @@
# [WIP] CSpell ESLint Plugin
# CSpell ESLint Plugin

A spell checker plugin for ESLint based upon CSpell.

## [WIP] - Work In Progress
## Feedback Welcome

This plugin is still in active development. Due to the nature of how files are parsed, the `cspell` command line tool and this ESLint plugin will give different results. It is recommended that ESLint or `cspell` checks a file, but not both. Use `ignorePaths` setting in `cspell.json` to tell the `cspell` command line tool to ignore files checked by ESLint.
This plugin is still in active development as part of the CSpell suite of tools and applications.

## In Combination with CSpell

Due to the nature of how files are parsed, the `cspell` command line tool and this ESLint plugin will give different results.
It is recommended that either ESLint or `cspell` checks a file, but not both. Use `ignorePaths` setting in `cspell.json` to
tell the `cspell` command line tool to ignore files checked by ESLint.

## Quick Setup

Expand Down
2 changes: 1 addition & 1 deletion packages/cspell-lib/src/textValidation/docValidator.ts
Expand Up @@ -108,7 +108,7 @@ export class DocumentValidator {

this._ready = true;
this._preparationTime = timer.elapsed();
console.error(`prepareSync ${this._preparationTime.toFixed(2)}ms`);
// console.error(`prepareSync ${this._preparationTime.toFixed(2)}ms`);
}

async prepare(): Promise<void> {
Expand Down