sindresorhus / generator-electron

Scaffold out an Electron app boilerplate

generator-electron

Scaffold out an Electron app

See awesome-electron for more useful Electron resources.

See Caprine for a production app based on this boilerplate.

Features

• electron-builder fully set up to create cross-platform builds
• Builds the app on Travis
• Silent auto-updates
• App menu that adheres to the system user interface guidelines
• Config handling
• Context menu
• User-friendly handling of unhandled errors
• Easily publish new versions to GitHub Releases
• And much more!

Install

$ npm install --global yo generator-electron

Usage

With yo:

$ yo electron

Related

• electron-boilerplate - Electron app boilerplate

generator-electron's Issues

ES6 support

Just wondering where in the generator does it add the ES6 support or if it just comes natively in Electron?

Empty Website URL Remain Unchecked

I wrongly pressed Enter when asked for website URL, and the generator crashed. Would it be like asking for GitHub usernames, which warns user of the empty value?

? What is the URL of your website?

/usr/local/lib/node_modules/yo/node_modules/rx/dist/rx.js:77
    throw e;
    ^

Error: Invalid URL
    at module.exports (/usr/local/lib/node_modules/generator-electron/node_modules/normalize-url/index.js:56:9)
    at Object.prompt.filter (/usr/local/lib/node_modules/generator-electron/app/index.js:34:12)
    at /usr/local/lib/node_modules/yo/node_modules/yeoman-environment/node_modules/run-async/index.js:26:25
    at /usr/local/lib/node_modules/yo/node_modules/yeoman-environment/node_modules/run-async/index.js:25:19
    at /usr/local/lib/node_modules/yo/node_modules/yeoman-environment/node_modules/inquirer/lib/prompts/base.js:88:12
    at tryCatcher (/usr/local/lib/node_modules/yo/node_modules/rx/dist/rx.js:63:31)
    at InnerObserver.Rx.FlatMapObservable.InnerObserver.next (/usr/local/lib/node_modules/yo/node_modules/rx/dist/rx.js:2140:43)
    at InnerObserver.Rx.internals.AbstractObserver.AbstractObserver.onNext (/usr/local/lib/node_modules/yo/node_modules/rx/dist/rx.js:1762:31)
    at InnerObserver.tryCatcher (/usr/local/lib/node_modules/yo/node_modules/rx/dist/rx.js:63:31)
    at AutoDetachObserverPrototype.next (/usr/local/lib/node_modules/yo/node_modules/rx/dist/rx.js:5883:51)

No .gitignore file is created by generator

I see that there is a gitignore file in the source for this project, but one is not created when the yo generator is run.

yo: command not found

When i installed generator-electron and run command yo electron i bash says:

yo: command not found

Why is website required?

It's only used in three places: package.json, license, and readme.md.

These locations could easily be edited in by the user later, if they don't want to immediately provide a website url.

Default `build` command ignores all files with "dist" in their path

Spent some hours debugging a problem with my build. The problem turned out to be with gulp-vinyl-zip, caused by this package having a folder named "dist". Some of the files in the library were ignored.

ENOENT: no such file or directory, scandir '[...]\editorconfig'

Hi. I tried to use this generator today but the process fails on Windows 11, Node 18.12.1

Integrate watching files plugin

It would be great to integrate chokidar to watch files and automatically restart an electron app on any changes. So, we don't need to manually restart the app while developing it.

Fatal error: Unable to parse version string

Fatal error: Unable to parse version string when packaging app for platform win32 ia32 using electron on Windows 10. And I find the problem occurs in the package.json

"scripts": {
"test": "xo",
"start": "electron .",
"build": "electron-packager . --out=dist --app-version=$npm_package_version --prune --asar --overwrite --all"
},

the generator-electron should use %npm_package_version% instead of $npm_package_version in windows

Use the new `fs` method for doing the file copying

http://yeoman.io/blog/release-0.18.html

Help welcome :)

Run `npm install` at end of generation process

Are you against that ?

Use globbing for the `fs` methods

generator-electron/app/index.js

Lines 48 to 58 in 7fcfd9f

	this.fs.copy(this.templatePath('editorconfig'), this.destinationPath('.editorconfig'));
	this.fs.copy(this.templatePath('gitattributes'), this.destinationPath('.gitattributes'));
	this.fs.copy(this.templatePath('gitignore'), this.destinationPath('.gitignore'));
	this.fs.copy(this.templatePath('jshintrc'), this.destinationPath('.jshintrc'));
	this.fs.copy(this.templatePath('index.js'), this.destinationPath('index.js'));
	this.fs.copy(this.templatePath('index.html'), this.destinationPath('index.html'));
	this.fs.copy(this.templatePath('index.css'), this.destinationPath('index.css'));
	this.fs.copyTpl(this.templatePath('license'), this.destinationPath('license'), tmpl);
	// needed so npm doesn't try to use it and fail
	this.fs.copyTpl(this.templatePath('_package.json'), this.destinationPath('package.json'), tmpl);
	this.fs.copyTpl(this.templatePath('readme.md'), this.destinationPath('readme.md'), tmpl);

Question: auto deploy on electron-boilerplate

Hi @sindresorhus

Do you have a script or process to commit/push on electron-boilerplate foreach success Travis build on master branch ?

Or you do that manually ?

Cannot generate projects with Nodist

Hi,

When trying to install the generator and run it, some issues are popping.

It seems the Nodist usage is not compatible. It does not find the $NODE_PATH while it exists and the generation fails for missing files.

Do you have any clue?

Thanks

(electron) companyName error

I get this when i try npm start
companyName is now a required option to crashReporter.start

No documentation?

Is this generator intended for the boilerplate only? No build process? I've tried npm build but nothing happens, unlike npm test and npm start which works just fine. I'm using latest version