@wixc3/engine-electron
Advanced tools
Comparing version 10.0.5 to 22.2.0
{ | ||
"name": "@wixc3/engine-electron", | ||
"version": "10.0.5", | ||
"version": "22.2.0", | ||
"main": "dist/index.js", | ||
@@ -9,5 +9,4 @@ "peerDependencies": { | ||
"dependencies": { | ||
"@wixc3/engine-core": "^22.1.1", | ||
"@wixc3/engine-electron-commons": "^10.0.5", | ||
"@wixc3/engine-runtime-node": "^22.1.2" | ||
"@wixc3/engine-core": "^22.2.0", | ||
"@wixc3/engine-electron-commons": "^22.2.0" | ||
}, | ||
@@ -24,4 +23,4 @@ "files": [ | ||
"author": "Wix.com", | ||
"repository": "https://github.com/wixplosives/engine-electron/tree/master/packages/electron", | ||
"homepage": "https://github.com/wixplosives/engine-electron" | ||
"repository": "https://github.com/wixplosives/engine/tree/master/packages/electron", | ||
"homepage": "https://github.com/wixplosives/engine" | ||
} |
# @wixc3/engine-electron | ||
This is a cli tool, as well as a library which allows running [engine](https://github.com/wixplosives/engine) applications in electron. | ||
To run first install this package as a dependency | ||
`npm i @wixc3/engine-electron` | ||
Then, to run your application in electron just run | ||
`npx engine-electron start -f <my feature> -e <electron host environment>` | ||
If you want to build your application as an electron application just run | ||
`npx engine-electron build -f <my feature> -e <electron host environment>` | ||
This will create a "build" folder, in which the packed electron application will be located at | ||
## Start | ||
| Argument | Alias | Description | Is mandatory | Default value | | ||
| ------------- | ----- | ---------------------------------------------------------------- | ------------ | --------------- | | ||
| --featureName | -f | The feature you want to run | Yes | | ||
| --configName | -c | the name of the config you want your application to run with | No | | ||
| --envName | -e | The name of the environment running in the electron-main process | Yes | | ||
| --basePath | | The path which is where to search the feature at | No | `process.cwd()` | | ||
| --devtools | | whether should open the browser window with devtools | No | `false` | | ||
## Build | ||
| Argument | Alias | Description | Is mandatory | Default value | | ||
| ------------------------------- | ----- | ------------------------------------------------------------------------------------------- | ------------ | --------------------- | | ||
| --featureName | -f | The feature you want to run | Yes | | ||
| --configName | -c | the name of the config you want your application to run with | No | | ||
| --envName | -e | The name of the environment running in the electron-main process | Yes | | ||
| --basePath | | The path which is where to search the feature at | No | `process.cwd()` | | ||
| --tsConfigPath | | Relative path to the tsconfig file with which the features should be built with | No | `tsconfig.json` | | ||
| --outDir | | the directory to which the bundled and transpiled code will be saved (relative to basePath) | No | `dist` | | ||
| --electronBuilderConfigFileName | | The name of the electrion builder config file (relative to basePath) | No | `electron-build.json` | |
Sorry, the diff of this file is not supported yet
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
3
0
14242
2
+ Added@wixc3/engine-electron-commons@22.4.1(transitive)
+ Added@wixc3/resolve-directory-context@1.0.4(transitive)
+ Addedbalanced-match@1.0.2(transitive)
+ Addedbrace-expansion@1.1.11(transitive)
+ Addedconcat-map@0.0.1(transitive)
+ Addedfs.realpath@1.0.0(transitive)
+ Addedglob@7.2.3(transitive)
+ Addedinflight@1.0.6(transitive)
+ Addedminimatch@3.1.2(transitive)
+ Addedpath-is-absolute@1.0.1(transitive)
+ Addedtype-fest@2.19.0(transitive)
- Removed@wixc3/engine-runtime-node@^22.1.2
- Removed@wixc3/engine-electron-commons@10.0.5(transitive)
Updated@wixc3/engine-core@^22.2.0