grunt-legacy-config

grunt-legacy-config

Grunt's config methods, as a standalone library.

Heads up!

This is not ready for use yet! We'll update the readme when it's ready to go, feel free to star the project if you want updates in the meantime!

Install

Install with npm

$ npm i grunt-legacy-config --save-dev

Usage

var config = require('grunt-legacy-config');

API

config

Get/set config data. If value was passed, set. Otherwise, get.

Params

• prop {String}
• value {*}
• returns {String}

Example

config([prop [, value]])

.escape

Escape any . in the given propString with \. This should be used for property names that contain dots.

Params

• str {String}: String with .s to escape
• returns {String}

Example

config.escape('foo.js');
//=> 'foo\.js'

.getPropString

Return prop as a string. If an array is passed, a dot-notated string will be returned.

Params

• prop {String|Array}
• returns {String}

Example

config.getPropString(['a', 'b']);
//=> 'a.b'

.getRaw

Get a raw value from the project's Grunt configuration, without processing <% %> template strings.

Params

• prop {String}: The name of the property to get.
• returns {*}: Returns the value of the given property.

Example

config.getRaw([prop])

.get

Get a value from the project's Grunt configuration, recursively processing templates. http://gruntjs.com/api/grunt.config#grunt.config.get

Params

• prop {String}
• returns {*}: Returns the value of prop

Example

grunt.config.get([prop]);

TODO

First:

(loosely in this order...)

• migrate code
• migrate tests
• get tests passing with 100% parity
• add Grunfile
• coverage reports
• API documentation, written as code comments
• Add the event to the changelogs of both libraries

Next:

• replace core grunt.config internal module with grunt-legacy-config
• remove any dependencies that are no longer needed from grunt.
• enable travis
• add travis badge

Related projects

• grunt: The JavaScript Task Runner
• grunt-cli: The grunt command line interface.
• grunt-legacy-log: The Grunt 0.4.x logger.
• grunt-legacy-util: Some old grunt utils provided for backwards compatibility.

Running tests

Install dev dependencies:

$ npm install -d && grunt

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

"Cowboy" Ben Alman

• github/cowboy

• twitter/cowboy

License

Copyright (c) 2015 "Cowboy" Ben Alman Released under the MIT license.

This file was generated by verb-cli on May 14, 2015.