You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
武俊涛 5321b9e72d 生成 10 months ago
..
dist 生成 10 months ago
LICENSE 生成 10 months ago
README.md 生成 10 months ago
package.json 生成 10 months ago

README.md

🧵 Scule

npm version npm downloads Github Actions Codecov bundle

Install

Install using npm or yarn:

npm i scule
# or
yarn add scule

Import:

// CommonJS
const { pascalCase } = require('scule')

// ESM
import { pascalCase } from 'scule'

Notice: You may need to transpile package for legacy environments

Utils

pascalCase(str)

Splits string and joins by PascalCase convention (foo-bar => FooBar)

Remarks:

  • If an uppercase letter is followed by other uppercase letters (like FooBAR), they are preserved

camelCase

Splits string and joins by camelCase convention (foo-bar => fooBar)

kebabCase(str)

Splits string and joins by kebab-case convention (fooBar => foo-bar)

Remarks:

  • It does not preserve case

snakeCase

Splits string and joins by snake_case convention (foo-bar => foo_bar)

upperFirst(str)

Converts first character to upper case

lowerFirst(str)

Converts first character to lower case

splitByCase(str, splitters?)

  • Splits string by the splitters provided (default: ['-', '_', '/', '.])
  • Splits when case changes from lower to upper or upper to lower
  • Ignores numbers for case changes
  • Case is preserved in returned value
  • Is an irreversible function since splitters are omitted

License

MIT