Git Product home page Git Product logo

case-police's Introduction

CasePolice

NPM version

  • GitHub, not Github
  • TypeScript, not Typescript
  • macOS, not MacOS
  • VS Code, not Vscode
  • ...

Make the case correct, PLEASE!

Usage

Make sure you have committed all unsaved works, and then

npx case-police --fix

It will scan all your source files and fix the cases of known names.

Only the word including both uppercase and lowercase will be fixed. (e.g. Github -> GitHub; github and GITHUB will be left untouched).

Using in CI

Simply add case-police (without --fix) to your workflow and it will exit with a non-zero code for your CI to catch it.

CLI Options

Options Description
--fix Rewrite changes to file
-d, --dict <path> Custom dictionary JSON, will be merged with original dict
--no-default Disable the default dictionary
--disable <rules> Disable rules, comma separated

Sponsors

License

MIT License © 2021 Anthony Fu

case-police's People

Contributors

antfu avatar pinkchampagne17 avatar webfansplz avatar rubiin avatar sajadhsm avatar chenli1989 avatar lencx avatar holazz avatar userquin avatar kecrily avatar timursaurus avatar sulco avatar wey-gu avatar malloryhayr avatar zyyv avatar action-hong avatar nejckorosec avatar leon-fong avatar romaixn avatar lukewarlow avatar mopig avatar kallyas avatar josh-cena avatar itpropro avatar ivetian avatar justineo avatar thecuvii avatar alany411 avatar

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.