https://github.com/Dauta/uniform

Uniform is a CLI tool - code linter and formatter for JavaScript and TypeScript. Works using eslint and prettier under the hood.
https://github.com/Dauta/uniform

eslint linter prettier

Last synced: 3 months ago
JSON representation

Uniform is a CLI tool - code linter and formatter for JavaScript and TypeScript. Works using eslint and prettier under the hood.

• Host: GitHub
• URL: https://github.com/Dauta/uniform
• Owner: Dauta
• Created: 2022-02-07T22:28:43.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-20T23:20:32.000Z (almost 3 years ago)
• Last Synced: 2024-04-27T03:23:55.857Z (9 months ago)
• Topics: eslint, linter, prettier
• Language: TypeScript
• Homepage:
• Size: 382 KB
• Stars: 21
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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. 



## 💻 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](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension and setting up the "Format on save" option.

✨ Enjoy!