Nerds Publishing Monstrosities
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

dashify

1.0.0 • Public • Published

dashify NPM version NPM monthly downloads NPM total downloads Linux Build Status

Convert a camelcase or space-separated string to a dash-separated string. ~12 sloc, fast, supports diacritics.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save dashify

Why another dashify lib?

Most slugify libs cover way too many corner cases and are bloated and slow as a result. I made this as a fast and light alternative (it even supports diacritics in ~12 sloc).

Usage

var dashify = require('dashify');
 
console.log(dashify('fooBar'));
//=> 'foo-bar'
 
console.log(dashify('fooBarBaz'));
//=> 'foo-bar-baz'
 
console.log(dashify('foo bar'));
//=> 'foo-bar'
 
console.log(dashify('foo barBaz'));
//=> 'foo-bar-baz'
 
console.log(dashify('foo barBaz quux'));
//=> 'foo-bar-baz-quux'
 
console.log(dashify('São Tomé and Príncipe'));
//=> 'são-tomé-and-príncipe'

options.condense

Type: boolean

Default: undefined

Condense multiple consecutive dashes to one.

console.log(dashify('Foo----Bar'));
//=> 'foo----bar'
 
console.log(dashify('Foo----Bar', {condense: true}));
//=> 'foo-bar'

About

Contributing

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

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

Other awesome string libs you might like:

Contributors

Commits Contributor
17 jonschlinkert
1 der-On
1 jeffreypriebe

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on December 03, 2017.

install

npm i dashify

Downloadsweekly downloads

96,133

version

1.0.0

license

MIT

repository

githubgithub

last publish

collaborators

  • avatar