Create option debug

.gitignore

@@ -1,6 +1,4 @@
-# Specifies files to intentionally ignore when using Git
-# http://git-scm.com/docs/gitignore
-
+.jshintrc
 node_modules\
 node_modules/
 output\

bin/guide-automator-export.js

@@ -33,7 +33,8 @@ var options = {
 	output: "",
 	html: false,
 	pdf: false,
-	style: 'default'
+	style: 'default',
+	debug: false
 };
 
 function updateHtmlStart() {
@@ -90,6 +91,8 @@ function exportFiles(text, cb) {
 		if (options.pdf)
 			exportPDF(html + html_end);
 	}
+	if (options.debug)
+		console.timeEnd("Guide-Automator");
 }
 
 function exportPDF(html) {
@@ -107,4 +110,4 @@ function exportPDF(html) {
 module.exports = {
 	defineOptions: defineOptions,
 	exportFiles: exportFiles
-};
+};;

bin/guide-automator-function.js

@@ -17,7 +17,8 @@ var GLOBAL = {};
 var options = {
 	output: "",
 	outlineStyle: "solid red 3px",
-	legacy: false
+	legacy: false,
+	debug: false
 };
 
 module.exports = {
@@ -80,15 +81,20 @@ function takeScreenshot(width) {
 	width = width || DEFAULT_IMG_WIDTH;
 	var localImageName = imgCount; //Tratamento devido procedimentos async
 
+	if (options.debug)
+		console.time("Screenshot " + localImageName);
+
 	driver.takeScreenshot().then(
 		function(image, err) {
 			if (err) {
 				throw err;
 			} else {
 				fs.writeFile(options.output + '/' + localImageName + '.png', image, 'base64', function(err) {
-					if (err) {
+					if (err)
 						throw err;
-					}
+
+					if (options.debug)
+						console.timeEnd("Screenshot " + localImageName);
 				});
 			}
 		}
@@ -117,6 +123,9 @@ function takeScreenshotOf(cssSelector, crop, outline, width) {
 	width = width || DEFAULT_IMG_WIDTH;
 	var localImageName = imgCount; //Tratamento devido procedimentos async
 
+	if (options.debug)
+		console.time("ScreenshotOF " + localImageName);
+
 	driver.findElement(By.css(cssSelector)).then(function(el) {
 		if (outline) {
 			driver.executeScript("arguments[0].style.outline = '" + options.outlineStyle + "'", el);
@@ -131,15 +140,19 @@ function takeScreenshotOf(cssSelector, crop, outline, width) {
 						gm(img)
 							.crop(rect.width, rect.height, rect.left, rect.top)
 							.write(options.output + '/' + localImageName + '.png', function(err) {
-								if (err) {
+								if (err)
 									throw err;
-								}
+
+								if (options.debug)
+									console.timeEnd("ScreenshotOF " + localImageName);
 							});
 					} else {
 						fs.writeFile(options.output + '/' + localImageName + '.png', image, 'base64', function(err) {
-							if (err) {
+							if (err)
 								throw err;
-							}
+
+							if (options.debug)
+								console.timeEnd("ScreenshotOF " + localImageName);
 						});
 					}
 				}

bin/guide-automator-parser.js

@@ -1,7 +1,8 @@
 var options = {
 	output: "",
 	outlineStyle: "solid red 3px",
-	legacy: false
+	legacy: false,
+	debug: false
 };
 
 module.exports = {
@@ -182,6 +183,11 @@ function guideAutomatorParser(mdText, cb) {
 					throw err;
 
 				guideAutomator.quit().then(function() {
+					if (options.debug) {
+						console.log("");
+						console.timeEnd('Selenium');
+					}
+
 					return replaceRemainingBlocks(cb);
 				});
 
@@ -190,7 +196,7 @@ function guideAutomatorParser(mdText, cb) {
 	}
 }
 //-- Fim Tratamento dos tokens ou execução de funcionalidades 'automator' ------
-
+//--------------------------------------------------------------------
 //-- Tratamento via javascript
 function replaceBlockWithJsStdout(blockIndex, jsStdout) {
 	var index = 0;
@@ -213,6 +219,12 @@ function extractJavascript(markdownAndCode, cb) {
 }
 
 function executeJavascriptSelenium(markdownText, cb) {
+	if (options.debug) {
+		console.log(`File's JSBlocks: ` + seleniumBlocks.length);
+		console.log("");
+		console.time('Selenium');
+	}
+
 	for (var n_block = 0; n_block < seleniumBlocks.length; n_block++) {
 		guideAutomator.executeExternFunction(seleniumBlocks[n_block]);
 		var jsStdout = guideAutomator.getReturn();

examples/exampleSimple.md

@@ -0,0 +1,12 @@
+# Github - Access
+
+Access [https://github.com](https://github.com).
+
+```javascript
+
+//Access url
+get('https://github.com/');
+
+//Take Screenshot of actual state
+takeScreenshot();
+```

guide-automator.js

@@ -5,6 +5,7 @@
 var themeList = ['lightBlue', 'lightOrange'];
 var fs = require("fs");
 var options = {
+	debug: false,
 	input: "",
 	output: ".",
 	outlineStyle: "solid red 3px",
@@ -50,7 +51,8 @@ program.version(pjson.version)
 	.option('-H, --html', 'Export manual to HTML, default is export for all types', false)
 	.option('-I, --image', `Export ONLY manual's image and ignore others types, default is export for all types`, false)
 	.option('-s, --style <style.css>', 'Css style to be used in the manual or theme [' + themeList.toString() + ']')
-	.option('-L, --legacy', 'Use Legacy mode "<automator>" [DEPRECATED]');
+	.option('-L, --legacy', 'Use Legacy mode "<automator>" [DEPRECATED]')
+	.option('-d, --debug', 'Show progress of code');
 
 program.on('--help', function() {
 	console.log('  Examples:');
@@ -63,11 +65,24 @@ program.on('--help', function() {
 
 program.parse(process.argv);
 
+if (program.debug) {
+	console.log("Version: " + pjson.version);
+	console.log("Options Used.:");
+}
+
 Object.keys(options)
 	.forEach(function(key) {
 		options[key] = program[key] || options[key];
+		if (options.debug)
+			console.log("	" + key + ": " + options[key].toString());
 	});
 
+if (options.debug) {
+	console.log("--------");
+	console.time("Guide-Automator");
+}
+
+
 //if image, others exports type are ignored
 if (options.image)
 	options.pdf = options.html = false;
@@ -109,9 +124,12 @@ processInput(options.input, function(err) {
 
 function processInput(input, cb) {
 	fs.readFile(input, 'utf8', (err, data) => { //Leitura do arquivo
-		if (err) {
+		if (err)
 			return cb(err);
-		}
+
+		if (options.debug)
+			console.log(`File's line: ` + data.split(/\r\n|\r|\n/).length);
+
 		return guideAutomator.guideAutomatorParser(data, function(value, err) {
 			if (err)
 				throw err;

install_linux.sh

@@ -5,7 +5,7 @@ set -e
 is_executable () {
   command -v "$1" >/dev/null 2>&1
 }
-  
+
 errcho () {
   >&2 echo "$@"
 }
@@ -23,15 +23,15 @@ if ! (is_executable npm && is_executable node); then
   else
     errcho "Couldn't install NodeJS. Please install NodeJS manually, then run this script again."
     errcho "Visit https://nodejs.org/en/download/package-manager/ for instructions on how to install NodeJS on your OS."
-    exit 1    
+    exit 1
   fi
   rm setup_6.x
 fi
 
 if ! (is_executable wkhtmltopdf); then
   echo " # Installing Dependencie WKHTMLTOPDF"
   case $( uname -m ) in
-  x86_64) 
+  x86_64)
     wget http://download.gna.org/wkhtmltopdf/0.12/0.12.3/wkhtmltox-0.12.3_linux-generic-amd64.tar.xz -O wkhtmltox.tar.xz;;
   *)
     wget http://download.gna.org/wkhtmltopdf/0.12/0.12.3/wkhtmltox-0.12.3_linux-generic-i386.tar.xz -O wkhtmltox.tar.xz;;
@@ -43,24 +43,25 @@ if ! (is_executable wkhtmltopdf); then
   sudo ln -s ../lib/wkhtmltox/bin/wkhtmltopdf wkhtmltopdf
   cd ~
 fi
-  
+
 if ! (is_executable convert); then
   echo " # Installing Dependencie IMAGEMAGICK"
   sudo apt-get install imagemagick -y
-fi  
+fi
 
 if ! (is_executable chromedriver) ; then
   echo " # Installing Dependencie CHROMEDRIVER"
   case $( uname -m ) in
-  x86_64) 
+  x86_64)
     wget https://chromedriver.storage.googleapis.com/2.25/chromedriver_linux64.zip -O chromedriver.zip;;
   *)
     wget https://chromedriver.storage.googleapis.com/2.25/chromedriver_linux32.zip -O chromedriver.zip;;
   esac
-  
+
   unzip chromedriver.zip
   sudo mv chromedriver /usr/bin/
-  rm chromedriver.zip  
+  rm chromedriver.zip
 fi
 
 sudo npm install -g guide-automator
+echo "$ guide-automator -h , or check https://www.npmjs.com/package/guide-automator"