Merge pull request #140 from jonycheung/renovate/commander-8.x

fix(deps): update dependency commander to v8 and updated tests for CLI

Author: jonycheung

package-lock.json

@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "amdefine": ">= 0.1.0",
-    "commander": "^7.0.0",
+    "commander": "^8.0.0",
     "extend": ">= 2.0.0",
     "global": "^4.3.1",
     "less": "^4.0.0",

package.json

@@ -21,15 +21,15 @@ var sys = require('util')
   , cwd = sh.pwd()
   , data
   , mainFilePath = undefined
-  , cmdr = require('commander')
+  , program = require('commander')
   , packagejson = require('../package.json')
   , events = require('events');
 
 //bypass maxlistener errors because more files means more listeners #90
 events.EventEmitter.defaultMaxListeners = 0;
 
-cmdr
-  .version(packagejson.version)
+program
+  .version(packagejson.version, '-v, -V, --version', 'Output the current version')
   .usage('[options] <source_dir> <destination_dir> [main_file_name]')
   .option('--main-file <file>', "Specify <file> as the file to always re-compile e.g. '--main-file style.less'.")
   .option('--config <file>', 'Custom configuration file path.', 'less-watch-compiler.config.json')
@@ -40,12 +40,12 @@ cmdr
   .option('--source-map', "Less.js Option: To generate source map for css files.")
   .option('--plugins <plugin-a>,<plugin-b>', 'Less.js Option: To specify plugins separated by commas.')
   .option('--less-args <less-arg1>=<less-arg1-value>,<less-arg1>=<less-arg2-value>', 'Less.js Option: To specify any other less options e.g. \'--less-args math=strict,strict-units=on,include-path=.\/dir1\\;.\/dir2\'.')
-  .parse(process.argv);
+  .parse();
 
-const program = cmdr.opts();
+const programOption = program.opts();
 
   // Check if configuration file exists
