Code Monkey home page Code Monkey logo

kebabier's Introduction

kebabier

What is this?

Kebabier is a minimal, zero dependency CLI tool that helps refactor JavaScript/TypeScript projects to use kebab-case naming convention for files & folders.

Why?

Well, because macOS is a case-insensitive file system by default. So when renaming myComponent.js into MyComponent.js, Git won't pick up the change in the file name.

Locally, everything may work just fine. but, other systems, for example, your GitHub Actions CI, will break complaining MyComponent.js doesn't exist ๐Ÿ˜•.

People really encounter this issue! look

Other than that, there are many advantages of using kebab-case naming convention.

How to Use?

npx kebabier <directory name>

Kebabier will kebab-case all ts(x)/js(x) files, directories, and sub-directories ๐Ÿš€. It will also update all import (including dynamic) & require to use the correct path.
When inside a git project, it will also re-index the files to make sure git will pick up the changes.

Example Usage

npx kebabier src

Will convert all files and directories inside src directory.

kebabier's People

Contributors

barsheshet avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

danielhreben

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.