Denis 346b78aee1 first commit 2 سال پیش
..
LICENSE 346b78aee1 first commit 2 سال پیش
README.md 346b78aee1 first commit 2 سال پیش
index.js 346b78aee1 first commit 2 سال پیش
package.json 346b78aee1 first commit 2 سال پیش

README.md

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 :heart: 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](../../issues/new).
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: ```sh $ npm install && npm test ```
Building docs _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: ```sh $ npm install -g verbose/verb#dev verb-generate-readme && verb ```

Related projects

Other awesome string libs you might like:

  • pascalcase: Convert a string to pascal-case. | homepage
  • romanize: Convert numbers to roman numerals (useful for books, outlines, documentation, slide decks, etc) | homepage")
  • word-wrap: Wrap words to a specified length. | homepage
  • wordcount: Count the words in a string. Support for english, CJK and Cyrillic. | homepage

Contributors

| Commits | Contributor |
| --- | --- |
| 23 | jonschlinkert |
| 1 | der-On |
| 1 | jeffreypriebe |

Author

Jon Schlinkert

License

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


This file was generated by verb-generate-readme, v0.8.0, on November 19, 2018.