Varname
Convert strings between different variable naming formats.
Current Version: 1.0.0
Build Status: 
Node Support: 0.6, 0.8
Browser Support: Android Browser 2.2–4.2, Firefox 3.6, Firefox 4–17, Google Chrome 14–25, Internet Explorer 6–10, Mobile Safari iOS 3–6, Opera 12.10, Safari 5–6
Getting Started
You can use Varname on the server side with Node.js and npm:
$ npm install varname
On the client side, you can either install Varname through Component:
$ component install rowanmanning/varname
or by simply including varname.js
in your page:
<script src="path/to/lib/varname.js"></script>
Usage
In Node.js or using Component, you can include Varname in your script by using require:
var varname = require('varname');
Varname also works with AMD-style module loaders, just specify it as a dependency.
If you're just including with a <script>
, varname
is available as a global variable.
varname.camelback( str )
Convert a variable name to camelBack format (capitalize the first letter of all but the first word).
str: (string) The string to convert.
return: (string) Returns the converted string.
varname.camelback('foo_bar_baz');
varname.camelcase( str )
Convert a variable name to CamelCase format (capitalize the first letter of each word).
str: (string) The string to convert.
return: (string) Returns the converted string.
varname.camelcase('foo_bar_baz');
varname.dash( str )
Convert a variable name to dash format.
str: (string) The string to convert.
return: (string) Returns the converted string.
varname.dash('FooBarBaz');
varname.underscore( str )
Convert a variable name to underscore format.
str: (string) The string to convert.
return: (string) Returns the converted string.
varname.underscore('FooBarBaz');
varname.split( str )
Split a string into separate variable parts. This allows you to write your own format converters easily.
str: (string) The string to split.
return: (array) Returns an array of parts.
varname.split('fooBarBaz');
varname.split('FooBarBaz');
varname.split('foo-bar-baz');
varname.split('foo_bar_baz');
varname.split('♥~foo|bar|baz~♥');
Development
To develop Varname, you'll need to clone the repo and install dependencies with make deps
. If you're on Windows, you'll also need to install Make for Windows.
Once you're set up, you can run the following commands:
$ make deps
$ make lint
$ make test
$ make test-server
When no build target is specified, make will run deps lint test
. This means you can use the following command for brevity:
$ make
Code with lint errors or no/failing tests will not be accepted, please use the build tools outlined above.
License
Varname is licensed under the MIT license.