# grunt-jam

> A Grunt task for compiling Jam packages

Latest version **0.4.1** (published 2013-02-28) · 0 weekly downloads

## Install

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

## 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.4.1 |
| Published | 2013-02-28 |
| First published | 2012-07-23 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Kyle Robinson Young |
| Maintainers | shama |
| Keywords | gruntplugin, jam |

## Links

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

## Dependencies (1)

- [jamjs](https://npm.io/package/jamjs.md) ~0.2.13

## Recent versions

- 0.4.1 (latest) — 2013-02-28
- 0.4.0 — 2013-02-20
- 0.3.4 — 2012-12-12
- 0.3.3 — 2012-11-21
- 0.3.2 — 2012-10-27
- 0.3.1 — 2012-10-27
- 0.3.0 — 2012-09-28
- 0.2.1 — 2012-08-12
- 0.2.0 — 2012-08-12
- 0.1.1 — 2012-08-01
- 0.1.0 — 2012-07-23

## README

# grunt-jam [![Build Status](https://secure.travis-ci.org/shama/grunt-jam.png?branch=master)](http://travis-ci.org/shama/grunt-jam)

A Grunt task for compiling [Jam packages](http://jamjs.org).

## Getting Started

Be sure you have Jam installed with `npm install -g jamjs`.

Install this grunt plugin next to your project's
[Gruntfile.js][getting_started] with: `npm install grunt-jam`.

Then add this line to your project's `Gruntfile.js`:

```javascript
grunt.loadNpmTasks('grunt-jam');
```

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

## Documentation

Add the task to your config and specify the destination for the compiled file:

```javascript
grunt.initConfig({
  jam: {
    dist: {
      dest: 'assets/js/compiled.js'
    }
  }
});
```

If you would like to include additional files specify `src` files:

```javascript
grunt.initConfig({
  jam: {
    dist: {
      src: ['assets/js/src/**/*.js', 'someother/file.js'],
      dest: 'assets/js/compiled.js'
    }
  }
});
```

All the compile options for jam are available. Set them with the `options` key
like such:

```javascript
grunt.initConfig({
  jam: {
    dist: {
      dest: 'assets/js/compiled.js',
      options: {
        verbose: true,
        nominify: true,
        wrap: true
      }
    }
  }
});
```

### Configuring JamJS into another folder besides `./jam`
The best way, imo, is to create a `.jamrc` file and put
`exports.package_dir = 'js';` into it. Both JamJS and grunt-jam will read that
file.

If you rather configure another dir within your `Gruntfile.js` you can do so
within the options:

```javascript
grunt.initConfig({
  jam: {
    dist: {
      dest: 'dist/compiled.js',
      options: {
        pkgdir: 'js'
      }
    }
  }
});
```

*There are two alternate options for the package dir: `packageDir` and
`package_dir`. I recommend always using `pkgdir` as the other two are for
backwards compatibility.*

## Contributing

Please open an issue or send a pull request. Run `npm test` to test. Thanks!

## Release History

* 0.4.1 Fix for configs without src.
* 0.4.0 Grunt v0.4 Support.
* 0.3.4 Fix issue with `packageDir` option.
* 0.3.3 Update for latest Grunt v0.4
* 0.3.2 Fix `grunt-lib-contrib` module name.
* 0.3.1 Enable reading .jamrc files for settings. Allow additional `src` to be blank.
* 0.3.0 Compatibility with JamJS v0.2.8. Refactor for migration to Grunt 0.4
* 0.2.1 Better defaults for pkgDir
* 0.2.0 Update for JamJS 2
* 0.1.1 Remove grunt as dep
* 0.1.0 Package up and publish jam task

## License

Copyright (c) 2012 Kyle Robinson Young
Licensed under the MIT license.

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