0.0.1 • Published 8 years ago

kebab-caseify v0.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
8 years ago

kebab-caseify

Convert any string into kebab case - /ie: kebab-case

##Overview

Convert a space separated string to kebab-case. Lightweight and easy to drop into your projects

##Installing

npm i kebab-caseify --save-dev

##Usage

Simply require the kebab-caseify module. The export function can be used in any module you desire.

Install with npm

const kebabCaseify = require('kebab-caseify');

kebabCaseify('Quux Bar');
//==> 'quux-bar
kebabCaseify('Quux Foo Bar');
//==> 'quux-foo-bar'
kebabCaseify('foo Bar quux');
//==> 'foo-bar-quux'
kebabCaseify('Bar FOO norf');
//==> 'bar-foo-norf'

/**
 * additonaly use with capitalize
 * @param {String} str
 */
 
kebabCaseify.capitalize('foo Baz bar')); 
//==> 'FOO-BAZ-BAR'

/**
 * additonaly use with EN Dash
 * @param {String} str
 */
 
kebabCaseify.enDash('EN dash ME')); 
//==> 'en–dash–me'

##TODO

  • add more tests
  • add capability to kebabcase a camelCased string
  • chain methods together

##Tests

npm test

WIP

// wip

##Related Modules

##Contributing

Feel free to file an issue or bug.