grunt-manifest-sync v1.2.1

grunt-manifest-sync

A Grunt plugin for syncing common informatiom across many Json manifest files

Getting Started

This plugin requires Grunt 0.4.5

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-manifest-sync --save-dev

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

grunt.loadNpmTasks('grunt-manifest-sync');

The "manifestSync" task

Overview

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

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

Options

options.primaryManifest

Type: String or Object
Default value: package.json

The primary manifest to sync all other manifests to. If options.primaryManifest is a String then the manifestSync task will fetch the file contents.

options.syncManifestFields

Type: Array of Strings
Default value: ["name", "description", "version"]

The Json fields to sync from options.primaryManifest. The purpose of this field is to sync only the fields that are needed. This way if you have your Npm package.json as the options.primaryManifest the manfiestSync task will only sync the specified fields instead of the 20 other unwanted fields.

options.manifests

Type: Object
Default value: {}

The options.manifests field is used to specify the Json manifests files to sync from the options.primaryManifest. The values of options.manifests can be either/or a simple key value pair or a complex object.

In addition to simple key value pairs and complex objects an import field can be used to specify Json file(s) to import manifest options from. If your manifests need to use the import field then use the _import field instead. These Json files must have a field in them called manifests. The value of manifests will be merged with the other options.manifests objects(options.manifests objects have priorty). By default the manifestSync task will search your options.primaryManifest file for a manifests field as well. If you would like to opt out of this feature make one of your import paths FLAG_NO_PRIMARY_MANIFEST
Gruntfile.js

manifestSync: {
  dist: {
    options: {
      manifests: {
        import: "manifests.json",
        bower: "bower.json",
        chromeExtension: "extension/manifest.json"
      }
    }
  }
}

manifests.json

{
  "manifests": {
    "foo": "foo.json",
    "bazz": {
      "dest": "bazz/bazzManifest.json",
      "name": "Bazz!"
    }
  }
}

Simple Key Value Pair
The simple key value pair simply specifies the file path of a Json manifest to sync. The manifestSync task will automatically detect if a file exists and create the file if it does not exist, or only override the options.syncManifestFields fields if it exists.

manifestSync: {
  dist: {
    options: {
      manifests: {
        bower: "bower.json",
        chromeExtension: "extension/manifest.json"
      }
    }
  }
}

This example configuration will sync the bower.json file and the extension/manifest.json file

Complex object
The complex object option is for more complected manifests. Its purpose is to add or override manifest specific fields.

Fields ###dest Optional: False
Type: String
Default value: None

Specifies were to write the manifest to. If your complex object needs to use the dest field then use the _dest field instead

###ignore Optional: True
Type: Array of Strings
Default value: []

Specifies fields to ignore. For example if you would like to ignore the version field completely simply add the version field to the ignore field. If your complex object needs to use the ignore field use the _ignore field instead.

manifestSync: {
  dist: {
    options: {
      manifests: {
        bower: "bower.json",
        chromeExtension: {
          dest: "extension/manifest.json",
          ignore: ["version"]
        }
      }
    }
  }
}

manifestSync: {
  dist: {
    options: {
      manifests: {
        bower: {
          dest: "bower.json",
          private: true,
          dependencies: {
            ember: "~1.8.1",
            ember-data: "~0.0.14"
          },
          resolutions: {
            ember: "~1.8.1"
          }
        },
        chromeExtension: {
          name: "Custom name for Chrome extension",
          version: "1.0.0-chrome",
          permissions: [
            "http://google.com"
          ]
        }
      }
    }
  }
}

Please note that complex objects can be used with simple key value pairs as well.

Usage Examples

Default Options

In this example all default values are used. The only custom options are the options.manifests to sync. In options.manifests both simple key value pairs and complex objects are used

grunt.initConfig({
  manifestSync: {
    dist: {
      options: {
        manifests: {
          bower: "bower.json",
          chromeExtension: {
            description: "A Chrome extension that allows you to foo bazz"
          }
        }
      }
    }
  }
});

Custom Primary Manifest Path

In this example a custom options.primaryManifest file is specified via its path

grunt.initConfig({
  manifestSync: {
    dist: {
      options: {
        primaryManifest: "distManifest.json",
        manifests: {
          bower: "bower.json",
          chromeExtension: {
            description: "A Chrome extension that allows you to foo bazz"
          }
        }
      }
    }
  }
});

and in distManifest.json

{
  "name": "Foo Bazz!",
  "description": "The best description",
  "version": "1.0.0-dist"
}

Custom Primary Manifest Object

In this example a custom options.primaryManifest file is specified via an object

grunt.initConfig({
  manifestSync: {
    dist: {
      options: {
        primaryManifest: {
          name: "Foo Bazz!",
          description: "The best description",
          version: "1.0.0-dist"
        },
        manifests: {
          bower: "bower.json",
          chromeExtension: {
            description: "A Chrome extension that allows you to foo bazz"
          }
        }
      }
    }
  }
});

Custom Sync Manifest Fields

In this example custom sync fields are specified

grunt.initConfig({
  manifestSync: {
    dist: {
      options: {
        syncManifestFields: ["name", "flavor"]
        primaryManifest: {
          name: "Foo Bazz!",
          flavor: "dist"
        },
        manifests: {
          bower: "bower.json",
          chromeExtension: {
            flavor: "dist-chrome"
          }
        }
      }
    }
  }
});

Release History

• 2014-11-30   v1.2.x   Added import field
• 2014-11-29   v1.1.x   Bug fixes. Added ignore field
• 2014-11-29   v1.0.0   Initial release