stakx / camelcaser

A .NET micro-library for converting "PascalCase" names to "camelCase".

CamelCaser

A small .NET library for converting identifiers to "camelCase".

partial interface ICamelCaser { }

nameof(ICamelCaser).ToLowerCamelCase();
// => "camelCaser"

What could this be useful for?

The main purpose behind this library is to be able to automatically derive suitable variable names from type names e.g. in Reflection-based tools. The usual .NET conventions state that variable names should be in "camelCase", while type names should be in "PascalCase".

While this conversion is a no-brainer for humans, it's actually made more complicated than one might realise at first by several .NET naming conventions:

• For interface types whose name starts with an I, that I should be dropped: IFruitPicker → fruitPicker (not iFruitPicker!)

• When there are several initial upper-case characters, all but the last of them should be lower-cased: IDESettings → ideSettings (not idesettings, nor idesEttings!)

• … but not if all characters are in upper-case: IDE → ide (not idE!)

This library takes care of that transformation, so that you don't have to.

How do I use it?

By importing the CamelCaser namespace, the following extension method becomes available:

• string.ToLowerCamelCase():
  Converts the original string to "camelCase" according to the rules shown above.

But it doesn't lower-case <some string> correctly!

If you think you've found a bug, please raise an issue so it can be looked into. (Make sure to mention the string that doesn't get formatted as expected, along with your expectation of how it should have been formatted.)

camelcaser's Issues

Transform for interface names not implemented yet

Since the library has no way of knowing whether a type name belongs to an interface or not, it's likely that the string.ToLowerCamelCase() method will have to be augmented with an options parameter.

Make available on NuGet as a source-only package

This could follow the same approach used by e.g. stakx/TypeNameFormatter.