README.md
1# **heck** is a case conversion library
2
3
4
5This library exists to provide case conversion between common cases like
6CamelCase and snake_case. It is intended to be unicode aware, internally
7consistent, and reasonably well performing.
8
9## Definition of a word boundary
10
11Word boundaries are defined as the "unicode words" defined in the
12`unicode_segmentation` library, as well as within those words in this manner:
13
141. All underscore characters are considered word boundaries.
152. If an uppercase character is followed by lowercase letters, a word boundary
16is considered to be just prior to that uppercase character.
173. If multiple uppercase characters are consecutive, they are considered to be
18within a single word, except that the last will be part of the next word if it
19is followed by lowercase characters (see rule 2).
20
21That is, "HelloWorld" is segmented `Hello|World` whereas "XMLHttpRequest" is
22segmented `XML|Http|Request`.
23
24Characters not within words (such as spaces, punctuations, and underscores)
25are not included in the output string except as they are a part of the case
26being converted to. Multiple adjacent word boundaries (such as a series of
27underscores) are folded into one. ("hello__world" in snake case is therefore
28"hello_world", not the exact same string). Leading or trailing word boundary
29indicators are dropped, except insofar as CamelCase capitalizes the first word.
30
31### Cases contained in this library:
32
331. CamelCase
342. snake_case
353. kebab-case
364. SHOUTY_SNAKE_CASE
375. mixedCase
386. Title Case
39
40
41### Contributing
42
43PRs of additional well-established cases welcome.
44
45This library is a little bit opinionated (dropping punctuation, for example).
46If that doesn't fit your use case, I hope there is another crate that does. I
47would prefer **not** to receive PRs to make this behavior more configurable.
48
49Bug reports & fixes always welcome. :-)
50
51### License
52
53heck is distributed under the terms of both the MIT license and the
54Apache License (Version 2.0).
55
56See LICENSE-APACHE and LICENSE-MIT for details.
57
){kind=link}