pretty-camel

Node module to prettify camel cased strings.

npm install pretty-camel
16 downloads in the last week
32 downloads in the last month

Pretty Camel

Build Status

Node module to format to and from camel case.

toWords()

var prettyCamel = require("pretty-camel");
prettyCamel(input, {
   "case": "title" (default) | "sentence" | "lower"
});
prettyCamel.toWords(input, {
   "case": "title" (default) | "sentence" | "lower"
});

prettyCamel.toWords() is aliased to prettyCamel() so it can be used either way.

Here are a few examples of prettification:

  • procedureCode -> Procedure Code
  • hospitalCPTCode -> Hospital CPT Code
  • eatAHotdog -> Eat A Hotdog
  • eatAHotdog -> eat a hotdog (lower case option)
  • procCodeA938 -> Proc Code A938
  • procA39BCode -> Proc A39B Code
  • procA39BCode -. Proc A39B code (sentence case option)

Rules

The following rules are applied to input strings:

  • Words separated by uppercase letters, numbers, underscores, dashes, and periods
  • Each word is separated by a space
  • A sequence of capital letters and numbers is considered to be one word

Options

Options are passed in an object as the second parameter. Currently the only option available is casing.

Case Option

  • "title"- (default) Uppercases the first letter of every word
  • "sentence"- Uppercases the first letter of the first word and lowercases all other words
  • "lower"- Lowercases all words except for abbreviation

toCamelCase()

var prettyCamel = require("pretty-camel");
prettyCamel.toCamelCase(input, {
   "case": "lower" (default) | "upper"
});

Here are a few examples:

  • Procedure Code -> procedureCode
  • Procedure-code -> procedureCode
  • Procedure_code -> ProcedureCode (upper case option)

Options

Options are passed in an object as the second parameter. Currently the only option available is casing.

Case Option

  • "lower"- (default) Lowercases the first letter of the first word
  • "upper"- Uppercases the first letter of the first word

Sample Usage

var prettyCamel = require("pretty-camel");
var input = "hospitalCPTCode";
var output = prettyCamel(input);

console.log(output);

The outputs is Hospital CPT Code

var prettyCamel = require("pretty-camel");
var input = "hospitalCPTCode";
var options = {
   "case": "sentence" 
};
var output = prettyCamel.toWords(input, options);

console.log(output);

The outputs is Hospital CPT code

var prettyCamel = require("pretty-camel");
var input = "hospitalCPTCode";
var options = {
   "case": "lower" 
};
var output = prettyCamel(input, options);

console.log(output);

The outputs is hospital CPT code

var prettyCamel = require("pretty-camel");
var input = "hospital_CPT_Code";
var options = {
   "case": "upper" 
};
var output = prettyCamel.toUpperCase(input, options);

console.log(output);

The outputs is HospitalCPTCode

Install

npm install pretty-camel

Express Middleware

If you're using Express and want access to prettyCamel() in your views, add the following piece of middleware to your server:

var prettyCamel = require("pretty-camel");
var express = require("express");
var app = express.createServer();

app.use(prettyCamel.middleware);

Version 0.0.7 was compatible with Express 2.x and 0.0.8 and above are compatible with Express 3.x.

npm loves you