test: conformity to formate standard, add docs

now file pass 'npm test' command

add some docs for convenience

Author: owl-from-hogvarts

test/test-find-python-script.js

@@ -1,40 +1,57 @@
-"use strict";
-//@ts-check
+// @ts-check
+'use strict'
+/** @typedef {import("tap")} Tap */
 
-const test = require("tap").test;
-const execFile = require("child_process").execFile;
-const path = require("path");
-const { stderr } = require("process");
+const test = require('tap').test
+const execFile = require('child_process').execFile
+const path = require('path')
 
-require("npmlog").level = "warn";
+require('npmlog').level = 'warn'
 
-//! tests: {path: string, name: string}[]
-//*can use name as short descriptions
-const tests = [{path: process.env.PYTHON, name: "env var PYTHON"}, {path: process.env["python2"], name: "env var python2"}, {path: "python3", name: "env var python3"}];
-const args = [path.resolve("./lib/find-python-script.py")];
+//* can use name as short descriptions
+
+/**
+ * @typedef Check
+ * @property {string} path - path to execurtable or command
+ * @property {string} name - very little description
+ */
+
+/**
+ * @type {Check[]}
+ */
+const checks = [
+  { path: process.env.PYTHON, name: 'env var PYTHON' },
+  { path: process.env.python2, name: 'env var python2' },
+  { path: 'python3', name: 'env var python3' }
+]
+const args = [path.resolve('./lib/find-python-script.py')]
 const options = {
-  windowsHide: true,
-};
+  windowsHide: true
+}
 
 /**
   Getting output from find-python-script.py,
   compare it to path provided to terminal.
   If equale - test pass
 
-  runs for all tests
-
-  //!this must contain t: Test and exec: {path: string, name: string} fields
+  runs for all checks
 
   @private
   @argument {Error} err - exec error
-  @argument {Buffer} stdout - stdout buffer of child process
-  @argument {stderr} stderr
+  @argument {string} stdout - stdout buffer of child process
+  @argument {string} stderr
+  @this {{t, exec: Check}}
  */
-function check(err, stdout, stderr) {
-  let { t, exec } = this;
+function check (err, stdout, stderr) {
+  const { t, exec } = this
   if (!err && !stderr) {
-    t.strictEqual(stdout.trim(), exec.path, `${exec.name}: check path ${exec.path} equals ${stdout.trim()}`);
+    t.strictEqual(
+      stdout.trim(),
+      exec.path,
+      `${exec.name}: check path ${exec.path} equals ${stdout.trim()}`
+    )
   } else {
+    // @ts-ignore
     if (err.code === 9009) {
       t.skip(`skipped: ${exec.name} file not found`)
     } else {
@@ -43,24 +60,24 @@ function check(err, stdout, stderr) {
   }
 }
 
-test("find-python-script", (t) => {
-  t.plan(tests.length);
+test('find-python-script', (t) => {
+  t.plan(checks.length)
 
   // context for check functions
-  let ctx = {
+  const ctx = {
     t: t,
-    exec: {},
-  };
+    exec: {}
+  }
 
-  for (let exec of tests) {
-    //checking if env var exist
+  for (const exec of checks) {
+    // checking if env var exist
     if (!(exec.path === undefined || exec.path === null)) {
-      ctx.exec = exec;
-      //passing ctx as coppied object to make properties immutable from here
-      let boundedCheck = check.bind(Object.assign({}, ctx))
-      execFile(exec.path, args, options, boundedCheck);
+      ctx.exec = exec
+      // passing ctx as coppied object to make properties immutable from here
+      const boundedCheck = check.bind(Object.assign({}, ctx))
+      execFile(exec.path, args, options, boundedCheck)
     } else {
       t.skip(`skipped: ${exec.name} doesn't exist or unavailable`)
     }
   }
-});
+})