https://github.com/kaizhu256/node-electron-prebuilt-lite
lightweight version of electron-prebuilt with zero npm-dependencies
https://github.com/kaizhu256/node-electron-prebuilt-lite
Last synced: about 2 months ago
JSON representation
lightweight version of electron-prebuilt with zero npm-dependencies
- Host: GitHub
- URL: https://github.com/kaizhu256/node-electron-prebuilt-lite
- Owner: kaizhu256
- Created: 2015-11-19T09:19:53.000Z (over 9 years ago)
- Default Branch: beta
- Last Pushed: 2015-11-24T07:08:50.000Z (over 9 years ago)
- Last Synced: 2025-01-17T14:52:19.997Z (3 months ago)
- Language: Shell
- Size: 356 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
electron-prebuilt-lite is now DEPRECATED
==============
this package has been renamed [electron-lite](https://www.npmjs.com/package/electron-lite)
[](https://www.npmjs.org/package/electron-prebuilt-lite) [](https://www.npmjs.org/package/electron-prebuilt-lite)
# screen-capture
[](https://kaizhu256.github.io/node-electron-prebuilt-lite/build/screen-capture.testExampleJs.browser.png)
# build-status [](https://travis-ci.org/kaizhu256/node-electron-prebuilt-lite)
| git-branch : | [master](https://github.com/kaizhu256/node-electron-prebuilt-lite/tree/master) | [beta](https://github.com/kaizhu256/node-electron-prebuilt-lite/tree/beta) | [alpha](https://github.com/kaizhu256/node-electron-prebuilt-lite/tree/alpha)|
|--:|:--|:--|:--|
| build-artifacts : | [](https://github.com/kaizhu256/node-electron-prebuilt-lite/tree/gh-pages/build..master..travis-ci.org) | [](https://github.com/kaizhu256/node-electron-prebuilt-lite/tree/gh-pages/build..beta..travis-ci.org) | [](https://github.com/kaizhu256/node-electron-prebuilt-lite/tree/gh-pages/build..alpha..travis-ci.org)|
#### master branch
- stable branch
- HEAD should be tagged, npm-published package
#### beta branch
- semi-stable branch
- HEAD should be latest, npm-published package
#### alpha branch
- unstable branch
- HEAD is arbitrary
- commit history may be rewritten
# documentation
#### this package requires
- darwin or linux os
- unzip installed on os
#### this package will
- dynamically download and install electron @ 0.35.1 from https://github.com/atom/electron/releases
# quickstart screen-capture example
#### to run this example, follow the instruction in the script below
- example.js
```javascript
/*
example.js
this electron script will screen-capture http://electron.atom.io/
instruction
1. save this js script as example.js
2. run the shell command:
$ npm install electron-prebuilt-lite && \
printf '{"main":"example.js","name":"example","version":"0.0.0"}' > \
package.json && \
./node_modules/.bin/electron . --disable-overlay-scrollbar --enable-logging
3. view screencapture ./screen-capture.testExampleJs.browser.png
*/
/*jslint
browser: true,
maxerr: 8,
maxlen: 96,
node: true,
stupid: true
*/
(function () {
'use strict';
var options, modeNext, onNext;
modeNext = 0;
onNext = function (data) {
modeNext += 1;
switch (modeNext) {
case 1:
// wait for electron to init
require('app').once('ready', onNext);
break;
case 2:
// init options
options = { frame: false, height: 768, width: 1024, x: 0, y: 0 };
// init browserWindow;
options.BrowserWindow = require('browser-window');
options.browserWindow = new options.BrowserWindow(options);
// goto next step when webpage is loaded
options.browserWindow.webContents.once('did-stop-loading', onNext);
// open url
options.browserWindow.loadURL('http://electron.atom.io/');
break;
case 3:
// screen-capture webpage
options.browserWindow.capturePage(options, onNext);
break;
case 4:
// save screen-capture
require('fs')
.writeFileSync('screen-capture.testExampleJs.browser.png', data.toPng());
// exit
process.exit(0);
break;
}
};
onNext();
}());
```
#### output from shell
[](https://travis-ci.org/kaizhu256/node-electron-prebuilt-lite)
#### output from electron
[](https://kaizhu256.github.io/node-electron-prebuilt-lite/build/screen-capture.electron.png)
# npm-dependencies
- none
# package-listing
[](https://github.com/kaizhu256/node-electron-prebuilt-lite)
# package.json
```json
{
"author": "kai zhu ",
"bin": {
"electron-prebuilt-lite" : "index.js",
"electron" : "external/electron"
},
"description": "lightweight version of electron-prebuilt with zero npm-dependencies",
"devDependencies": {
"utility2": "2015.11.4"
},
"keywords": [
"atom", "atom-shell",
"browser",
"capture",
"electron", "electron-prebuilt",
"headless", "headless-browser",
"scrape", "scraper", "screen", "screen-capture", "screencapture", "screenshot",
"web", "web-scrape", "web-scraper"
],
"license": "MIT",
"name": "electron-prebuilt-lite",
"os": ["darwin", "linux"],
"repository" : {
"type" : "git",
"url" : "https://github.com/kaizhu256/node-electron-prebuilt-lite.git"
},
"scripts": {
"build-ci": "node_modules/.bin/utility2 shRun shReadmeBuild",
"postinstall": "./index.sh shNpmPostinstall",
"preinstall": "mkdir -p external && touch external/electron",
"test": "node_modules/.bin/utility2 shRun shReadmeExportPackageJson && \
rm -fr external && \
npm run-script postinstall && \
./external/electron --version || exit $?;"
},
"version": "2015.10.5"
}
```
# todo
- none
# change since 13339ae0
- npm publish 2015.10.5
- deprecate this package
- none
# changelog of last 50 commits
[](https://github.com/kaizhu256/node-electron-prebuilt-lite/commits)
# internal build-script
- build.sh
```shell
# build.sh
# this shell script will run the build for this package
shBuild() {
# this function will run the main build
# init env
. node_modules/.bin/utility2 && shInit || return $?
# run npm-test on published package
shRun shNpmTestPublished || return $?
# test example js script
MODE_BUILD=testExampleJs MODE_LINENO=0 shRunScreenCapture \
shReadmeTestJs example.js || return $?
# save screen-capture
cp /tmp/app/screen-capture.*.png $npm_config_dir_build || return $?
# run npm-test
MODE_BUILD=npmTest shRunScreenCapture npm test || return $?
}
shBuild
# save exit-code
EXIT_CODE=$?
# create package-listing
MODE_BUILD=gitLsTree shRunScreenCapture shGitLsTree || exit $?
# create recent changelog of last 50 commits
MODE_BUILD=gitLog shRunScreenCapture git log -50 --pretty="%ai\u000a%B" || exit $?
# upload build-artifacts to github, and if number of commits > 16, then squash older commits
COMMIT_LIMIT=16 shBuildGithubUpload || exit $?
exit $EXIT_CODE
```