camelcase 0.1.0

Convert a dash/dot/underscore/space-separated string to camelCase (foo-bar -> fooBar). A faithful port of the camelcase npm package.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

# camelcase

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

[![crates.io](https://img.shields.io/crates/v/camelcase.svg)](https://crates.io/crates/camelcase)
[![docs.rs](https://docs.rs/camelcase/badge.svg)](https://docs.rs/camelcase)
[![CI](https://github.com/trananhtung/camelcase/actions/workflows/ci.yml/badge.svg)](https://github.com/trananhtung/camelcase/actions/workflows/ci.yml)
[![license](https://img.shields.io/crates/l/camelcase.svg)](#license)

**Convert a string to `camelCase`.**

`foo-bar` → `fooBar`, `foo_bar_baz` → `fooBarBaz`, `XML-http` → `xmlHttp`. Handles dash,
dot, underscore, and space separators, as well as existing camelCase/PascalCase and
acronyms. A faithful Rust port of the widely-used
[`camelcase`](https://www.npmjs.com/package/camelcase) npm package.

It is the inverse of [`decamelize`](https://crates.io/crates/decamelize).

- `PascalCase`, `preserve_consecutive_uppercase`, and `capitalize_after_number` options
- Differential-tested against the reference `camelcase` implementation

## Install

```toml
[dependencies]
camelcase = "0.1"
```

## Usage

```rust
use camelcase::{camel_case, camel_case_with, camel_case_slice, Options};

assert_eq!(camel_case("foo-bar"), "fooBar");
assert_eq!(camel_case("foo_bar_baz"), "fooBarBaz");
assert_eq!(camel_case("XML-http"), "xmlHttp");
assert_eq!(camel_case("p2p network"), "p2pNetwork");
assert_eq!(camel_case("foo123bar"), "foo123Bar");
assert_eq!(camel_case("__foo__bar__"), "__fooBar"); // leading _/$ preserved

// PascalCase:
assert_eq!(camel_case_with("foo-bar", Options::new().pascal_case(true)), "FooBar");

// Preserve consecutive uppercase runs:
assert_eq!(
    camel_case_with("XML-http", Options::new().preserve_consecutive_uppercase(true)),
    "XMLHttp"
);

// From a list of fragments:
assert_eq!(camel_case_slice(&["foo", "bar"], Options::default()), "fooBar");
```

## Options

| Option                            | Default | Effect                                                          |
| --------------------------------- | ------- | -------------------------------------------------------------- |
| `pascal_case`                     | `false` | Uppercase the first character (`FooBar`).                      |
| `preserve_consecutive_uppercase`  | `false` | Keep runs of uppercase letters (`XMLHttp` instead of `xmlHttp`). |
| `capitalize_after_number`         | `true`  | Treat a digit run as a word boundary (`foo123Bar`).            |

## Contributors ✨

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome — code, docs, bug reports, ideas, reviews! See the [emoji key](https://allcontributors.org/docs/en/emoji-key) for how each contribution is recognized, and open a PR or issue to get involved.

Thanks goes to these wonderful people:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/trananhtung"><img src="https://avatars.githubusercontent.com/u/30992229?v=4?s=100" width="100px;" alt="Tung Tran"/><br /><sub><b>Tung Tran</b></sub></a><br /><a href="https://github.com/trananhtung/./commits?author=trananhtung" title="Code">💻</a> <a href="#maintenance-trananhtung" title="Maintenance">🚧</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

## License

Licensed under either of [MIT](LICENSE-MIT) or [Apache-2.0](LICENSE-APACHE) at your option.