lib: fixed spelling errors in comments

Co-authored-by: Christian Clauss <[email protected]>

Author: owl-from-hogvarts

lib/find-python.js

@@ -9,7 +9,7 @@ const extend = require('util')._extend // eslint-disable-line
 const win = process.platform === 'win32'
 const logWithPrefix = require('./util').logWithPrefix
 
-//! after editing file dont forget run "npm test" and
+//! after editing file don't forget run "npm test" and
 //! change tests for this file if needed
 
 // ? may be some addition info in silly and verbose levels
@@ -33,8 +33,8 @@ function colorizeOutput (color, string) {
 }
 
 //! on windows debug running with locale cmd (e. g. chcp 866) encoding
-// to avoid that uncoment next lines
-// locale encdoings couse issues. See run func for more info
+// to avoid that uncomment next lines
+// locale encodings cause issues. See run func for more info
 // this lines only for testing
 // win ? cp.execSync("chcp 65001") : null
 // log.level = "silly";
@@ -46,7 +46,7 @@ class PythonFinder {
   /**
    *
    * @param {string} configPython force setted from terminal or npm config python path
-   * @param {(err:Error, found:string) => void} callback succsed/error callback from where result
+   * @param {(err:Error, found:string) => void} callback succeed/error callback from where result
    * is available
    */
   constructor (configPython, callback) {
@@ -109,7 +109,7 @@ class PythonFinder {
   }
 
   /**
-   * Getting list of checks which should be cheked
+   * Getting list of checks which should be checked
    *
    * @private
    * @returns {check[]}
@@ -256,7 +256,7 @@ class PythonFinder {
    * @argument {check[]} checks
    */
   async runChecks (checks) {
-    // using this flag becouse Fail is happen when ALL checks fail
+    // using this flag because Fail is happen when ALL checks fail
     let fail = true
 
     for (const check of checks) {
@@ -319,7 +319,7 @@ class PythonFinder {
     let args = this.argsExecutable
     let shell = false
     if (this.win) {
-      // Arguments have to be manually quoted to avoid bugs with spaces in pathes
+      // Arguments have to be manually quoted to avoid bugs with spaces in paths
       exec = `"${exec}"`
       args = args.map((a) => `"${a}"`)
       shell = true
@@ -354,8 +354,8 @@ class PythonFinder {
 
   /**
    *
-   * Check if a getted path is correct and
-   * Python executable hase the correct version to use.
+   * Check if a gotten path is correct and
+   * Python executable has the correct version to use.
    *
    * @private
    * @argument {string} execPath path to check
@@ -370,7 +370,7 @@ class PythonFinder {
       this.run(execPath, this.argsVersion, false)
         .then((ver) => {
           // ? may be better code for version check
-          // ? may be move log messgaes to catchError func
+          // ? may be move log messages to catchError func
           const range = new semver.Range(this.semverRange)
           let valid = false
 
@@ -398,7 +398,7 @@ class PythonFinder {
               colorizeOutput(RED, 'THIS VERSION OF PYTHON IS NOT SUPPORTED')
             )
             // object with error passed for conveniences
-            // (becouse we may want to pass also stderr or some additional stuff)
+            // (because we may also want to pass stderr or other variables)
             // eslint-disable-next-line prefer-promise-reject-errors
             reject({
               err: new Error(`Found unsupported Python version ${ver}`)
@@ -443,27 +443,26 @@ class PythonFinder {
         )
         this.log.silly('execFile: opts = ', JSON.stringify(opts, null, 2))
 
-        //* prosible outcomes with error messages on windows (err.message, error.stack?, stderr)
+        //* possible outcomes with error messages on Windows (err.message, error.stack?, stderr)
         // issue of encoding (garbage in terminal ) when 866 or any other locale code
         // page is setted
         // possible solutions:
-        // 1. let it be as it is and just warn user that it should use utf8
-        // (already done in this.catchErros's info statement)
-        // 2. somehow determine user's terminal encdoing and use utils.TextDecoder
-        // with getting raw buffer from execFile.
-        // Requires to correct error.message becouse garbage persists there
-        // 3. Forse user's terminal to use utf8 encoding via e.g. run "chcp 65001". May broke some user's programs
-        // 4. use "cmd" command with flag "/U" and "/C" (for more informatiom run "help cmd")
+        // 1. leave it as is and just warn the user that it should use utf8
+        // (already done in this.catchError's info statement)
+        // 2. somehow determine the user's terminal encoding and use utils.TextDecoder
+        // with the raw buffer from execFile.
+        // Requires to correct error.message because garbage persists there
+        // 3. Force the user's terminal to use utf8 encoding via e.g. run "chcp 65001". May break user's programs
+        // 4. use "cmd" command with flag "/U" and "/C" (for more information run "help cmd")
         // which "Causes the output of
         // internal commands ... to be Unicode" (utf16le)
         //* note: find-python-script.py already send output in utf8 then may become necessary
         //* to reencode string with Buffer.from(stderr).toString() or something
         //* similar (if needed)
-        // for this solution all execFile call should look like execFile("cmd /U /C", [command to run, arg1, arg2, ...])
-        //* all pathes/commands and each argument must be in quotes becouse if they have
-        //* spaces inside they will broke everything
+        // for this solution all execFile call should look like execFile("cmd", ["/U", "/C", command to run, arg1, arg2, ...])
+        //* all paths/commands and each argument must be in quotes if they contain spaces
 
-        //* assume that user use utf8 compatible terminal
+        //* assume we have a utf8 compatible terminal
         this.execFile(exec, args, opts, execFileCallback.bind(this))
 
         /**
@@ -478,13 +477,13 @@ class PythonFinder {
             (err && err.stack) || err
           )
 
-          // executed script shouldn't pass anythong to stderr if successful
+          // executed script shouldn't pass anything to stderr if successful
           if (err || stderr) {
             reject({ err: err || null, stderr: stderr || null })
           } else {
-            // trim() function remove string endings that break string comparsion
-            const stdoutTrimed = stdout.trim()
-            resolve(stdoutTrimed)
+            // trim() function removes string endings that would break string comparison
+            const stdoutTrimmed = stdout.trim()
+            resolve(stdoutTrimmed)
           }
         }
       }.bind(this)
@@ -509,7 +508,7 @@ class PythonFinder {
     // array of error codes (type of errors) that we handling
     const catchedErrorsCods = ['ENOENT', 9009]
 
-    // dont know type of terminal errors
+    // don't know type of terminal errors
     // @ts-ignore
     if (catchedErrorsCods.includes(err ? err.code : undefined)) {
       // @ts-ignore
@@ -596,7 +595,7 @@ class PythonFinder {
     process.nextTick(
       this.callback.bind(
         null,
-        // if changing error message dont forget also change it test file too
+        // if changing error message don't forget also change it test file too
         new Error('Could not find any Python installation to use')
       )
     )
@@ -606,7 +605,7 @@ class PythonFinder {
 /**
  *
  * @param {string} configPython force setted from terminal or npm config python path
- * @param {(err:Error, found:string)=> void} callback succsed/error callback from where result
+ * @param {(err:Error, found:string)=> void} callback succeed/error callback from where result
  * is available
  */
 function findPython (configPython, callback) {