cheesestrings v1.2.0

cheeseStrings

A couple of handy string methods, my first npm package

Installation:

npm install cheesestrings

Use:

String.capitalize() : capitalizes first character of a string:

"my string".capitalize()
// "My string"

String.toTitleCase() : capitalizes first character of every consecutive string of characters separated by a space:

"my other string".toTitleCase()
// "My Other String"

Neither method will have any effect on any other character:

"my stRING".capitalize()
// "My stRING"

"my otHER strinG".toTitleCase()
// "My OtHER StrinG"

String.alternateCaseWord() : alternates the case of a word. If first character in string is uppercase A-Z, first character of result will be uppercase, else it will start lowercase:

"string".alternateCaseWord()
// "sTrInG"

"Another".alternateCaseWord()
// "AnOtHeR"

String.reverse() : reverses a string:

"my other string".reverse()
// "gnirts rehto ym"

String.BEMinate(PMS=true, breakChar="\\|") : converts a string to a BEM style structure:

"block identifier | element selector | modifier class".BEMinate()
// "block-identifier__element-selector--modifier-class"

• Accepts two optional arguments:

  • PMS : prepended multiple selector, i.e. adds a period (.) character before the string.

  • breakChar : string used as break character, can be multiple characters. Regex special characters must be escaped with \\.

    "block |identifier| ||| element |selector| ||| modifier class".
      BEMinate(true, "\\|\\|\\|");
    // ".block-|identifier|__element-|selector|--modifier-class"

Contributions

At this time, I am working alone on this package. This section will be updated in due course.

Bugs / Features

Please raise bugs via this bug issue form.

Please raise new feature requests via this feature request form.

In due course, I aim to generate query forms and documentation forms, but for now, they will need to be submitted as blank issues. Please add relevant labels!

Acknowledgments

Big thanks to @SuzyBee1987 for inspiring me to create this. I realize there are other packages out there that may do similar things, but over time I hope to build up a library of useful String methods for all to use. Plus...it was quite good fun!