adds leading dash flag feature and corresponding tests #12
Conversation
| test("string reverse without leading dash", (t) => { | ||
| const str = "-kebab-case"; | ||
| t.equal(reverse(str), "KebabCase"); | ||
| }) |
There was a problem hiding this comment.
This test doesn't do what it says... According to the test's title the variable should be:
const str = "kebab-case";But that will give the result:
t.equal(reverse(str), "kebabCase");Which is not the reverse of what kebabCase outputs with leadingDashFlag=false.
That's my concern about this feature. So that needs to be documented in the readme along with the feature/flag itself.
There was a problem hiding this comment.
There's also a missing newline at the end of the file...
| module.exports = exports = function kebabCase(str) { | ||
| return str.replace(KEBAB_REGEX, function (match) { | ||
| return '-' + match.toLowerCase(); | ||
| module.exports = exports = function kebabCase(str, leadingDashFlag) { |
There was a problem hiding this comment.
"leadingDashFlag" should be named something better. Perhaps "stripLeadingDash"?
| let firstChar = kebab.charAt(1); | ||
| return ( | ||
| leadingDashFlag === false && | ||
| firstChar.toUpperCase() === firstChar | ||
| ? kebab.slice(1).toLowerCase() : kebab.toLowerCase() | ||
| ); |
There was a problem hiding this comment.
Here you are mixing tabs and spaces...
And you are doing unnecessary calls to toLowerCase() at the end.
What about simply writing the feature like this instead:
module.exports = exports = function kebabCase(str, stripLeadingDash) {
const kebab = str.replace(KEBAB_REGEX, function (match) {
return '-' + match.toLowerCase();
});
return stripLeadingDash && kebab[0] === '-' ? kebab.slice(1) : kebab;
};To me that is more readable and more clearly does what it says.
What do you think?
And a new `keepLeadingDash` option has been added to the kebabCase function. When set to `false` it will remove any leading dash from the kebab-cased string, in case the original string starts with a leading uppercase letter. Fixes #7, Closes #12. BREAKING CHANGE: kebab-case is rewritten in ESM and is not published as CommonJS anymore. If you still need CJS you should stick to the v1 version.
And a new `keepLeadingDash` option has been added to the kebabCase function. When set to `false` it will remove any leading dash from the kebab-cased string, in case the original string starts with a leading uppercase letter. Fixes #7, Closes #12. BREAKING CHANGE: kebab-case is rewritten in ESM and is not published as CommonJS anymore. If you still need CJS you should stick to the v1 version.
I'm pretty sure this could be done a bit cleaner, but I saw the opportunity to do a PR and took it. Hope this works :)