be-pretty

be-pretty

:lipstick: adds prettier to an existing project with all bells and whistles-including husky, lint-staged

Install

npm i be-pretty -g

Requires that you have npm/yarn and npx globally available

Usage

When you are in an old codebase which needs to be pretty now, and stay pretty forever and ever execute

be-pretty
  ✔ Installing prettier husky pretty-quick
  ✔ copying custom .prettierrc
  ✔ Updating package.json
  ✔ formatting existing codebase
``
Now you should have everything ready to just commit&push.

if your codebase is already pretty, but needs help in the future you may skip formatting with a flag `--skipFormatting`

Customize .prettierrc

by default, be-pretty creates this prettier config.

{
  "semi": false,
  "arrowParens": "always",
  "singleQuote": true
}

if you want to customize this, just run be-pretty setDefault -p="/path/to/your/defaultPrettierRc". You can omit the path and if there is a prettierc file in the current working directory it will be used. be-pretty will use this as default from now on.

Format all

if you just want to reformat everything, you can call be-pretty formatAll

All Commands

  be-pretty.ts setDefault  sets a .prettierrc file as your default, if ommited
                           will look for the .prettierrc file in CWD[aliases: d]
  be-pretty.ts formatAll   formats everything excluding node_modules[aliases: f]
  be-pretty.ts run         run the series of commands to make a codebase pretty
                                                                       [default]

FAQ

Will this work for a newly added languages as well?

Yes, the list of supported file extensions is not hardcoded anywhere, it's taken from prettier.getSupportInfo() so it will always format all the files prettier supports.