JSPM

  • Created
  • Published
  • Downloads 903081
  • Score
    100M100P100Q192181F
  • License MIT

camelCase, kebab-case, PascalCase... a simple integration with nano package size. (SMALL footprint!)

Package Exports

  • case-anything

Readme

Case anything 🐫

Total Downloads Latest Stable Version

npm i case-anything

10 case changing functions: camelCase, kebab-case, PascalCase and more...
A simple integration with nano package size. (SMALL footprint!)

Motivation

I created this package because most other packages that do simple case changing are so big...

I wanted to try my hand at the smallest iteration possible. (and it's 12+ times smaller than the next popular case changing package!!)

There's also a Better Touch Tool preset with keyboard shortcuts to convert selected text system wide!

Usage

case-anything supports tree-shaking and is side-effect free!

Strings without spaces

Name Input example Output example
🐪 camelCase camelCase('$catDog') catDog
🐫 PascalCase
UpperCamelCase
pascalCase('$catDog')
upperCamelCase
CatDog
🥙 kebab-case kebabCase('$catDog') cat-dog
🐍 snake_case snakeCase('$catDog') cat_dog
📣 CONSTANT_CASE constantCase('$catDog') CAT_DOG
🚂 Train-Case trainCase('$catDog') Cat-Dog
🕊 Ada_Case adaCase('$catDog') Cat_Dog
👔 COBOL-CASE cobolCase('$catDog') CAT-DOG
📍 Dot.notation dotNotation('$catDog') cat.Dog
📂 Path/case pathCase('$catDog') $cat/Dog
🛰 Space case spaceCase('$catDog') $cat Dog
🏛 Capital Case capitalCase('$catDog') $Cat Dog
🔡 lower case lowerCase('$catDog') $cat dog
🔠 UPPER CASE upperCase('$catDog') $CAT DOG

Special Characters

functions that strip away special characters* functions that keep special characters*
  • camelCase
  • pascalCase
  • kebabCase
  • snakeCase
  • constantCase
  • trainCase
  • adaCase
  • cobolCase
  • dotNotation
  • pathCase
  • spaceCase
  • capitalCase
  • lowerCase
  • upperCase
  • *You can control wether or not to keep or remove special characters like so:

    camelCase('$catDog') === 'catDog'
    // force keeping special characters:
    camelCase('$catDog', { keepSpecialCharacters: true }) === '$catDog'
    
    pathCase('$catDog') === '$cat/Dog'
    // force removing special characters:
    pathCase('$catDog', { keepSpecialCharacters: false }) === 'cat/Dog'

    Case Changing

    These cases do not change the casing of the words:

    • dotNotation
    • pathCase
    • spaceCase
    dotNotation('$catDog') === 'cat.Dog'
    // force lower case:
    dotNotation('$catDog').toLowerCase() === 'cat.dog'

    Strings with spaces

    As soon as there is a space in the target string, it will regard the input as a sentence and only split each part at the spaces.

    Name Input example Output example
    🐪 camelCase camelCase("I'm O.K.!") imOk
    🐫 PascalCase
    UpperCamelCase
    pascalCase("I'm O.K.!")
    upperCamelCase
    ImOk
    🥙 kebab-case kebabCase("I'm O.K.!") im-ok
    🐍 snake_case snakeCase("I'm O.K.!") im_ok
    📣 CONSTANT_CASE constantCase("I'm O.K.!") IM_OK
    🚂 Train-Case trainCase("I'm O.K.!") Im-Ok
    🕊 Ada_Case adaCase("I'm O.K.!") Im_Ok
    👔 COBOL-CASE cobolCase("I'm O.K.!") IM-OK
    📍 Dot.notation dotNotation("I'm O.K.!") Im.OK
    📂 Path/case pathCase("I'm O.K.!") I\'m/O.K.!
    🛰 Space case spaceCase("I'm O.K.!") I\'m O.K.!
    🏛 Capital Case capitalCase("I'm O.K.!") I\'m O.k.!
    🔡 lower case lowerCase("I'm O.K.!") i\'m o.k.!
    🔠 UPPER CASE upperCase("I'm O.K.!") I\'M O.K.!

    Also note, that multiple sequential spaces are treated as one space.

    When special characters are involved

    I have extended regular alphabet with the most common Latin-1 Supplement special characters.

    The coolest thing about this library is that it will "convert" special characters into regular alphabet for the cases used as variable names! 😎

    // CONVERTS special characters:
    camelCase('Çâfé Ågård')    === 'cafeAgard'
    pascalCase('Çâfé Ågård')   === 'CafeAgard'
    kebabCase('Çâfé Ågård')    === 'cafe-agard'
    snakeCase('Çâfé Ågård')    === 'cafe_agard'
    constantCase('Çâfé Ågård') === 'CAFE_AGARD'
    trainCase('Çâfé Ågård')    === 'Cafe-Agard'
    adaCase('Çâfé Ågård')      === 'Cafe_Agard'
    cobolCase('Çâfé Ågård')    === 'CAFE-AGARD'
    dotNotation('Çâfé Ågård')  === 'Cafe.Agard'
    
    // DOES NOT convert special characters:
    spaceCase('Çâfé Ågård')    === 'Çâfé Ågård'
    pathCase('Çâfé Ågård')     === 'Çâfé/Ågård'
    lowerCase('Çâfé Ågård')    === 'çâfé ågård'
    upperCase('Çâfé Ågård')    === 'ÇÂFÉ ÅGÅRD'
    capitalCase('Çâfé Ågård')  === 'Çâfé Ågård'

    Keyboard shortcuts

    With Better Touch Tool you can set up keyboard shortcuts to convert selected text with JavaScript. This repo provides an easy to install preset that has shortcuts for pascal, kebab and camel case! (thanks to @AndrewKoch) It even supports multi-cursors in VSCode!

    Here is an example triggering keyboard shortcuts to convert the selected text to PascalCase; kebab-case; camelCase:

    keyboard shortcuts example

    You can download the BTT preset from the source code: case-anything.bttpreset.

    Package size

    We'll compare this package with blakeembrey/change-case, a very famous package on npm.

    case-anything change-case
    camelCase 1.1K (572) 27.2K (6K)
    pascalCase 1.1K (561) 27.4K (6.1K)
    kebabCase 1.1K (541) 26.8K (5.9K)
    snakeCase 1.1K (540) 26.8K (5.9K)
    constantCase 1.1K (540) 27.2K (6K)
    pathCase 1K (530) 26.8K (5.9K)

    Source code

    What keeps my package small, is that literally just uses a regex to separate "words".

    // the source code is similar to:
    export function splitOnSpecialChars(string: string): any[] {
      return string.match(/^[a-z]+|[A-Z][a-z]+|[a-z]+|[0-9]+|[A-Z]+(?![a-z])/g)
    }

    The actual regex used is a little bit more comprehensive and can be found here.

    Meet the family (other utils)