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. UpperCamelCase 342. lowerCamelCase 353. snake_case 364. kebab-case 375. SHOUTY_SNAKE_CASE 386. Title Case 397. SHOUTY-KEBAB-CASE 408. Train-Case 41 42## Contributing 43 44PRs of additional well-established cases welcome. 45 46This library is a little bit opinionated (dropping punctuation, for example). 47If that doesn't fit your use case, I hope there is another crate that does. I 48would prefer **not** to receive PRs to make this behavior more configurable. 49 50Bug reports & fixes always welcome. :-) 51 52## MSRV 53 54The minimum supported Rust version for this crate is 1.32.0. This may change in 55minor or patch releases, but we probably won't ever require a very recent 56version. If you would like to have a stronger guarantee than that, please open 57an issue. 58 59## License 60 61heck is distributed under the terms of both the MIT license and the 62Apache License (Version 2.0). 63 64See LICENSE-APACHE and LICENSE-MIT for details. 65
