snakecase

Convert a string to snake case.

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/string-snakecase-cli

Usage

Usage: snakecase [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.

Examples

$ snakecase 'hello world!'
hello_world

To use as a standard stream,

$ echo -n 'beEp booP' | snakecase
beep_boop

By default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.

$ echo -n 'beEp booP\tfooBar' | snakecase --split '\t'
beep_boop
foo_bar

See Also

• @stdlib/string-snakecase: convert a string to snake case.
• @stdlib/string-camelcase: convert a string to camel case.
• @stdlib/string-constantcase: convert a string to constant case.
• @stdlib/string-kebabcase: convert a string to kebab case.
• @stdlib/string-pascalcase: convert a string to Pascal case.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.