Add custom params and output log option

Author: ViktorKukurba

README.md

@@ -1,11 +1,11 @@
-# jspython CLI.
+# JSPython CLI.
 
-Command line interface to run [jspython](https://github.com/jspython-dev/jspython) files (*.jspy)
+We provide a command line interface to run [JSPython](https://github.com/jspython-dev/jspython) scripts
 
-### Install
+### Install from NPM
 
 ```
-  npm install -g @jspython-dev/jspython-cli
+  npm install -g jspython-cli
 ```
 
 ### Run in terminal
@@ -16,10 +16,27 @@ Command line interface to run [jspython](https://github.com/jspython-dev/jspytho
 
 ```
 
+### Pass parameters to script
+In CLI
+```
+jspython --file=path/to/jspython/file --param1=value --param
+jspython path/to/jspython/file param1=value param
+```
+In script
+```py
+params("param1") == "value" # true
+params("param") == false # true
+```
+
+### Save evaluate log into file
+```
+jspython --file=path/to/jspython/file.jspy --output=path/to/log.txt
+```
+
 ### Development
-Run example using node. (Works only if you have `@jspython-dev/jspython-cli` devDependencies in you project)
+Run example using node. (Works only if you have build project `npm run build`)
 ```
-node ./bin/jspython --file=examples/project/axios-test.jspy
-node ./bin/jspython --file examples/project/parse.jspy
+node ./bin/jspython --file=../jspython-examples/axios-test.jspy
+node ./bin/jspython --file ../jspython-examples/parse.jspy
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jspython-cli",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "CLI for jspython. Allows you to run jspython (*.jspy) files",
   "main": "src/index.ts",
   "bin": {
@@ -32,9 +32,9 @@
     "jspython-interpreter": "~0.1.3"
   },
   "devDependencies": {
-    "rollup": "^1.27.6",
+    "rollup": "^1.27.13",
     "rollup-plugin-copy": "^3.1.0",
-    "rollup-plugin-typescript2": "^0.25.2",
-    "typescript": "^3.7.2"
+    "rollup-plugin-typescript2": "^0.25.3",
+    "typescript": "^3.7.3"
   }
 }

src/index.ts

@@ -5,7 +5,8 @@ import { httpGet, httpPost, httpDelete, httpPut } from './http';
 
 const pkg = require('../package.json');
 const context: any = {
-  asserts: []
+  asserts: [],
+  params: {}
 }
 export const interpreter: Interpreter = jsPython() as Interpreter;
 interpreter.addFunction('httpGet', httpGet);
@@ -15,9 +16,13 @@ interpreter.addFunction('httpPut', httpPut);
 interpreter.addFunction('assert', (condition: boolean, name?: string, description?: string) => {
   context.asserts.push({ condition, name, description });
 });
-interpreter.addFunction('showAsserts', (condition: boolean, name?: string, description?: string) => {
+interpreter.addFunction('showAsserts', () => {
   console.table(context.asserts);
 });
+interpreter.addFunction('params', (name: string) => {
+  return context.params[name];
+});
+
 run();
 
 async function run() {
@@ -26,11 +31,24 @@ async function run() {
     console.log(`Version:\n${pkg.version}\n`);
   }
 
+  if (options.output) {
+    var util = require('util');
+    var logFile = fs.createWriteStream(options.output, { flags: 'w' });
+    var logStdout = process.stdout;
+
+    console.log = function () {
+      const req = new RegExp('\\x1b\\[\\d\\dm', 'g');
+      logFile.write(util.format.apply(null, Array.from(arguments).map(a => a && a.replace ? a.replace(req, '') : a)) + '\n');
+      logStdout.write(util.format.apply(null, arguments) + '\n');
+    }
+    console.error = console.log;
+  }
+
   if (options.file) {
     interpreter.registerPackagesLoader(packageLoader as PackageLoader);
     const scripts = fs.readFileSync(options.file, 'utf8');
     context.asserts.length = 0;
-    const res = await interpreter.evaluate(scripts, context);
+    const res = await interpreter.evaluate(scripts);
     console.log('Execution result:\n', res);
     console.log('Finish');
   }
@@ -40,16 +58,34 @@ function getOptionsFromArguments(rawArgs: string[]) {
   const args = arg({
     '--file': String,
     '--version': Boolean,
+    '--output': String,
     '-f': '--file',
-    '-v': '--version'
+    '-v': '--version',
+    '-o': '--output'
   }, {
-    argv: rawArgs.slice(2)
+    argv: rawArgs.slice(2),
+    permissive: true
   });
 
-  return {
+  const params = args._.reduce((obj: {[key: string]: any}, a: string) => {
+    const kv = a.replace('--', '');
+    let [key, val]: any = kv.split('=');
+    if (kv === key) {
+      val = true;
+    }
+    obj[key] = val;
+    return obj;
+  }, {});
+
+  const res = {
     file: args['--file'] || (rawArgs.length === 3 && !rawArgs[2].startsWith('-') ? rawArgs[2] : ''),
-    version: args['--version']
+    version: args['--version'],
+    output: args['--output']
   };
+
+  context.params = {...res, ...params};
+
+  return res;
 }
 
 /**@type {PackageLoader} */