ConvConv

Super simple, zero dependency naming convention converter and validator library.

Cli

As of version 0.3.3 there is cli version of convconv available. Use the following command to install it globally onto your system. npm i -g convconv You can see help for cli by running the following command. convconv --help

Examples

1import convconv from "convconv";
2
3// examples:
4//   camelCase
5//   kebab-case
6//   PascalCase
7//   snake_case
8//   SCREAMING-KEBAB-CASE
9//   SCREAMING_SNAKE_CASE
10
11// converts camelCase to kebab-case
12// camelCase -> camel-case
13convconv.fromCamel("camelCase").toKebab();
14
15// converts kebab-case to snake_case
16// kebab-case -> kebab_case
17convconv.fromConvention("kebab", "kebab-case").toSnake();
18
19// converts any case to PascalCase
20convconv
21  .autoFrom("your-input-in-one-of-available-naming-conventions")
22  .toPascal();
23
24// throws ConventionNotFoundError
25convconv.autoFrom("Random_sTring-with_nOConvention");
26
27// returns 'kebab'
28convconv.getConvention("some-kebab-case-string");
29
30// throws ConventionNotFoundError
31convconv.getConvention("Random_sTring-with_nOConvention");
32
33// returns true
34convconv.isPascal("PascalCase");
35
36// returns true
37convconv.isConvention("pascal", "PascalCase");
38
39// throws ConventionViolationError
40convconv.fromKebab("NotKebab");
41
42// throws ConventionViolationError
43convconv.fromCamel("123startingWithNumber");

Errors

All errors extend from ConvConvError.