-  var configPath = program.config ? (path.isAbsolute(program.config))? program.config : (cwd + path.sep + program.config): "less-watch-compiler.config.json";
+  var configPath = programOption.config ? (path.isAbsolute(programOption.config))? programOption.config : (cwd + path.sep + programOption.config): "less-watch-compiler.config.json";
 
   fs.access(configPath, fs.constants.F_OK, (err) => {
     if (!err) {
@@ -59,18 +59,18 @@ const program = cmdr.opts();
 
 
 function init(){
-  if (cmdr.args[0])   lessWatchCompilerUtils.config.watchFolder =  cmdr.args[0];
-  if (cmdr.args[1])   lessWatchCompilerUtils.config.outputFolder =  cmdr.args[1];
-  if (cmdr.args[2])   lessWatchCompilerUtils.config.mainFile =  cmdr.args[2];
-  if (program.mainFile)   lessWatchCompilerUtils.config.mainFile =  program.mainFile;
-  if (program.sourceMap) lessWatchCompilerUtils.config.sourceMap = program.sourceMap;
-  if (program.plugins) lessWatchCompilerUtils.config.plugins = program.plugins;
-  if (program.runOnce) lessWatchCompilerUtils.config.runOnce = program.runOnce;
-  if (program.inludeHidden) lessWatchCompilerUtils.config.includeHidden = program.includeHidden;
-  if (program.enableJs) lessWatchCompilerUtils.config.enableJs = program.enableJs;
-  if (program.lessArgs) lessWatchCompilerUtils.config.lessArgs = program.lessArgs;
-
-  lessWatchCompilerUtils.config = Object.assign({}, lessWatchCompilerUtils.config, cmdr.opts())
+  if (program.args[0])   lessWatchCompilerUtils.config.watchFolder =  program.args[0];
+  if (program.args[1])   lessWatchCompilerUtils.config.outputFolder =  program.args[1];
+  if (program.args[2])   lessWatchCompilerUtils.config.mainFile =  program.args[2];
+  if (programOption.mainFile)   lessWatchCompilerUtils.config.mainFile =  programOption.mainFile;
+  if (programOption.sourceMap) lessWatchCompilerUtils.config.sourceMap = programOption.sourceMap;
+  if (programOption.plugins) lessWatchCompilerUtils.config.plugins = programOption.plugins;
+  if (programOption.runOnce) lessWatchCompilerUtils.config.runOnce = programOption.runOnce;
+  if (programOption.inludeHidden) lessWatchCompilerUtils.config.includeHidden = programOption.includeHidden;
+  if (programOption.enableJs) lessWatchCompilerUtils.config.enableJs = programOption.enableJs;
+  if (programOption.lessArgs) lessWatchCompilerUtils.config.lessArgs = programOption.lessArgs;
+
+  lessWatchCompilerUtils.config = Object.assign({}, lessWatchCompilerUtils.config, program.opts())
 
   /*
     3rd parameter is optional, but once you define it, then we will just compile 

src/less-watch-compiler.js

@@ -0,0 +1,3 @@
+.lvl0{
+    color:black;
+}

tests/examples/with-config/less/test.less

@@ -5,6 +5,6 @@
     "minified": false,
     "sourceMap": false,
     "plugins": "",
-    "watchFolder": "tests/less",
-    "outputFolder": "tests/css"
+    "watchFolder": "tests/examples/with-config/css",
+    "outputFolder": "tests/examples/with-config/css"
 }

tests/less-watch-compiler.config.json

@@ -10,32 +10,56 @@ exec = require("child_process").exec;
 describe("The CLI should", function () {
   describe("run correctly with these options:", function () {
     describe("--run-once parameter", function () {
-      it("exit after once", async () => {
-        let result = await cli(["--run-once", "tests/less", "tests/css"], ".");
-        assert.strictEqual(result.code, 0);
+      it("exit after once", () => {
+        let runCommand = async () => {
+          let result = await cli(
+            ["--run-once", "tests/less", "tests/css"],
+            "."
+          );
+          return result;
+        };
+        runCommand().then((result) => {
+          assert.strictEqual(result.code, 0);
+        });
       });
     });
 
     describe("--config parameter", function () {
-      it("should load a config json", async () => {
-        let result = await cli(
-          ["--config", "tests/less-watch-compiler.config.json"],
-          "."
-        );
-        assert.strictEqual(result.code, 0);
+      const cssDir = cwd + "/tests/examples/with-config/css";
+      it("should load a config json", () => {
+        let runCommand = async () => {
+          let result = await cli(
+            ["--config", "tests/less-watch-compiler.config.json"],
+            "."
+          );
+          return result;
+        };
+
+        runCommand().then((result) => {
+          assert.strictEqual(result.code, 0);
+
+          const contents = fs.readFileSync(cssDir + "/test.css");
+          const contentsExpected = fs.readFileSync(
+            cssDir + "/test.expected.css"
+          );
+
+          assert.ok(contents.equals(contentsExpected));
+
+          fs.rmSync(cssDir + "/test.css", { force: true });
+        });
       });
     });
 
     describe("--include-hidden parameter", function () {
       const lessDir = cwd + "/tests/examples/with-hidden-variables-file/less";
       const cssDir = cwd + "/tests/examples/with-hidden-variables-file/css";
-      it("should compile hidden files when parameter is specified", async () => {
-        let result = await cli(
-          ["--include-hidden"],
-          lessDir,
-          cssDir
-        )
-        setTimeout(function (){
+      it("should compile hidden files when parameter is specified", () => {
+        let runCommand = async () => {
+          let result = await cli(["--include-hidden"], lessDir, cssDir);
+          return result;
+        };
+
+        runCommand().then((result) => {
           assert.strictEqual(result.code, 0);
 
           const contents = fs.readFileSync(cssDir + "/main.css");
@@ -44,29 +68,31 @@ describe("The CLI should", function () {
           assert.ok(contents.equals(contentsExpected));
 
           fs.rmSync(cssDir + "/main.css", { force: true });
-
-          },200);
+        });
       });
 
-      it("should not compile the hidden variables files when flag not specified", async () => {
+      it("should not compile the hidden variables files when flag not specified", () => {
         const compiledVariablesPath = cssDir + "/_variables.css";
         const compiledOtherVariablesPath = cssDir + "/.other-variables.css";
 
         // Make sure we don't detect compiled variables files left over from other runs
         fs.rmSync(compiledVariablesPath, { force: true });
         fs.rmSync(compiledOtherVariablesPath, { force: true });
 
-        let result = await cli([], lessDir, cssDir);
+        let runCommand = async () => {
+          let result = await cli([], lessDir, cssDir);
+          return result;
+        };
 
-        setTimeout(function () {
+        runCommand().then((result) => {
           assert.strictEqual(result.code, 0);
 
           const variablesFilesWereNotCompiled =
             !fs.existsSync(compiledVariablesPath) &&
             !fs.existsSync(compiledOtherVariablesPath);
 
           assert.ok(variablesFilesWereNotCompiled);
-        }, 200);
+        });
       });
     });
   });

tests/less-watch-compiler.js

@@ -995,10 +995,10 @@
   "resolved" "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz"
   "version" "2.20.3"
 
-"commander@^7.0.0":
-  "integrity" "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw=="
-  "resolved" "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz"
-  "version" "7.2.0"
+"commander@^8.0.0":
+  "integrity" "sha512-Xvf85aAtu6v22+E5hfVoLHqyul/jyxh91zvqk/ioJTQuJR7Z78n7H558vMPKanPSRgIEeZemT92I2g9Y8LPbSQ=="
+  "resolved" "https://registry.npmjs.org/commander/-/commander-8.0.0.tgz"
+  "version" "8.0.0"
 
 "commitizen@^4.0.3":
   "integrity" "sha512-LlZChbDzg3Ir3O2S7jSo/cgWp5/QwylQVr59K4xayVq8S4/RdKzSyJkghAiZZHfhh5t4pxunUoyeg0ml1q/7aw=="