Lackey options parser

Converts several formats into an object.

This module is part of the Lackey framework that is used to build the Lackey CMS amongst other projects.

Usage

We are going to provide several formats an always get the same object in the output:

{ opt1: "opt1", opt2: "opt2", opt3: "test_this" }

String, space separated values

var optionsParser = require('lackey-options-parser'),
    opts = optionsParser('opt1 opt2 opt3:test_this');

If that string begins with '/' we will consider it a path to a file and require it.

var optionsParser = require('lackey-options-parser'),
    opts = optionsParser('/models/test/my-opts.json');

This file is required from the process dir, where you run node.

When running this module in the browser, using browserify, you need to make sure the json file is (pre)required:

options.require = ['./models/test/my-opts.json'];

Function processing

If value fetched by given path will be instance of function it will be executed. Like in:

var optionsParser = require('lackey-options-parser'),
    opts = optionsParser('/models/test/my-opts.js');

Where /models/test/my-opts.js is

module.exports = function() {};

Specify function

You can also specify specific funciton in module to be exectued

var optionsParser = require('lackey-options-parser'),
    opts = optionsParser('/models/test/my-opts.js#functionName');

Pass arguments

You can pass arguments (with function or without)

var optionsParser = require('lackey-options-parser'),
    opts = optionsParser('/models/test/my-opts.js#functionName?argument=1&text=This%20is%20text');

Array

var optionsParser = require('lackey-options-parser'),
    opts = optionsParser([
     'opt1',
     'opt2',
     'opt3:test_this'
    ]);

Literal Object

This is useful as the return object has additional methods added to the prototype.

var optionsParser = require('lackey-options-parser'),
    opts = optionsParser({
        opt1: "opt1",
        opt2: "opt2",
        opt3: "test_this"
    });

Available Methods

stripUnderscores

Replaces all underscores with spaces. This method returns an options object and can be chained with other methods.

var opts = optionsParser('opt1 opt2 opt3:test_this').stripUnderscores();

returns:

{ opt1: "opt1", opt2: "opt2", opt3: "test this" }

makeTitle

Converts camelCase strings into human readable titles. This method returns an options object and can be chained with other methods.

var opts = optionsParser('opt1 opt2 opt3:testThis').makeTitle();

returns:

{ opt1: "opt1", opt2: "opt2", opt3: "Test this" }

getKeys

Returns an array with the keys of an object

var keys = optionsParser('opt1 opt2 opt3:test_this').getKeys();

returns:

[ 'opt1', 'opt2', 'opt3' ]

getValues

Returns an array with the values of an object

var values = optionsParser('opt1 opt2 opt3:test_this').getKeys();

returns:

[ 'opt1', 'opt2', 'opt3' ]

toString

Converts an object into a space separated string. It's useful to dump options settings into an HTML attribute without serializing it in JSON.

Spaces will be converted into underscores