Skip to content

💄 NPM CLI Module to setup 'Prettier' with ESLint support

License

Notifications You must be signed in to change notification settings

1337z/prettier-setup

Repository files navigation

💅 Prettier Setup

styled with prettier Maintainability

Set up Prettier for your JavaScript and TypeScript projects with one command.

📦 Install with NPM

This will install the NPM module globally.

npm i -g prettier-setup

That´s it!

📋 Usage

Open a terminal in the root directory of your project. Type:

prettier-setup

.. and press return.

Choose a code language that you want to use and hit return (use arrow keys to select).

The setup will now install Prettier with ESLint support.

The setup will automatically create NPM scripts for you.
You can now use:

  • npm run format This will format every supported file.
  • npm run formatjs This will only format *.js files.

If you selected TypeScript you can also use:

  • npm run formatts This will only format *.ts files.
  • npm run compile This will run the TypeScriptCompiler (tsc) and format the

📋 Usage (JavaScript)

Open a terminal in the root directory of your project. Type:

prettier-setup -js

or

prettier-setup --javascript

.. and press return.
The setup will now install Prettier with ESLint support.

The setup will automatically create NPM scripts for you.
You can now use:

  • npm run format This will format every supported file.
  • npm run formatjs This will only format *.js files.

📋 Usage (JavaScript & TypeScript)

Open a terminal in the root directory of your project. Type:

prettier-setup -ts

or

prettier-setup --typescript

.. and press return.
The setup will now install Prettier with ESLint and TSLint support.

The setup will automatically create NPM scripts for you.
You can now use:

  • npm run format This will format every supported file.
  • npm run formatjs This will only format *.js files.
  • npm run formatts This will only format *.ts files.
  • npm run compile This will run the TypeScriptCompiler (tsc) and format the generated *.js files afterwards.