From a61d0380f82d21ceef166750f1fd75a246034c7e Mon Sep 17 00:00:00 2001 From: Sven Slootweg Date: Sun, 17 Apr 2016 19:54:22 +0200 Subject: [PATCH] Initial commit --- .gitignore | 3 ++- .npmignore | 1 + README.md | 21 ++++++++++++++++++++ gulpfile.js | 18 +++++++++++++++++ index.js | 3 +++ package.json | 34 +++++++++++++++++++++++++++++++ src/get-project-root.js | 14 +++++++++++++ src/index.js | 44 +++++++++++++++++++++++++++++++++++++++++ 8 files changed, 137 insertions(+), 1 deletion(-) create mode 100644 .npmignore create mode 100644 README.md create mode 100644 gulpfile.js create mode 100644 index.js create mode 100644 package.json create mode 100644 src/get-project-root.js create mode 100644 src/index.js diff --git a/.gitignore b/.gitignore index d3f11de..bdaa3f7 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,5 @@ # https://help.github.com/articles/ignoring-files # Example .gitignore files: https://github.com/github/gitignore /bower_components/ -/node_modules/ \ No newline at end of file +/node_modules/ +/lib/ diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..096746c --- /dev/null +++ b/.npmignore @@ -0,0 +1 @@ +/node_modules/ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..05292ad --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# gulp-partial-electron + +A wrapper module for managing an Electron process. Used in my Gulp presets. + +## License + +[WTFPL](http://www.wtfpl.net/txt/copying/) or [CC0](https://creativecommons.org/publicdomain/zero/1.0/), whichever you prefer. A donation and/or attribution are appreciated, but not required. + +## Donate + +My income consists largely of donations for my projects. If this module is useful to you, consider [making a donation](http://cryto.net/~joepie91/donate.html)! + +You can donate using Bitcoin, PayPal, Flattr, cash-in-mail, SEPA transfers, and pretty much anything else. + +## Contributing + +Pull requests welcome. Please make sure your modifications are in line with the overall code style, and ensure that you're editing the files in `src/`, not those in `lib/`. + +Build tool of choice is `gulp`; simply run `gulp` while developing, and it will watch for changes. + +Be aware that by making a pull request, you agree to release your modifications under the licenses stated above. diff --git a/gulpfile.js b/gulpfile.js new file mode 100644 index 0000000..1769501 --- /dev/null +++ b/gulpfile.js @@ -0,0 +1,18 @@ +var gulp = require("gulp"); +var presetES2015 = require("@joepie91/gulp-preset-es2015"); + +var source = ["src/**/*.js"] + +gulp.task('babel', function() { + return gulp.src(source) + .pipe(presetES2015({ + basePath: __dirname + })) + .pipe(gulp.dest("lib/")); +}); + +gulp.task("watch", function () { + gulp.watch(source, ["babel"]); +}); + +gulp.task("default", ["babel", "watch"]); \ No newline at end of file diff --git a/index.js b/index.js new file mode 100644 index 0000000..507257b --- /dev/null +++ b/index.js @@ -0,0 +1,3 @@ +'use strict'; + +module.exports = require("./lib"); \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..b79144c --- /dev/null +++ b/package.json @@ -0,0 +1,34 @@ +{ + "name": "@joepie91/gulp-partial-electron", + "version": "1.0.0", + "description": "A wrapper module for managing an Electron process", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "http://git.cryto.net/joepie91/node-gulp-partial-electron.git" + }, + "keywords": [ + "gulp", + "partial", + "logging", + "livereload" + ], + "author": "Sven Slootweg", + "license": "WTFPL", + "dependencies": { + "@joepie91/gulp-partial-run-process": "^1.0.0", + "default-value": "0.0.2", + "find-root-package": "0.0.1", + "get-project-root": "0.0.5", + "gulp-named-log": "0.0.3", + "xtend": "^4.0.1" + }, + "devDependencies": { + "@joepie91/gulp-preset-es2015": "^1.0.1", + "babel-preset-es2015": "^6.6.0", + "gulp": "^3.9.1" + } +} diff --git a/src/get-project-root.js b/src/get-project-root.js new file mode 100644 index 0000000..a75bd8f --- /dev/null +++ b/src/get-project-root.js @@ -0,0 +1,14 @@ +'use strict'; + +const path = require("path"); +const getProjectRoot = require("get-project-root"); + +let projectRoot; + +module.exports = function () { + if (projectRoot == null) { + projectRoot = getProjectRoot(); + } + + return projectRoot; +} \ No newline at end of file diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000..a52d9f3 --- /dev/null +++ b/src/index.js @@ -0,0 +1,44 @@ +'use strict'; + +const path = require("path"); +const xtend = require("xtend"); +const runProcess = require("@joepie91/gulp-partial-run-process"); +const namedLog = require("gulp-named-log"); +const defaultValue = require("default-value"); + +const getProjectRoot = require("./get-project-root"); + +module.exports = function(options = {}) { + let electronLogger = namedLog("electron"); + let processArguments = [projectRoot]; + + let environmentVariables = xtend(process.env, { + NODE_ENV: "development" + }); + + let electronBinary = defaultValue(options.electronBinary, () => { + return path.join(getProjectRoot(), "node_modules", ".bin", "electron"); + }, {evaluate: true}); + + let projectRoot = defaultValue(options.projectRoot, () => { + return getProjectRoot(); + }, {evaluate: true}); + + if (options.arguments != null && Array.isArray(options.arguments)) { + processArguments = options.arguments.concat(processArguments); + } + + if (options.environmentVariables != null) { + environmentVariables = xtend(environmentVariables, options.environmentVariables); + } + + var electronProcess = runProcess(electronBinary, processArguments, { + logger: electronLogger, + env: environmentVariables + }); + + return { + kill: electronProcess.kill.bind(electronProcess), + pid: electronProcess.pid + } +} \ No newline at end of file