diff --git a/README.md b/README.md index 385d7b0..0a29dc5 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ slugify('some string', '_') // some_string ```js slugify('some string', { replacement: '-', // replace spaces with replacement character, defaults to `-` + preserveReplacement: false, // keep replacement characters already in the input, defaults to `false` remove: undefined, // remove characters that match regex, defaults to `undefined` lower: false, // convert to lower case, defaults to `false` strict: false, // strip special characters except replacement, defaults to `false` @@ -31,6 +32,11 @@ slugify('some string', { }) ``` +Set `preserveReplacement: true` to keep repeated or trailing replacement +characters from the input. For example, `slugify('step -1', +{preserveReplacement: true})` returns `step--1` while `slugify('step 1')` +returns `step-1`. This option applies when `strict` is `false`. + ## Remove For example, to remove `*+~.()'"!:@` from the result slug, you can use `slugify('..', {remove: /[*+~.()'"!:@]/g})`. diff --git a/slugify.d.ts b/slugify.d.ts index 78a9d7f..a591b7d 100644 --- a/slugify.d.ts +++ b/slugify.d.ts @@ -13,6 +13,7 @@ declare function slugify( options?: | { replacement?: string; + preserveReplacement?: boolean; remove?: RegExp; lower?: boolean; strict?: boolean; diff --git a/slugify.js b/slugify.js index dd13ebf..62cac77 100644 --- a/slugify.js +++ b/slugify.js @@ -36,7 +36,7 @@ var appendChar = locale[ch]; if (appendChar === undefined) appendChar = charMap[ch]; if (appendChar === undefined) appendChar = ch; - if (appendChar === replacement) appendChar = ' '; + if (!options.preserveReplacement && appendChar === replacement) appendChar = ' '; return result + appendChar // remove not allowed characters .replace(options.remove || /[^\w\s$*_+~.()'"!\-:@]+/g, '') diff --git a/test/slugify.js b/test/slugify.js index 356c4b7..3917544 100644 --- a/test/slugify.js +++ b/test/slugify.js @@ -50,6 +50,17 @@ describe('slugify', () => { t.equal(slugify('foo bar baz', {replacement: ''}), 'foobarbaz') }) + it('options.preserveReplacement keeps existing separators', () => { + t.equal(slugify('1952--', {preserveReplacement: true}), '1952--') + t.equal(slugify('step -1', {preserveReplacement: true}), 'step--1') + t.equal(slugify('step 1', {preserveReplacement: true}), 'step-1') + t.equal(slugify('step _1', { + replacement: '_', + preserveReplacement: true + }), 'step__1') + t.equal(slugify('1952--'), '1952') + }) + it('options.remove', () => { t.equal(slugify( 'foo *+~.() bar \'"!:@ baz',