Merge pull request #357 from aminya/lazy-debug

Add enableDebug to config
atom · Dec 16, 2020 · 071a3c0 · 071a3c0
2 parents 70e021e + 4874154
commit 071a3c0
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 8 deletions.
diff --git a/lib/locale-checker.js b/lib/locale-checker.js
@@ -1,7 +1,6 @@
 const spellchecker = require('spellchecker');
 const pathspec = require('atom-pathspec');
 const env = require('./checker-env');
-const debug = require('debug');
 
 // The locale checker is a checker that takes a locale string (`en-US`) and
 // optionally a path and then checks it.
@@ -22,7 +21,12 @@ class LocaleChecker {
         this.enabled = true;
         this.hasSystemChecker = hasSystemChecker;
         this.inferredLocale = inferredLocale;
-        this.log = debug('spell-check:locale-checker').extend(locale);
+        if (atom.config.get('spell-check.enableDebug')) {
+            debug = require('debug');
+            this.log = debug('spell-check:locale-checker').extend(locale);
+        } else {
+            this.log = (str) => {};
+        }
         this.log(
             'enabled',
             this.isEnabled(),

diff --git a/lib/main.js b/lib/main.js
@@ -1,14 +1,19 @@
 const { CompositeDisposable } = require('atom');
-const debug = require('debug');
 
 let SpellCheckView = null;
 let spellCheckViews = {};
 
 const LARGE_FILE_SIZE = 2 * 1024 * 1024;
 
+let log = (str) => {};
+
 module.exports = {
     activate() {
-        const log = debug('spell-check');
+        if (atom.config.get('spell-check.enableDebug')) {
+            debug = require('debug');
+            log = debug('spell-check');
+        }
+
         log('initializing');
 
         this.subs = new CompositeDisposable();

diff --git a/lib/spell-check-manager.js b/lib/spell-check-manager.js
@@ -1,4 +1,3 @@
-const debug = require('debug');
 const env = require('./checker-env');
 
 class SpellCheckerManager {
@@ -424,7 +423,12 @@ class SpellCheckerManager {
 
     init() {
         // Set up logging.
-        this.log = debug('spell-check:spell-check-manager');
+        if (atom.config.get('spell-check.enableDebug')) {
+            debug = require('debug');
+            this.log = debug('spell-check:spell-check-manager');
+        } else {
+            this.log = (str) => {};
+        }
 
         // Set up the system checker.
         const hasSystemChecker = this.useSystem && env.isSystemSupported();

diff --git a/lib/system-checker.js b/lib/system-checker.js
@@ -2,7 +2,6 @@ let instance;
 const spellchecker = require('spellchecker');
 const pathspec = require('atom-pathspec');
 const env = require('./checker-env');
-const debug = require('debug');
 
 // Initialize the global spell checker which can take some time. We also force
 // the use of the system or operating system library instead of Hunspell.
@@ -24,7 +23,12 @@ if (env.isSystemSupported()) {
 // due to some memory bug.
 class SystemChecker {
     constructor() {
-        this.log = debug('spell-check:system-checker');
+        if (atom.config.get('spell-check.enableDebug')) {
+            debug = require('debug');
+            this.log = debug('spell-check:system-checker');
+        } else {
+            this.log = (str) => {};
+        }
         this.log('enabled', this.isEnabled(), this.getStatus());
     }
 

diff --git a/package.json b/package.json
@@ -110,6 +110,12 @@
           "description": "Display notices only on the console"
         }
       ]
+    },
+    "enableDebug": {
+      "type": "boolean",
+      "default": false,
+      "title": "Enable debug information for spell check",
+      "order": 10
     }
   },
   "consumedServices": {