# proton-packager

> Creates bundles for [proton-native](https://github.com/kusti8/proton-native). It will download the latest node version and create a fully self-contained package.

Latest version **0.1.2** (published 2018-03-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install proton-packager
pnpm add proton-packager
yarn add proton-packager
bun add proton-packager
```

Provides the command `proton-packager`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2018-03-07 |
| First published | 2018-03-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 131.1 KB |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | mischnic |

## Links

- npm: https://www.npmjs.com/package/proton-packager
- Repository: https://github.com/mischnic/proton-packager
- Homepage: https://github.com/mischnic/proton-packager#readme
- Issues: https://github.com/mischnic/proton-packager/issues
- npm.io page: https://npm.io/package/proton-packager

## Dependencies (7)

- [request](https://npm.io/package/request.md) ^2.83.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^5.0.0
- [klaw-sync](https://npm.io/package/klaw-sync.md) ^3.0.2
- [babel-core](https://npm.io/package/babel-core.md) ^6.26.0
- [decompress](https://npm.io/package/decompress.md) ^4.2.0
- [command-exists](https://npm.io/package/command-exists.md) ^1.2.2
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.5

## Recent versions

- 0.1.2 (latest) — 2018-03-07
- 0.1.1 — 2018-03-07
- 0.1.0 — 2018-03-04

## README

# proton-packager

Creates bundles for [proton-native](https://github.com/kusti8/proton-native).
It will download the latest node version and create a fully self-contained package.

**At the moment, only Mac app bundles are supported. Contributions are welcome!**

It can be installed globally or locally:
```sh
yarn add --dev proton-packager // or
npm install -D proton-packager
```
You can then use it on the cli via npx
```sh
npx proton-packager mac MyApp
```
or add a script to your `package.json`:
```js
{
  "name": "my-proton-app",
  "scripts": {
    "package": "proton-packager mac MyApp -f"
  },
  ...
}
```

```

  Usage: proton-packager [options] [command]


  Commands:

    mac <AppName>  create a macOS .app bundle

  Options:

    -h, --help             output usage information
    -o, --out-dir <dir>    output folder [build]
    -s, --src <dir>        source folder [src]
    -m, --main <main>      name of the main script inside src [index.js]
    -b, --bundle <bundle>  bundle identifier [my.proton.application]
    -i, --icon <icon>      icns file to use as app icon
    -v, --version <ver>    version of the app [package.json: version]
    --no-transpile         don't transpile source files using babel
    -f, --force            overwrite old package

```

### Examples

For a project with the structure:
```
my-app
├── node_modules
├── package.json
├── src
│   └── index.js
└── .babelrc
```
simply run 
```sh
proton-packager mac MyApp
```
to create the app bundle `MyApp.app`.

<br/>

For a project with the structure:
```
proton-test
├── node_modules
├── package.json
├── application
│   └── main.js
└── .babelrc
```
use 
```sh
proton-packager mac MyApp -s application -m main.js
```

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