# grunt-open

> Open urls and files from a grunt task

Latest version **0.2.4** (published 2019-03-14) · 0 weekly downloads

## Install

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

Provides the command `grunt-open`.

## 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.2.4 |
| Published | 2019-03-14 |
| First published | 2012-10-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.6.0 |
| Dependencies | 1 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 109 |
| Author | Jarrod Overson |
| Maintainers | jsoverson |
| Keywords | gruntplugin, open, url, file |

## Links

- npm: https://www.npmjs.com/package/grunt-open
- Repository: https://github.com/onehealth/grunt-open
- Issues: https://github.com/onehealth/grunt-open/issues
- npm.io page: https://npm.io/package/grunt-open

## Dependencies (1)

- [opn](https://npm.io/package/opn.md) ^5.4.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.2.4 (latest) — 2019-03-14
- 0.2.3 — 2014-01-17
- 0.2.2 — 2013-08-09
- 0.2.1 — 2013-07-12
- 0.2.0 — 2013-02-18
- 0.1.0 — 2012-10-03

## README

# grunt-open

Open urls and files from a grunt task

## Installation

Install using npm in the root of your project directory (where your package.json and Gruntfile.js are located)

```bash
npm install --save-dev grunt-open
```

## Usage

This is used as part of your grunt tasks, between the `server` and `watch` tasks

```js
grunt.registerTask('default', ['server', 'open', 'watch']);
```

You can specify different configurations so that you can set up task chains (see the configuration below for this example's config)

```js
grunt.registerTask('dev', ['server', 'open:dev', 'watch']);
grunt.registerTask('build', ['build', 'server', 'open:build', 'watch:build');
```

## Gruntfile Configuration

This is a very simple task and takes two configuration parameters, `path` (required) and `app` (optional). If `app` is not specified, the default system browser will be launched

```js
grunt.initConfig({
  open : {
    dev : {
      path: 'http://127.0.0.1:8888/src',
      app: 'Google Chrome'
    },
    build : {
      path : 'http://google.com/',
      app: 'Firefox'
    },
    file : {
      path : '/etc/hosts'
    },
    custom: {
      path : function () {
        return grunt.option('path');
      } 
    }
  }
})

grunt.loadNpmTasks('grunt-open');

```

## Options

#### openOn
Type: `String`

While it may not be common, you may want to delay the opening of your `path` at a later time of the grunt process. The option `openOn` allows you to define an event (coming through from [grunt.event](http://gruntjs.com/api/grunt.event)) that would signal the expected triggering of `open`. Example:

```js
grunt.initConfig({
  open: {
    delayed: {
      path: 'http://localhost:3000',
      app: 'Google Chrome',
      options: {
        openOn: 'serverListening'
      }
    }
  }
});

grunt.registerTask('server', function () {
  var server = require('myServer');
  server.listen(3000, function (err) {
    if (!err) {
      grunt.log.writeln('Server started');
      grunt.event.emit('serverListening'); // triggers open:delayed
    }
  });
})
```

#### delay
Type : `Number`

Set a delay for the open. *Note:* This task moves on immediately. If this is the last task in your chain you run the
risk of node exiting before your open is called.

[grunt]: https://github.com/gruntjs/grunt
[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt][grunt].

## Release History

 - 0.2.3 merged support for functions in config, added delay, merged openOn
 - 0.2.2 added `app` parameter.
 - 0.2.0 grunt 0.4.0 support, added and preferring `path` parameter.
 - 0.1.0 initial release

## License

MIT License, see LICENSE for details.

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