Skip to content

Adds a toKebabCase() method to the String prototype #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thibaultzanini wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Adds a toKebabCase() method to the String prototype #56

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95d33ec
feat: added toKebabCase method on String prototype
thibaultzanini Aug 14, 2025
16451de
feat: minor improvements
thibaultzanini Aug 15, 2025
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
29 changes: 28 additions & 1 deletion core/extras/string.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,33 @@ if (!String.prototype.toCamelCase) {
String.prototype.toLowerCamelCase.cache = Object.create(null);
}

if (typeof String.prototype.toKebabCase !== "function") {
const kebabCaseCache = Object.create(null);

/**
* Converts a string to kebab-case.
* @function external:String#toKebabCase
* @returns {string} The string converted to kebab-case.
* @example
* "Hello World".toKebabCase(); // "hello-world"
*/
Object.defineProperty(String.prototype, "toKebabCase", {
Copy link
Contributor

@marchant marchant Aug 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a KebabCaseConverter that uses an external dependency ( https://www.npmjs.com/package/just-kebab-case ) that is now at 4.2.0 vs
"just-kebab-case": "^4.0.1",
in mod's package.json.

The code us here:
https://github.com/angus-c/just/blob/master/packages/string-kebab-case/index.cjs

which seems a bit more complete than what you have here. I've known of Angus Croll the author for a while, it might take sense to keep those kind of low level dependencies.

In term of pattern, the method from this package is effectively a converter in mod's terms. So it would make sense to limit the dependencies for String to use Mod's KebabCaseConverter as the core logic, and if for some reason we decide to inline the code and remove the dependency, the the String's toKebabCase() method wouldn't need to change

value: function toKebabCase() {
if (!this) return "";
if (kebabCaseCache[this]) return kebabCaseCache[this];

kebabCaseCache[this] = this.trim()
.split(/[_\s-]+|(?<=[a-z])(?=[A-Z])/)
.map((word) => word.toLowerCase())
.join("-");

return kebabCaseCache[this];
},
writable: true,
configurable: true,
});
}

if(typeof String.prototype.removeSuffix !== "function") {
Object.defineProperty(String.prototype, "removeSuffix", {
value: function (suffix) {
Expand Down Expand Up @@ -290,7 +317,7 @@ if(typeof String.prototype.substringWithinRange !== "function") {
value: function substringWithinRange (aRange) {
/* substring:
indexStart: The index of the first character to include in the returned substring.

indexEnd: The index of the first character to exclude from the returned substring.
*/
return this.substring(aRange.includesBegin ? aRange.begin : (aRange.begin + 1), aRange.includesEnd ? (aRange.end + 1) : aRange.end)
Expand Down