Giter VIP home page Giter VIP logo

grunt-heritage's Introduction

grunt-heritage

Build Status Gittip

Hate keeping version numbers and other properties up-to-date in multiple JSON package management files? Enter grunt-heritage. Automatically copy properties from a parent file (package.json) into child files (bower.json, component.json, etc.).

Getting Started

This plugin requires Grunt ~0.4.1

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 grunt-heritage --save-dev

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

grunt.loadNpmTasks('grunt-heritage');

The "heritage" task

Overview

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

grunt.initConfig({
  heritage: {
    options: {
      parent: "package.json", // default
      properties: ["name", "description", "version"], // default
      children: ["bower.json"] // required
    }
  }
})

Options

options.parent

Type: String
Default value: 'package.json'

The file to pull properties from.

options.properties

Type: Array
Default value: ['name', 'description', 'version']

The property names to copy into child files.

options.children

Type: Array
Default value: []

The files to write the parent properties to.

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.

Release History

0.1.0 - Initial release.

grunt-heritage's People

Stargazers

Andrey Lysenko avatar Maxime Poulin avatar

Watchers

Garrett Murphey avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.