packages/prettier-config-qiwi/README.md
# prettier-config-qiwi
[![CI](https://github.com/qiwi/lint-config-qiwi/workflows/CI/badge.svg)](https://github.com/qiwi/lint-config-qiwi/actions)
[![Test Coverage](https://api.codeclimate.com/v1/badges/8738098b0f0f4825da8b/test_coverage)](https://codeclimate.com/github/qiwi/lint-config-qiwi/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/8738098b0f0f4825da8b/maintainability)](https://codeclimate.com/github/qiwi/lint-config-qiwi/maintainability)
[![npm (scoped)](https://img.shields.io/npm/v/prettier-config-qiwi?label=npm&color=39f)](https://www.npmjs.com/package/prettier-config-qiwi)
[Prettier](https://prettier.io/) rules related to QIWI projects.
## Install
```bash
npm add prettier-config-qiwi -D
yarn add prettier-config-qiwi -D
```
## Usage
Add in your `package.json`:
```json
{
"prettier": "prettier-config-qiwi"
}
```
If you want overwrite some properties, you need import the file in a .prettierrc.js file and export the modifications:
```javascript
module.exports = {
...require('prettier-config-qiwi'),
semi: false,
}
```
[Run](https://prettier.io/docs/en/cli.html) format your code:
```bash
prettier --write "src/**/*.ts"
```
## Contribution
If you find this config not strong enough you may add additional rules, write some tests, and trigger assets generation.
```bash
yarn test
```
## License
[MIT](./LICENSE)