https://github.com/jgleitz/string-notation
Convert between different string notations commonly found in programming
https://github.com/jgleitz/string-notation
Last synced: 10 months ago
JSON representation
Convert between different string notations commonly found in programming
- Host: GitHub
- URL: https://github.com/jgleitz/string-notation
- Owner: jGleitz
- License: mit
- Created: 2020-01-09T19:21:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-25T16:57:38.000Z (10 months ago)
- Last Synced: 2025-02-25T17:39:32.635Z (10 months ago)
- Language: Kotlin
- Homepage:
- Size: 1.43 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# string-notation [](https://github.com/jGleitz/string-notation/actions) [](https://maven-badges.herokuapp.com/maven-central/de.joshuagleitze/string-notation)
_Convert between different string notations commonly found in programming._
Useful, for example, to build identifiers when generating code.
Also includes notations to build valid Java type or member names.
#### [API Documentation](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/)
## Notations
We support the following notations:
* General Programming
* [LowerCamelCase](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-lower-camel-case/), e.g. `thisIsMyString`
* [UpperCamelCase](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-upper-camel-case/), e.g. `ThisIsMyString`
* [SnakeCase](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-snake-case/), e.g. `this_is_MY_String`
* [ScreamingSnakeCase](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-screaming-snake-case/), e.g. `THIS_IS_MY_STRING`
* Java
* [JavaMemberName](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-java-member-name/), e.g. `thisIsMyString`
* [JavaTypeName](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-java-type-name/), e.g. `ThisIsMyString`
* [JavaConstantName](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-java-constant-name/), e.g. `THIS_IS_MY_STRING`
* [JavaPackageName](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-java-package-name/), e.g. `this.is.MY.String`
* [JavaPackagePart](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-java-package-part/), e.g. `thisismystring`
* Miscellaneous
* [NormalWords](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-normal-words/), e.g. `this is MY String`
## Usage
`string-notation` converts Strings from their notation into a [Word](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-word/), which is a notation-agnostic representation.
[Words](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-word/) can then be transformed into Strings in a notation again.
### Kotlin
```kotlin
import de.joshuagleitze.stringnotation.LowerCamelCase
import de.joshuagleitze.stringnotation.ScreamingSnakeCase
import de.joshuagleitze.stringnotation.fromNotation
// myVariable -> MY_VARIABLE
"myVariable".fromNotation(LowerCamelCase).toNotation(ScreamingSnakeCase)
```
```kotlin
import de.joshuagleitze.stringnotation.JavaTypeName
import de.joshuagleitze.stringnotation.NormalWords
import de.joshuagleitze.stringnotation.fromNotation
// 1 Type Name 4 You! -> TypeName4You
"1 Type Name 4 You!".fromNotation(NormalWords).toNotation(JavaTypeName)
```
### Java
```java
import de.joshuagleitze.stringnotation.LowerCamelCase;
import de.joshuagleitze.stringnotation.UpperCamelCase;
import static de.joshuagleitze.stringnotation.StringToWord.fromNotation;
// myVariable -> MY_VARIABLE
fromNotation("myVariable", UpperCamelCase.INSTANCE).toNotation(LowerCamelCase.INSTANCE);
```
```java
import de.joshuagleitze.stringnotation.JavaTypeName;
import de.joshuagleitze.stringnotation.NormalWords;
import static de.joshuagleitze.stringnotation.StringToWord.fromNotation;
// 1 Type Name 4 You! -> TypeName4You
fromNotation("1 Type Name 4 You!", NormalWords.INSTANCE).toNotation(JavaTypeName.INSTANCE);
```
## [Contributions welcome](http://contributionswelcome.org/)
All contributions (no matter if small) are always welcome.