Text.Casing

Conversions between several common identifier casing conventions:

• PascalCase - no spacing between words, first letter in word is uppercase, all others are lowercase.
• camelCase - like PascalCase, but the very first letter is lowercase.
• kebab-case - everything lowercase, dash delimits words.
• snake_Case - underscores delimit words, case is unrestricted.
• quiet_snake_case - underscores delimit words, everything lowercase.
• SCREAMING_SNAKE_CASE - underscores delimit words, everything uppercase.

Types

newtype Identifier a

An opaque type that represents a parsed identifier.

Constructors

Identifier

Fields

• unIdentifier :: [a]

Instances

Monad Identifier

Defined in Text.Casing

Methods

(>>=) :: Identifier a -> (a -> Identifier b) -> Identifier b

(>>) :: Identifier a -> Identifier b -> Identifier b

return :: a -> Identifier a

fail :: String -> Identifier a

Functor Identifier

Defined in Text.Casing

Methods

fmap :: (a -> b) -> Identifier a -> Identifier b

(<$) :: a -> Identifier b -> Identifier a

Applicative Identifier

Defined in Text.Casing

Methods

pure :: a -> Identifier a

(<*>) :: Identifier (a -> b) -> Identifier a -> Identifier b

liftA2 :: (a -> b -> c) -> Identifier a -> Identifier b -> Identifier c

(*>) :: Identifier a -> Identifier b -> Identifier b

(<*) :: Identifier a -> Identifier b -> Identifier a

Foldable Identifier

Defined in Text.Casing

Methods

fold :: Monoid m => Identifier m -> m

foldMap :: Monoid m => (a -> m) -> Identifier a -> m

foldr :: (a -> b -> b) -> b -> Identifier a -> b

foldr' :: (a -> b -> b) -> b -> Identifier a -> b

foldl :: (b -> a -> b) -> b -> Identifier a -> b

foldl' :: (b -> a -> b) -> b -> Identifier a -> b

foldr1 :: (a -> a -> a) -> Identifier a -> a

foldl1 :: (a -> a -> a) -> Identifier a -> a

toList :: Identifier a -> [a]

null :: Identifier a -> Bool

length :: Identifier a -> Int

elem :: Eq a => a -> Identifier a -> Bool

maximum :: Ord a => Identifier a -> a

minimum :: Ord a => Identifier a -> a

sum :: Num a => Identifier a -> a

product :: Num a => Identifier a -> a

Traversable Identifier

Defined in Text.Casing

Methods

traverse :: Applicative f => (a -> f b) -> Identifier a -> f (Identifier b)

sequenceA :: Applicative f => Identifier (f a) -> f (Identifier a)

mapM :: Monad m => (a -> m b) -> Identifier a -> m (Identifier b)

sequence :: Monad m => Identifier (m a) -> m (Identifier a)

Eq a => Eq (Identifier a)

Defined in Text.Casing

Methods

(==) :: Identifier a -> Identifier a -> Bool

(/=) :: Identifier a -> Identifier a -> Bool

Show a => Show (Identifier a)

Defined in Text.Casing

Methods

showsPrec :: Int -> Identifier a -> ShowS

show :: Identifier a -> String

showList :: [Identifier a] -> ShowS

Parsing

fromHumps :: String -> Identifier String

Convert from "humped" casing (camelCase or PascalCase)

fromKebab :: String -> Identifier String

Convert from kebab-cased-identifiers

fromSnake :: String -> Identifier String

Convert from snake_cased (either flavor)

fromWords :: String -> Identifier String

fromAny :: String -> Identifier String

Convert from anything, including mixed casing.

Generating

toCamel :: Identifier String -> String

To camelCase

toPascal :: Identifier String -> String

To PascalCase

toSnake :: Identifier String -> String

To snake_Case

toQuietSnake :: Identifier String -> String

To quiet_snake_case

toScreamingSnake :: Identifier String -> String

To SCREAMING_SNAKE_CASE

toKebab :: Identifier String -> String

To kebab-case

toWords :: Identifier String -> String

To word Case

Shorthand functions

pascal :: String -> String

Directly convert to PascalCase through fromAny

camel :: String -> String

Directly convert to camelCase through fromAny

snake :: String -> String

Directly convert to snake_Case through fromAny

quietSnake :: String -> String

Directly convert to quiet_snake_case through fromAny

screamingSnake :: String -> String

Directly convert to SCREAMING_SNAKE_CASE through fromAny

kebab :: String -> String

Directly convert to kebab-case through fromAny

wordify :: String -> String

Directly convert to word Case through fromAny

Miscellaneous

dropPrefix :: Identifier String -> Identifier String

Drop the first word from a parsed identifier. Typical usage is between parsing and writing, e.g.: toKebab . dropPrefix . fromAny $ "strHelloWorld" == "hello-world"