# assets-include

> Include assets into your views with ease (assets-packager compatible).

Latest version **1.1.1** (published 2014-03-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install assets-include
pnpm add assets-include
yarn add assets-include
bun add assets-include
```

Provides the command `assetsinc`.

## 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 | 1.1.1 |
| Published | 2014-03-15 |
| First published | 2012-06-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | GoalSmashers.com |
| Maintainers | goalsmashers |

## Links

- npm: https://www.npmjs.com/package/assets-include
- Repository: https://github.com/GoalSmashers/assets-include
- Issues: https://github.com/GoalSmashers/assets-include/issues
- npm.io page: https://npm.io/package/assets-include

## Dependencies (2)

- [commander](https://npm.io/package/commander.md) 2.1.x
- [assets-expander](https://npm.io/package/assets-expander.md) 1.0.x

## Recent versions

- 1.1.1 (latest) — 2014-03-15
- 1.1.0 — 2014-03-12
- 1.0.0 — 2014-03-05
- 0.7.0 — 2013-08-12
- 0.6.2 — 2012-08-15
- 0.6.1 — 2012-08-09
- 0.6.0 — 2012-08-09
- 0.5.0 — 2012-08-07
- 0.3.1 — 2012-07-03
- 0.3.0 — 2012-07-03
- 0.2.1 — 2012-06-19
- 0.2.0 — 2012-06-19
- 0.1.1 — 2012-06-19
- 0.1.0 — 2012-06-18

## README

[![NPM version](https://badge.fury.io/js/assets-include.png)](https://badge.fury.io/js/assets-include)
[![Build Status](https://secure.travis-ci.org/GoalSmashers/assets-include.png)](https://travis-ci.org/GoalSmashers/assets-include)
[![Dependency Status](https://david-dm.org/GoalSmashers/assets-include.png?theme=shields.io)](https://david-dm.org/GoalSmashers/assets-include)
[![devDependency Status](https://david-dm.org/GoalSmashers/assets-include/dev-status.png?theme=shields.io)](https://david-dm.org/GoalSmashers/assets-include#info=devDependencies)

## What is assets-include?

Assets-include is a [Node.js](http://nodejs.org/) tool for including your assets in HTML views.

This project is closely tied to [Assets-Packager](https://github.com/GoalSmashers/assets-packager) which can
minify, enhance, and bundle your assets based on a YAML definition file.

See [example apps](https://github.com/GoalSmashers/assets-include/tree/master/examples) for real-world use cases.

## Usage

### What are the requirements?

```
Node.js 0.8.0+ (tested on CentOS, Ubuntu, and OS X 10.6+)
```

### How to install assets-include?

```
npm install assets-include
```

### How to use assets-include programmatically?

```js
var includer = new AssetsIncluder('assets.yml');
includer.group('stylesheets/mobile/application.css');
```

AssetsInclude constructor accepts a hash as a 2nd parameter, i.e.,

* `bundled` - `true` for bundled, production mode, `false` for development mode
* `root` - root path of all assets, defaults to ./public under config's path
* `cacheBoosters` - `true` for cache boosters (timestamp in dev mode, md5 for bundled, production files)
* `assetHosts` - prefixes all paths with given asset host(s)
* `loadingMode` - `async` or `defer` for JavaScript assets' loading mode

AssetsInclude public methods will give you the following output:

* `group(locator)` - a list of `<script>` or `<link>` tags for JavaScript or CSS assets respectively
* `inline(locator)` - a JavaScript or CSS assets inlined rather than referenced by `<script>` or `<link>` tag respectively.
  In development mode works the same way as `group(locator)`.
* `list(locator)` - an array of of assets files (to easily embed it into JavaScript or data-attribute)

### How to use assets-include CLI?

assetsinc accepts the following command line arguments.

```
assetsinc <options> <group path, name, and type>

-h, --help                        output usage information
-v, --version                     output the version number
-a, --asset-hosts [asset-hosts]   prefix all paths with given asset host(s)
-b, --bundled                     output a bundled (production) version
-s, --cache-boosters              use cache boosters
-c, --config [config-file]        path to assets config file
-i, --inline                      output inline tags
-m, --loading-mode [async|defer]  use the given loading mode for JavaScript assets
-l, --list                        list mode (prints filenames instead of HTML tags)
-r, --root [root-path]            root path of all assets (defaults to ./public under config's path)
```

### What are the assets-include dev commands?

First clone the source, then run:

* `npm run check` to check JS sources with [JSHint](https://github.com/jshint/jshint/)
* `npm test` for the test suite

## License

Assets-include is released under the [MIT License](https://github.com/GoalSmashers/assets-include/blob/master/LICENSE).

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