stringcase

String case conversion and word splitting.

Usage

stringcase = require "mods.stringcase"

print(stringcase.snake("FooBar")) --> "foo_bar"

Functions

Basic:

Function	Description
lower(s)	Convert string to all lowercase.
upper(s)	Convert string to all uppercase.

Letter Case:

Function	Description
capitalize(s)	Capitalize the first letter and lowercase the rest.
sentence(s)	Convert string to sentence case (first letter uppercase, rest unchanged).
swapcase(s)	Swap case of each letter.

Word Case:

Function	Description
acronym(s)	Get acronym of words in string (first letters only).
camel(s)	Convert string to camelCase.
constant(s)	Convert string to CONSTANT_CASE (uppercase snake_case).
delimit(s, sep?)	Normalize to snake_case, then delimit words with a separator.
dot(s)	Convert string to dot.case.
kebab(s)	Convert string to kebab-case.
pascal(s)	Convert string to PascalCase.
path(s)	Convert string to path/case (slashes between words).
snake(s)	Convert string to snake_case.
space(s)	Convert string to space case (spaces between words).
title(s)	Convert string to Title Case (first letter of each word capitalized).

Basic

lower(s)

Convert string to all lowercase.

Parameters:

• s (string): Input string.

Return:

• lowercased (string): Lowercased string.

Example:

lower("foo_bar-baz") --> "foo_bar-baz"
lower("FooBar baz")  --> "foobar baz"

upper(s)

Convert string to all uppercase.

Parameters:

• s (string): Input string.

Return:

• uppercased (string): Uppercased string.

Example:

upper("foo_bar-baz") --> "FOO_BAR-BAZ"
upper("FooBar baz")  --> "FOOBAR BAZ"

Letter Case

capitalize(s)

Capitalize the first letter and lowercase the rest.

Parameters:

• s (string): Input string.

Return:

• capitalized (string): Capitalized string.

Example:

capitalize("foo_bar-baz") --> "Foo_bar-baz"
capitalize("FooBar baz")  --> "Foobar baz"

sentence(s)

Convert string to sentence case (first letter uppercase, rest unchanged).

Parameters:

• s (string): Input string.

Return:

• sentenceCased (string): Sentence-cased string.

Example:

sentence("foo_bar-baz") --> "Foo_bar-baz"
sentence("FooBar baz")  --> "FooBar baz"

swapcase(s)

Swap case of each letter.

Parameters:

• s (string): Input string.

Return:

• swapCased (string): Swap-cased string.

Example:

swapcase("foo_bar-baz") --> "FOO_BAR-BAZ"
swapcase("FooBar baz")  --> "fOObAR BAZ"

Word Case

acronym(s)

Get acronym of words in string (first letters only).

Parameters:

• s (string): Input string.

Return:

• acronym (string): Acronym string.

Example:

acronym("foo_bar-baz") --> "FBB"
acronym("FooBar baz")  --> "FBB"

camel(s)

Convert string to camelCase.

Parameters:

• s (string): Input string.

Return:

• camelCased (string): Camel-cased string.

Example:

camel("foo_bar-baz") --> "fooBarBaz"
camel("FooBar baz")  --> "fooBarBaz"

constant(s)

Convert string to CONSTANT_CASE (uppercase snake_case).

Parameters:

• s (string): Input string.

Return:

• constantCased (string): Constant-cased string.

Example:

constant("foo_bar-baz") --> "FOO_BAR_BAZ"
constant("FooBar baz")  --> "FOO_BAR_BAZ"

delimit(s, sep?)

Normalize to snake_case, then delimit words with a separator.

Parameters:

• s (string): Input string.
• sep? (string): Optional separator value (defaults to "").

Return:

• delimited (string): String with normalized words separated by sep.

Example:

delimit("foo_bar-baz", "-") --> "foo-bar-baz"
delimit("FooBar baz", "-")  --> "foo-bar-baz"

dot(s)

Convert string to dot.case.

Parameters:

• s (string): Input string.

Return:

• dotCased (string): Dot-cased string.

Example:

dot("foo_bar-baz") --> "foo.bar.baz"
dot("FooBar baz")  --> "foo.bar.baz"

kebab(s)

Convert string to kebab-case.

Parameters:

• s (string): Input string.

Return:

• kebabCased (string): Kebab-cased string.

Example:

kebab("foo_bar-baz") --> "foo-bar-baz"
kebab("FooBar baz")  --> "foo-bar-baz"

pascal(s)

Convert string to PascalCase.

Parameters:

• s (string): Input string.

Return:

• pascalCased (string): Pascal-cased string.

Example:

pascal("foo_bar-baz") --> "FooBarBaz"
pascal("FooBar baz")  --> "FooBarBaz"

path(s)

Convert string to path/case (slashes between words).

Parameters:

• s (string): Input string.

Return:

• pathCased (string): Path-cased string.

Example:

path("foo_bar-baz") --> "foo/bar/baz"
path("FooBar baz")  --> "foo/bar/baz"

snake(s)

Convert string to snake_case.

Parameters:

• s (string): Input string.

Return:

• snakeCased (string): Snake-cased string.

Example:

snake("foo_bar-baz") --> "foo_bar_baz"
snake("FooBar baz")  --> "foo_bar_baz"

space(s)

Convert string to space case (spaces between words).

Parameters:

• s (string): Input string.

Return:

• spaceCased (string): Space-cased string.

Example:

space("foo_bar-baz") --> "foo bar baz"
space("FooBar baz")  --> "foo bar baz"

title(s)

Convert string to Title Case (first letter of each word capitalized).

Parameters:

• s (string): Input string.

Return:

• titleCased (string): Title-cased string.

Example:

title("foo_bar-baz") --> "Foo Bar Baz"
title("FooBar baz")  --> "Foo Bar Baz"