Result unclear

[ulfgebhardt]

From the documentation it is completely unclear to me what the result of the slugify function is.

I expected /[a-z0-9_-]/ but my tests failed as there is an undefined number of special characters in the result.

The documentation hints to remove: /[*+~.()'"!:@]/g, and I assume that the result is [a-z0-9_-*+~.()'"!:@] but how would I know?

Please link me the location of this definition and consider to reference it in the README.md

[Trott]

If you want a predictable and narrow set of default characters in the slug, then the slug module might better suit your needs. It results in slugs that will match /[a-z0-9-]+/ if you use the default options. That's 37 characters total. It's the 26 lowercase letters of the English alphabet, 10 digits, and the "-" separator character. That's it.

Looking at slugify, the default slugs will result in 75 characters but I don't think you can depend on that necessarily always being the case the way you can probably be more certain that slug isn't going to add "$" or something weird like that. Anyway, the 75 characters are the 26 lowercase letters of the English alphabet, plus 26 uppercase characters of the English alphabet, plus 10 digits, plus 13 other characters: _*+~.()'"!-:@. This would appear to match your conclusion, except that it includes uppercase letters as well as lowercase letters.

I do see (thanks to a link in this issue helpfully placed there by the GitHub interface) that you removed slug from a project due to incompatibility with jest ("esm bullshit" apparently). I'm unaware of any compatibility issues there, mostly because I don't use jest, but I'm happy to try to address it in slug. Or if the 75 characters are fine for your needs, then slugify away! (I maintain slug but I also help maintain slugify so...doesn't matter to me....)

[Trott]

Closing because the question has been answered, but a pull request documenting things wouldn't be unwelcome by any means.