@itrocks/rename
v0.0.10
Published
Switch the formatting of names stored in strings between different naming conventions
Downloads
705
Maintainers
Readme
rename
Switch the formatting of names stored in strings between different naming conventions.
Overview
This library provides functions to transform strings between various naming conventions, along with a class that extends the native String object with these transformations.
Installation
npm i @itrocks/rename
Usage
Importing the Functions
You can use the provided functions to convert strings between naming conventions:
import { toVariable } from '@itrocks/rename'
console.log(toVariable('ThisName'))
//> thisName
Using the Str
Class
Alternatively, you can use the Str class for an object-oriented approach:
import Str from '@itrocks/rename'
console.log(new Str('ThisName').toColumn())
//> this_name
API
All functions accept a string as their argument and return the transformed string. The input string can follow any of the supported naming conventions.
lcFirst
Converts the first character of the string to lowercase.
import { lcFirst } from '@itrocks/rename'
console.log(lcFirst('Hello World'))
//> hello World
toClass
Converts the string to the class naming convention.
import { toClass } from '@itrocks/rename'
console.log(toClass('hello_world'))
//> HelloWorld
toColumn
Converts the string to the column naming convention.
import { toColumn } from '@itrocks/rename'
console.log(toColumn('HelloWorld'))
//> hello_world
toDisplay
Converts the string to a human-readable display format.
import { toDisplay } from '@itrocks/rename'
console.log(toDisplay('helloWorld'))
//> hello world
toRoute
Converts the string to the route-to-feature naming convention.
import { toRoute } from '@itrocks/rename'
console.log(toRoute('HelloWorld'))
//> hello-world
toVariable
Converts the string to the variable naming convention.
import { toVariable } from '@itrocks/rename'
console.log(toVariable('HelloWorld'))
//> helloWorld
ucFirst
Converts the first character of the string to uppercase.
import { ucFirst } from '@itrocks/rename'
console.log(ucFirst('hello, world'))
//> Hello, world
Str Class
The Str class extends the native JavaScript String object and includes all the transformation methods listed above.
import Str from '@itrocks/rename'
const str = new Str('hello_world')
console.log(str.toClass())
//> HelloWorld
console.log(str.toDisplay())
//> hello world