Merge pull request #19 from q-masters/development

v1.2.0

Author: TsMonkeyPatch

README.md

@@ -26,15 +26,22 @@ Furthermore, javascript files can now be started directly via vscode in electron
 
 ## Usage
 
-This is more designed as a service, that means you can install electron but it will not help alot. These is an example how this could be used inside your extension @see [Vscode-Electron-Demo](https://github.com/q-masters/vscode-electron-demo) how this could be used inside an extension.
+This is more designed as a service, that means you can install electron but it will not help alot. These is an example how this could be used inside your extension @see [Vscode-Electron-Demo](https://github.com/q-masters/vscode-electron-demo) and [Run Electron Command](https://github.com/q-masters/vscode-electron-demo/blob/566f8addc5844df651de5100f99ce08116fba1bb/src/lib/extension/commands/open-uri.ts#L16) how this could be used inside an extension.
+
+## API 
+
+CommandParams
+
+```ts
+type EventParams = ...string[] | { version: string, args: string[] }
+```
 
 ## Commands
 
-|name|params|type|description|
+|name|params|return value|description|
 |-|-|-|-|
-|qmasters:electron.install|-|void|checks for a valid installation and install electron is nothing exists|
-|qmasters:electron.run|string, \[...string\[\]\]|ChildProcess|filepath which should executed [@example](https://github.com/electron/electron-quick-start/blob/master/main.js), additional params which should passed to electron app|
-
+|qmasters:electron.install|[version:string]|boolean| install passed version of electron for example v11.2.0. Default latest version which can found for electron|
+|qmasters:electron.run|EventParams|ChildProcess| starts electron app in specific version, all arguments passed as **...string[]** will directly passed to electron as command line arguments. Alternate to use a specific version use **{ version: string, args: string[]}** for example **{ version: "v11.2.0", args: ["file_to_execute.js", "second param"]}**. It will allways check the version which should be used is installed, if not it will install directly. If no version is passed it will take allways the latest version and install if required.| 
 ## Development
 
 - go into src directory

src/README.md

@@ -26,15 +26,22 @@ Furthermore, javascript files can now be started directly via vscode in electron
 
 ## Usage
 
-This is more designed as a service, that means you can install electron but it will not help alot. These is an example how this could be used inside your extension @see [Vscode-Electron-Demo](https://github.com/q-masters/vscode-electron-demo) how this could be used inside an extension.
+This is more designed as a service, that means you can install electron but it will not help alot. These is an example how this could be used inside your extension @see [Vscode-Electron-Demo](https://github.com/q-masters/vscode-electron-demo) and [Run Electron Command](https://github.com/q-masters/vscode-electron-demo/blob/566f8addc5844df651de5100f99ce08116fba1bb/src/lib/extension/commands/open-uri.ts#L16) how this could be used inside an extension.
+
+## API 
+
+CommandParams
+
+```ts
+type EventParams = ...string[] | { version: string, args: string[] }
+```
 
 ## Commands
 
-|name|params|type|description|
+|name|params|return value|description|
 |-|-|-|-|
-|qmasters:electron.install|-|void|checks for a valid installation and install electron is nothing exists|
-|qmasters:electron.run|string, \[...string\[\]\]|ChildProcess|filepath which should executed [@example](https://github.com/electron/electron-quick-start/blob/master/main.js), additional params which should passed to electron app|
-
+|qmasters:electron.install|[version:string]|boolean| install passed version of electron for example v11.2.0. Default latest version which can found for electron|
+|qmasters:electron.run|EventParams|ChildProcess| starts electron app in specific version, all arguments passed as **...string[]** will directly passed to electron as command line arguments. Alternate to use a specific version use **{ version: string, args: string[]}** for example **{ version: "v11.2.0", args: ["file_to_execute.js", "second param"]}**. It will allways check the version which should be used is installed, if not it will install directly. If no version is passed it will take allways the latest version and install if required.| 
 ## Development
 
 - go into src directory

src/lib/api.ts

@@ -2,5 +2,8 @@ import { InjectionToken } from "tsyringe";
 import * as vscode from "vscode";
 
 export const ELECTRON_INSTALL_PATH: InjectionToken<string> = Symbol(`electron download path`)
-export const ELECTRON_VERSION: InjectionToken<string> = Symbol(`electron version`)
 export const OUTPUT_CHANNEL: InjectionToken<vscode.OutputChannel> = Symbol(`Output channel`)
+export const ELECTRON_ENV_VARS: InjectionToken<any> = Symbol(`Environment variables for spawn`)
+
+export declare type DATA_NODE = {[key: string]:string}
+export declare type EventParams = string[] | { version: string, args: string[] }