# @spudly/config-config

<!-- config-config:badges-start -->
<!-- prettier-ignore-start -->
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/spudly/config-config/build?style=flat-square)
[![Codecov](https://img.shields.io/codecov/c/github/spudly/config-config?style=flat-square)](https://codecov.io/gh/spudly/config-config)
[![version](https://img.shields.io/npm/v/@spudly/config-config.svg?style=flat-square)](https://www.npmjs.com/package/@spudly/config-config)
[![downloads](https://img.shields.io/npm/dm/@spudly/config-config.svg?style=flat-square)](http://www.npmtrends.com/@spudly/config-config)
[![NPM](https://img.shields.io/npm/l/@spudly/config-config?style=flat-square)](https://github.com/spudly/config-config/blob/master/LICENSE.md)

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)
[![Code of Conduct](https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square)](https://github.com/spudly/config-config/blob/master/CODE_OF_CONDUCT.md)

[![Watch on GitHub](https://img.shields.io/github/watchers/spudly/config-config.svg?style=social)](https://github.com/spudly/config-config/watchers)
[![Star on GitHub](https://img.shields.io/github/stars/spudly/config-config.svg?style=social)](https://github.com/spudly/config-config/stargazers)
[![Tweet](https://img.shields.io/twitter/url/https/github.com/spudly/config-config.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20config-config%20https%3A%2F%2Fgithub.com%2Fspudly%2Fconfig-config)
<!-- prettier-ignore-end -->

<!-- config-config:badges-end -->

Configures all the configurations for you.

## Features

This package creates & maintains the following configurations:

- package.json
- README.md
- LICENSE.md (ISC)
- CONTRIBUTING.md
- CODE_OF_CONDUCT.md
  ([Contributor Covenant](https://www.contributor-covenant.org), version 2.0)
- [commitlint](https://commitlint.js.org/) (conventional commits)
- [eslint](https://eslint.org/) w/
  [@spudly/eslint-config](https://www.npmjs.com/package/@spudly/eslint-config)
- [github actions](https://github.com/features/actions)
- [husky](https://github.com/typicode/husky)
- [jest](https://jestjs.io/)
- [lint-staged](https://github.com/okonet/lint-staged)
- [prettier](https://prettier.io/)
- [semantic-release](https://semantic-release.gitbook.io/semantic-release/)
- [sort-package-json](https://github.com/keithamus/sort-package-json#readme)
- [typescript](https://www.typescriptlang.org/)
- [codecov](https://www.codecov.io/)
- [all-contributors](https://github.com/all-contributors/all-contributors)

## Installation

`npm install --save-dev @spudly/config-config`

## Usage

Just run `npx config-config`.

After the first run, you should rarely have to manually run it again because it
registers itself as a pre-commit hook.

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://www.stephensorensen.com/"><img src="https://avatars0.githubusercontent.com/u/487068?v=4" width="100px;" alt=""/><br /><sub><b>Stephen John Sorensen</b></sub></a><br /><a href="https://github.com/spudly/config-config/commits?author=spudly" title="Code">💻</a></td>
  </tr>
</table>

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!