Merge pull request #438 from jansule/quiet-mode

Quiet mode

Author: jansule

README.md

@@ -85,7 +85,7 @@ geostyler-cli -s qml -t sld -o point_simple.sld testdata/point_simple.qml
 To convert all files in a directory:
 
 ```bash
-geostyler-cli [options] -t qgis -o /path/to/output /path/to/input/
+geostyler-cli [options] -t qgis -o /path/to/output /path/to/input/ [--quiet]
 # example
 geostyler-cli -s sld -t qgis -o ./output-sld testdata/sld
 ```
@@ -117,6 +117,7 @@ If not given, it will be guessed from the extension of the output file.
 Mapfiles are not currently supported as target.
 Mandatory if the the target is a directory.
 * `-v` / `--version` Display the version of the program.
+* `--quiet` Suppress all interactive output.
 
 ## Developing
 

src/index.ts

@@ -162,14 +162,11 @@ function handleResult(result: ReadStyleResult | WriteStyleResult, parser: StyleP
     throw errors;
   }
   if (warnings) {
-    // eslint-disable-next-line no-console
-    warnings.map(console.warn);
+    warnings.map((warning) => process.stderr.write(warning));
   }
   if (unsupportedProperties) {
-    // eslint-disable-next-line no-console
-    console.log(`${stage} parser ${parser.title} does not support the following properties:`);
-    // eslint-disable-next-line no-console
-    console.log(unsupportedProperties);
+    process.stderr.write(`${stage} parser ${parser.title} does not support the following properties:\n`);
+    process.stderr.write(JSON.stringify(unsupportedProperties));
   }
   return output;
 }
@@ -224,8 +221,7 @@ async function writeFile(
       indicator.succeed(`File "${sourceFile}" translated successfully. Output written to ${targetFile}`);
     } else {
       indicator.succeed(`File "${sourceFile}" translated successfully. Output written to stdout:\n`);
-      // eslint-disable-next-line no-console
-      console.log(finalOutput);
+      process.stdout.write(finalOutput);
     }
     return 0;
   } catch (error) {
@@ -248,7 +244,8 @@ async function main() {
     help,
     v,
     version,
-    _: unnamedArgs
+    quiet,
+    _: unnamedArgs,
   } = args;
 
   if (h || help) {
@@ -268,7 +265,10 @@ async function main() {
   const outputPath: string = o || output;
 
   // Instantiate progress indicator
-  const indicator = ora({ text: 'Starting Geostyler CLI' }).start();
+  const indicator = ora({
+    text: 'Starting Geostyler CLI',
+    isSilent: !!quiet || false,
+  }).start();
 
   // Check source path arg.
   if (!sourcePath) {

src/logHelper.ts

@@ -1,7 +1,7 @@
 import gradient from 'gradient-string';
 import version from './version';
 
-export const logTitle = () :void => {
+export const logTitle = () => {
   console.log(gradient('#611E82', '#272C82', '#00943D', '#FFED00', '#F48E00', '#E7000E').multiline(`
   ██████╗  ███████╗ ██████╗ ███████╗████████╗██╗   ██╗██╗     ███████╗██████╗
   ██╔════╝ ██╔════╝██╔═══██╗██╔════╝╚══██╔══╝╚██╗ ██╔╝██║     ██╔════╝██╔══██╗
@@ -16,8 +16,8 @@ export const logHelp = () :void => {
   logTitle();
   console.log(`
   Basic syntax:
-    npx geostyler-cli [options] [input_file | [input_directory]]
-    geostyler-cli [options] [input_file | input_directory]
+    npx geostyler-cli [options] [input_file | [input_directory]] [--quiet]
+    geostyler-cli [options] [input_file | input_directory] [--quiet]
 
   Example:
     npx geostyler-cli -s sld -t qgis -o output.qml [YOUR_SLD.sld]
@@ -40,9 +40,10 @@ export const logHelp = () :void => {
                     Mandatory if the the target is a directory.
     --from-stdin  : Read input from stdin. If this option is set, the input file is ignored.
     -v / --version: Display the version of the program.
+    --quiet       : Suppress all interactive output.
   `);
 };
 
-export const logVersion = () : void => {
+export const logVersion = () => {
   console.log(`v${version}`);
 };

test.js

@@ -19,11 +19,13 @@ function runTest(args, outputFile) {
   console.log(`Status: ${result.status.toString()}`);
   console.log(`Output: ${result.stdout.toString()}`);
   console.log(`Error: ${result.stderr.toString()}`);
+  return result;
 }
 
 function runAllTests() {
 
   let success = true;
+  let testResult;
 
   // test sld to qgis
   let outputFile = 'output.qml';
@@ -82,6 +84,39 @@ function runAllTests() {
     success = false;
   }
 
+  // test writing only styles to stdout
+  args = ['start', '--', '-s', 'sld', '-t', 'sld', 'testdata/sld/point_simplepoint.sld'];
+  testResult = runTest(args, outputFile);
+
+  const stdout = testResult.stdout.toString();
+  // We have to remove the first 4 lines of the output
+  // since we are running the tests via npm test which
+  // adds the command itself to stdout.
+  const cleanedStdout = stdout.split('\n').slice(4).join('\n');
+  console.log(`stdout: ${cleanedStdout}`);
+  if (!cleanedStdout.startsWith('<?xml version="1.0" encoding="UTF-8" standalone="yes"?>')) {
+    console.log('Expected SLD output not found in stdout');
+    success = false;
+  }
+
+  // test writing everything else to stderr
+  args = ['start', '--', '-s', 'sld', '-t', 'sld', 'testdata/sld/point_simplepoint.sld'];
+  testResult = runTest(args, outputFile);
+
+  if (!testResult.stderr.toString().includes('translated successfully')) {
+    console.log('Expected translation success message not found in stderr');
+    success = false;
+  }
+
+  // test not writing interactive messages in quiet mode
+  args = ['start', '--', '-s', 'sld', '-t', 'sld', 'testdata/sld/point_simplepoint.sld', '--quiet'];
+  testResult = runTest(args, outputFile);
+
+  if (testResult.stderr.toString().includes('translated successfully')) {
+    console.log('Expected no interactive messages in quiet mode');
+    success = false;
+  }
+
   return success;
 }