# grunt-electron

> Package Electron apps

Latest version **13.0.0** (published 2024-04-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install grunt-electron
pnpm add grunt-electron
yarn add grunt-electron
bun add grunt-electron
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 13.0.0 |
| Published | 2024-04-30 |
| First published | 2015-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=18 |
| Dependencies | 1 |
| Unpacked size | 3.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 75 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus, malept |
| Keywords | gruntplugin, electron, package, packager, build, distribute, app, apps |

## Links

- npm: https://www.npmjs.com/package/grunt-electron
- Repository: https://github.com/sindresorhus/grunt-electron
- Homepage: https://github.com/sindresorhus/grunt-electron#readme
- Issues: https://github.com/sindresorhus/grunt-electron/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/grunt-electron

## Dependencies (1)

- [electron-packager](https://npm.io/package/electron-packager.md) ^15.1.0

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 13.0.0 (latest) — 2024-04-30
- 12.0.0 — 2020-11-24
- 11.0.0 — 2019-06-20
- 10.0.0 — 2019-04-11
- 9.0.1 — 2018-05-03
- 9.0.0 — 2018-04-03
- 8.0.0 — 2018-02-08
- 7.0.0 — 2017-11-20
- 6.0.0 — 2017-08-24
- 5.0.0 — 2016-09-04
- 4.0.0 — 2016-04-23
- 3.0.0 — 2016-04-06
- 2.0.1 — 2015-09-22
- 2.0.0 — 2015-07-03
- 1.0.0 — 2015-05-11

## README

# grunt-electron

> Package [Electron](https://electronjs.org) apps using [`electron-packager`](https://github.com/electron/packager)

*Issues should be reported on the `electron-packager` [issue tracker](https://github.com/electron/packager/issues).*

Please think hard if you really need Grunt for this. A simple vanilla Node.js build script would probably be better.

This is mostly intended for those that have an existing Grunt setup and want to integrate Electron app packaging.

## Install

```sh
npm install --save-dev grunt-electron
```

## Usage

```js
require('load-grunt-tasks')(grunt); // npm install --save-dev load-grunt-tasks

grunt.initConfig({
	electron: {
		macosBuild: {
			options: {
				name: 'Fixture',
				dir: 'app',
				out: 'dist',
				version: '1.3.5',
				platform: 'darwin',
				arch: 'x64'
			}
		}
	}
});

grunt.registerTask('default', ['electron']);
```

## Options

See the `electron-packager` [options](https://github.com/electron/electron-packager#usage).

In addition you need to supply the `name` of your app and the `dir` where your app is located.

---
_Source: https://npm.io/package/grunt-electron · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._