Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,37 @@ console.log(dashify('Foo----Bar', {condense: true}));
//=> 'foo-bar'
```

## options.groupCaps

**Type:** `boolean`

**Default**: `undefined`

Treat multiple consecutive capitals as one word.

```js
console.log(dashify('CamelCASERules', {groupCaps: true}));
//=> 'camel-case-rules'

console.log(dashify('IndexID', {groupCaps: true}));
//=> 'index-id'

console.log(dashify('CamelCASE', {groupCaps: true}));
//=> 'camel-case'

console.log(dashify('aID', {groupCaps: true}));
//=> 'a-id'

console.log(dashify('theIDForUSGovAndDOD', {groupCaps: true}));
//=> 'the-id-for-us-gov-and-dod'

console.log(dashify('TheID-', {groupCaps: true}));
//=> 'the-id'

console.log(dashify('-IDOne', {groupCaps: true}));
//=> 'id-one'
```

## About

<details>
Expand Down Expand Up @@ -121,4 +152,4 @@ Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on November 19, 2018._
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on November 19, 2018._
8 changes: 8 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@

module.exports = (str, options) => {
if (typeof str !== 'string') throw new TypeError('expected a string');

if (options && options.groupCaps)
str = str
.replace(/([a-z])([A-Z]+)/g, (m, s1, s2) => s1 + ' ' + s2)
.replace(/([A-Z])([A-Z]+)([^a-zA-Z0-9]*)$/, (m, s1, s2, s3) => s1 + s2.toLowerCase() + s3)
.replace(/([A-Z]+)([A-Z][a-z])/g,
(m, s1, s2) => s1.toLowerCase() + ' ' + s2);

return str.trim()
.replace(/([a-z])([A-Z])/g, '$1-$2')
.replace(/\W/g, m => /[À-ž]/.test(m) ? m : '-')
Expand Down