assemble-manifest

Generates JSON and/or YAML manifest files from given source files or directories or source files.

npm install assemble-manifest
8 downloads in the last week
12 downloads in the last month

assemble-manifest v0.1.3 Build Status

Generates JSON and/or YAML manifest files from given source files or directories or source files.

This project is more of a proof of concept or sandbox for generating:

  • Component manifests
  • component.json
  • package.json
  • jQuery Plugin Package Manifest
  • JSON or YAML formatted lists of files of certain types in given directories, grouped into "collections".
  • Or just use it to sync the metadata in your root .json files: package.json, component.json, *.jquery.json, _config.yml etc.

See some of the example manifests generated with this task.

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install assemble-manifest --save-dev

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

grunt.loadNpmTasks('assemble-manifest');

The "manifest" task

Overview

In your project's Gruntfile, add a section named manifest to the data object passed into grunt.initConfig().

grunt.initConfig({
  manifest: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    }
  }
})

Options

Documentation forthcoming

format

Type: String Default: json

Option to specify output format for dest files. Case insensitive, and may be either YAML or JSON format. Any of the following will work:

  • 'yml', 'yaml', 'YML', 'YAML'
  • 'json', 'JSON' (although these are uncessary since the task defaults to json)

sorted

Type: Boolean Default: false

Sorts ouput objects and properties in alphabetical order.

indent

Type: Number Default: 2

Number of spaces to indent the output. Currently only works for .json files, not .yml.

debug

Type: Boolean Default: false

When set to true, the output will include all omitted properties for inspection.

Collections

Type: Arrays|Objects Default: documents|fonts|images|javascripts|markdown|styles|templates

Generate arrays of files with specific extensions from given source directories.

Currently limited to file types defined in the code. We realize this part of the task is somewhat hard-coded for our own usage, so the plan is to allow collections and extensions to be user-defined, through the task and target options.

By default, currently the task will build the following types of collections, and with the specified extensions for each collection:

documents

.md | .txt | .doc | .docx | .pdf

fonts

.eot | .svg | .otf | .ttf | .woff

images

.ico | .png | .gif | .jpg

javascripts

.js | .coffee

markdown

.md | .markd | .markdown

styles

.css | .less | .stylus | .sass | .scss

templates

.hbs | .hbr | .handlebars | .html | .htm | .mustache | .tmpl

To build a specific collection, just add the extension pattern(s) for the src files you want to add to your dest file(s). For pre-defined collections, you don't need to do anything to explicity add the collection itself, the task takes care of that for you. For example:

images: {
  options: {
    name: 'Image Manifest'
  },
  files: {
    'dest/images.json': ['assets/img/**/*.{jpg,png,gif}'],
  }
}

Will yield an images collection that includes an array of files with the extensions specified in the files object:

Output: images.json

{
  "images": [
    "assets/img/one.jpg",
    "assets/img/two.jpg",
    "assets/img/three.jpg",
    "assets/img/icons/icon-a.jpg",
    "assets/img/icons/icon-b.jpg",
    ...
  ]
}

Usage Examples

See some of the example manifests generated with this task.

Let's say the goal is to build a component.json from a package.json. We could:

  • Do a one-to-one transfer of objects and properties
  • Override any objects or properties in the options by simply adding the new value to the options.
  • Remove any objects or properties in the options by making the value undefined (this is a quick fix, will revisit but it works for now.)
  • Define new objects and properties in the options block.
manifest: {
  options: {
    metadata: 'metadata.json', // optional source of metatdata
    name: 'assemble-manifest'
    version: '0.1.0'           
    description: 'Generates JSON and/or YAML manifest files from given source files or directories or source files.'
  },
  // build component.json from package.json
  package: {
    files: {
      'package.json': []
    }
  },
  component: {
    files: {
      'component.json': []
    }
  }
}

Default Options

manifest: {
  options: {
    collections: true,
    debug: false,
    exclude: [],
    format: 'json',
    include: [],
    indent: 2,
    manifestrc: [],
    metadata: [],
    sorted: false
  },
  // build component.json from package.json
  component: {
    files: {
      'component.json': ['package.json']
    }
  }
}

Custom Options

On the way...

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.

License

MIT License

Release History

(Nothing yet)

npm loves you