An open API service indexing awesome lists of open source software.

https://github.com/osdevisnot/xo-quick

Setup javascript Formatting and Linting
https://github.com/osdevisnot/xo-quick

Last synced: 4 months ago
JSON representation

Setup javascript Formatting and Linting

Awesome Lists containing this project

README

        

# xo-quick

Setup javascript formatting and linting based on `xo` and `prettier` with `husksy` with only one dependency.

```bash
yarn add --dev xo-quick
```

## Why ?

I am a huge fan of `prettier`, but `prettier` focuses only on stylistic rules. To achieve better code quality, a linter like `eslint` is a must have in your toolchain.

I mostly created this package to help setting up new projects easier.

## How ?

This package brings in necessary dependencies and uses npm `postinstall` scripts to automatically setup javascript formatting and linting.

The `postinstall` script of `xo-quick` sets `pkg.prettier`, `pkg.husky` and `pkg.xo` properties in `package.json` if they do not already exist and remove `.prettierrc` and `prettier.config.js` if those files exist.