# grunt-component-inventory

> Create inventory of components from individual files or data stored in JSON file.

Latest version **0.4.0** (published 2015-09-21) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install grunt-component-inventory
pnpm add grunt-component-inventory
yarn add grunt-component-inventory
bun add grunt-component-inventory
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2015-09-21 |
| First published | 2015-02-22 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tilman Justen |
| Maintainers | tilmanjusten |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-component-inventory
- Repository: https://github.com/tilmanjusten/grunt-component-inventory
- Issues: https://github.com/tilmanjusten/grunt-component-inventory/issues
- npm.io page: https://npm.io/package/grunt-component-inventory

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^3.9.3

## Recent versions

- 0.4.0 (latest) — 2015-09-21
- 0.3.0 — 2015-08-02
- 0.2.1 — 2015-06-13
- 0.2.0 — 2015-03-08
- 0.1.2 — 2015-02-27
- 0.1.1 — 2015-02-22
- 0.1.0 — 2015-02-22

## README

# grunt-content-inventory

> Create inventory of components from individual files or data stored in JSON file.

## Getting Started
This plugin requires Grunt `~0.4.5`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-content-inventory --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-content-inventory');
```

## The "content-inventory" task

### Overview
In your project's Gruntfile, add a section named `content-inventory` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  'content-inventory': {
    options: {
      // Task specific options goes here.
    },
    your_target: {
      // Target specific file lists and/or options goes here.
    },
  },
});
```

### Options

```js
grunt.initConfig({
  'content-inventory': {
    options: {
      // Template file path
      template: path.resolve(__dirname, '../tmpl/template.html'),
      // Storage file path
      storage: 'component-inventory.json',
      // Partial directory where individual partial files will be stored (relative to base)
      partials: './partials',
      // Component inventory file path
      dest: 'component-inventory.html',
      // Expand: create file per category
      expand: false,
      // Create partial files
      storePartials: false,
      // Partial extension when stored
      partialExt: '.html',
      // Category for items without category
      categoryFallback: 'No category'
    },
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
});
```

## 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](http://gruntjs.com/).

## Release History
_(Nothing yet)_

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