Add preserveTrailingDash option
#57
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
index.d.ts
Outdated
| /** | ||
| If your string ends with a dash, it will be preserved in the slugified string. | ||
|
|
||
| Sometimes trailing dashes are intentional, for example, when using slugify on an input field used for setting a slug. |
There was a problem hiding this comment.
I think this should be clearer that the main use-case for this is to allow validation while not preventing the user to write a slug.
There was a problem hiding this comment.
Not sure how exactly to formulate it, could you suggest an edit?
There was a problem hiding this comment.
I think you should give it a try first.
There was a problem hiding this comment.
How about now? 2142006
| @@ -133,6 +133,11 @@ test('leading underscore', t => { | |||
| t.is(slugify('____-___foo__bar', {preserveLeadingUnderscore: true}), '_foo-bar'); | |||
| }); | |||
|
|
|||
| test('trailing dash', t => { | |||
| t.is(slugify('foo bar-', {preserveTrailingDash: true}), 'foo-bar-'); | |||
| t.is(slugify('foo-bar--', {preserveTrailingDash: true}), 'foo-bar-'); | |||
There was a problem hiding this comment.
Add some more assertions. For example, foo-bar -, foo-bar , etc.
sindresorhus
changed the title
preserveTrailingDash option
|
Looks good :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm using
slugifyon an input for the user to create asluglike below:and so I want the user input to be slugified on the spot, but the problem is that the user cannot enter a dash in the input, since it will get removed.
With this PR, I should be able to do
slugify(value, {preserveTrailingDash: true})and make my use case work.It seems like a pretty generic use case so I thought I'd make a PR (looked at #43 for a code style reference).
P. S. I will need to call
slugifyonce more withoutpreserveTrailingDashbefore submitting the form to make sure I don't have a trailing dash in the final slug, but that's ok.