feat: allow for second parameter on getSlug function for allowed char… #6695
Conversation
This file contains hidden or 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
…acters Signed-off-by: Brent Hoover <brent@thebuddhalodge.com>
🦋 Changeset detectedLatest commit: 71d29a4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Signed-off-by: Brent Hoover <brent@thebuddhalodge.com>
Signed-off-by: Brent Hoover <brent@thebuddhalodge.com>
Signed-off-by: Brent Hoover <brent@thebuddhalodge.com>
tedraykov
requested changes
Dec 9, 2022
packages/api-utils/lib/getSlug.js
Outdated
| @@ -4,14 +4,17 @@ const require = createRequire(import.meta.url); | |||
|
|
|||
| const { slugify } = require("transliteration"); | |||
|
|
|||
| const standardSlug = "a-zA-Z0-9-"; | |||
There was a problem hiding this comment.
The default allowedChars based on the transliteration documentation is a-zA-Z0-9-_.~'
packages/api-utils/lib/getSlug.js
Outdated
| /** | ||
| * @name getSlug | ||
| * @summary Return a slugified string using "slugify" from transliteration | ||
| * @see https://www.npmjs.com/package/transliteration | ||
| * @memberof Utils | ||
| * @param {String} slugString - string to slugify | ||
| * @param {String|Boolean} allowedChars - specify extra characters that are not removed by slugify |
There was a problem hiding this comment.
The official JSDocs syntax for optional parameter with default value:
Suggested change
| * @param {String|Boolean} allowedChars - specify extra characters that are not removed by slugify | |
| * @param {String} [allowedChars=a-zA-Z0-9-_.~'] - specify extra characters that are not removed by slugify |
Signed-off-by: Brent Hoover <brent@thebuddhalodge.com>
tedraykov
approved these changes
Dec 9, 2022
vanpho93
approved these changes
Dec 9, 2022
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.
Signed-off-by: Brent Hoover brent@thebuddhalodge.com
Impact: minor
Type: bugfix
Issue
getSlug in Tags needs to incorporate slashes however we should not change the global behavior which affects many other items
Solution
Provide a second parameter which allows you to specify allowedChar
Breaking changes
None
Testing
You should be able to create a tag with a slash in the name and have it retain the slash