snakecase

snakecase

Convert a string to snakecase. Similar to kebab-case but uses underscores instead of dashes.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm :

$ npm install --save snakecase

Prerequisites

Requires Node.js version >= 14.

Usage

const snakecase = require('snakecase');
// or
const { snakecase } = require('snakecase');

console.log(snakecase('a')); //=> 'a'
console.log(snakecase('foo bar baz')); //=> 'foo_bar_baz'
console.log(snakecase('  foo bar baz  ')); //=> 'foo_bar_baz'
console.log(snakecase('foo_bar-baz')); //=> 'foo_bar_baz'
console.log(snakecase('foo.bar.baz')); //=> 'foo_bar_baz'
console.log(snakecase('foo/bar/baz')); //=> 'foo_bar_baz'
console.log(snakecase('foo[bar)baz')); //=> 'foo_bar_baz'
console.log(snakecase('#foo+bar*baz')); //=> 'foo_bar_baz'
console.log(snakecase('$foo~bar`baz')); //=> 'foo_bar_baz'
console.log(snakecase('_foo_bar-baz-')); //=> 'foo_bar_baz'
console.log(snakecase('foo 2 bar 5 baz')); //=> 'foo_2_bar_5_baz'
console.log(snakecase('foo2bar5baz')); //=> 'foo2bar5baz'

Options

.preserveConsecutiveUppercase

Type: boolean

Default: false

This library attemps to sensibly match sequences of uppercase characters in a way that mirrors real-world usage. For example, the following is default behavior:

console.log(snakecase('JSONStringify')); //=> 'json_stringify
console.log(snakecase('TheIRSIsMean')); //=> 'the_irs_is_mean

However, if you wish to preserve upper case character sequences, you may pass an options object with the preserveConsecutiveUppercase option set to true:

console.log(snakecase('JSONStringify', { preserveConsecutiveUppercase: true })); //=> jsons_tringify
console.log(snakecase('TheIRSIsMean', { preserveConsecutiveUppercase: true })); //=> the_irsi_s_mean

.uppercase

Type: boolean

Default: false

Convert the output string to upper case.

console.log(snakecase('fooBarBaz', { uppercase: true })); //=> 'FOO_BAR_BAZ'
console.log(snakecase('FooBarBaz', { uppercase: true })); //=> 'FOO_BAR_BAZ'

Options

All options are passed to sindresorhus/camelcase, please visit that project to learn about all available options.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

Other awesome string libs you might like:

• pascalcase: Convert a string to pascal case (upper camelcase). | homepage
• romanize: Convert numbers to roman numerals (useful for books, outlines, documentation, slide decks, etc) | homepage
• word-wrap: Wrap words to a specified length. | homepage
• wordcount: Count the words in a string. Support for english, CJK and Cyrillic. | homepage

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2022, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.8.0, on June 21, 2022.