fix: prepare to publish eslint-plugin (#2620)

streetsidesoftware · Mar 24, 2022 · e5495c4 · e5495c4
1 parent b98f741
commit e5495c4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/packages/cspell-eslint-plugin/README.md b/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
 

diff --git a/packages/cspell-lib/src/textValidation/docValidator.ts b/packages/cspell-lib/src/textValidation/docValidator.ts
@@ -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> {