Skip to content

Latest commit

 

History

History
42 lines (22 loc) · 1.41 KB

README.md

File metadata and controls

42 lines (22 loc) · 1.41 KB

Uniform 🦄🎩

All-in-one code linter and formatter for TypeScript and JavaScript

⚡️ Quickstart

  • Install the package:

npm install @dauta/uniform --save-dev or yarn add -D @dauta/uniform

  • Run the init command:

npx uniform or yarn uniform

Note: You might need to restart ESLint server in your IDE for the config files to get picked up.

🤔 What will this do?

Installing the package will install eslint and prettier as a dependency of your project, along with several plugins.

Running the uniform script, will generate configuration files based on your choices and copy them into the root of your project. This will allow your IDE (or whatever extension you're using to run eslint) to read the correct configurations and give realtime feedback on your code.

🐶 Friendly Output

Uniform is focused on user-friendlines and readability.

Screenshot 2022-02-08 at 23 40 10

💻 CLI

To lint your code manually, run npx uniform lint or yarn uniform lint.

Fix

To auto-fix some issues, add the --fix flag to the above command. That's it :)

🤩 Recommended Setup

We recommend running uniform with ESLint extension and setting up the "Format on save" option.

✨ Enjoy!