Giter VIP home page Giter VIP logo

case-convention's Introduction

Case Convention NPM Package

Simple typescript package for case conversion. Automatically convert to desired case. Zero dependencies.

Supported case conversions:

  • snake_case
  • camelCase
  • PascalCase
  • MACRO_CASE (Alias: UPPER_CASE_SNAKE_CASE)
  • kebab-case (Alias: slug)
  • Train-case
  • flatcase (โš ๏ธWarning: cannot be converted back to other cases)
  • dot.case
  • Capitalize the string
  • Title The String
  • normalize the string

Installation

Run this command to install case-convention on your project.

npm install case-convention

Usage

Import

ES6 style import

import { Convention } from "case-convention"

Methods

  • Convert to title (capitalize every word)
    let str = "lorem.ipsum"
    console.log(Convention.title(str))
    // "Lorem Ipsum"
  • Convert to capitalized (capitalize the first letter only)
    let str = "Lorem-Ipsum"
    console.log(Convention.capitalized(str))
    // "Lorem ipsum"
  • Convert to normalized string (space-separated, all lower-case)
    let str = "LOREM_IPSUM"
    console.log(Convention.normalize(str))
    // "lorem ipsum"
  • Convert to snake_case
    let str = "LOREM_IPSUM"
    console.log(Convention.snakeCase(str))
    // "lorem_ipsum"
  • Convert to camelCase
    let str = "lorem.ipsum"
    console.log(Convention.camelCase(str))
    // "loremIpsum"
  • Convert to kebab-case or slug
    let str = "LoremIpsum"
    console.log(Convention.kebabCase(str))
    console.log(Convention.slug(str))
    // "lorem-ipsum"
  • Convert to PascalCase
    let str = "lorem ipsum"
    console.log(Convention.pascalCase(str))
    // "LoremIpsum"
  • Convert to Train-Case
    let str = "Lorem Ipsum"
    console.log(Convention.trainCase(str))
    // "Lorem-Ipsum"
  • Convert to MACRO_CASE or UPPER_CASE_SNAKE_CASE alias
    let str = "lorem.ipsum"
    console.log(Convention.macroCase(str))
    console.log(Convention.upperCaseSnakeCase(str))
    // "LOREM_IPSUM"
  • Convert to dot.case
    let str = "lorem_ipsum"
    console.log(Convention.dotCase(str))
    // "lorem.ipsum"
  • Convert to flatcase
    let str = "LOREM_IPSUM"
    console.log(Convention.flatCase(str))
    // "loremipsum"

Behavior & Error Handling

This package doesn't throw errors. Instead, improper input will return empty string. This package will also attempt to remove excess separators, as well as variable prefix.

// empty string as input returns empty string as output
console.log(Convention.snakeCase(""))
  // ""

// following prefixes are removed: "@", "_", "$"
console.log(Convention.slug("$centeredDiv"))
  // "centered-div"

// excess single separators are removed
console.log(Convention.normalize("DEFAULT____VALUE"))
  // "default value"
console.log(Convention.kebabCase("TOO   SPACIOUS"))
  // "too-spacious"

// multiple separators in an input returns empty string as output
// following symbols are considered as separator: " ", ".", "-", "_"
console.log(Convention.camelCase("face-to-face meeting"))
  // ""

Contribute

Experiencing issues? Need new features? Please go to this link and create new entry.

Also, feel free to submit pull requests.

Special Thanks

case-convention's People

Contributors

yogski avatar

Stargazers

Saiful Akbar avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.