Project

code_caser

0.0
No commit activity in last 3 years
No release in over 3 years
A simple utility gem to convert files from snake_case to camelCase and and vice versa.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 3.4

Runtime

~> 0.8.1
~> 0.19.1
 Project Readme

CodeCaser

A simple Ruby command line utility that converts files from camelCase to snake_case and vice-versa.

Installation

To install:

$ gem install code_caser

Usage

$ code_caser
Commands:
  code_caser help [COMMAND]        # Describe available commands or one specific command
  code_caser to_camel --path=PATH  # converts files in PATH from snake_case to camelCase.
  code_caser to_snake --path=PATH  # converts files in PATH from camelCase to snake_case.

To use, pass in the path to the file or folder:

$ code_caser to_camel --path=/folder/subfolder/example_file.js

Passing a folder will convert all files in that folder (non-recursive):

$ code_caser to_camel --path=/folder/subfolder

code_caser will happily convert files in any directory with the required permissions, so exercise caution when passing in a directory! You will be presented a confirmation dialog before any files are converted.

You may also pass in a globbed directory to convert only files that match a given pattern:

$ code_caser to_camel --path=/folder/subfolder/*.js

If you have a mix of camelCase and snake_case names, you can use the analyze subcommand to determine if converting would potentially cause overlap with any existing names.

$ code_caser analyze to_camel --path=/folder/subfolder/example_file.js --verbose

This can help you avoid introducing bugs that would arise from using names that already exist in your code.

Options

Use the --verbose flag to print any changes made to each file to the terminal.

By default, backup copies of each file converted will be saved to a timestamped backup folder in the --path directory. You can prevent backups from being created by passing in the --no-save flag.

License

code_caser is available under the MIT License.