1 | # eslint-config-typescript-prettier
|
2 | [![Build Status](https://github.com/enter-at/eslint-config-typescript-prettier/workflows/Test/badge.svg)](https://github.com/enter-at/eslint-config-typescript-prettier/actions) [![Release](https://img.shields.io/npm/v/@enter-at/eslint-config-typescript-prettier.svg)](https://www.npmjs.com/package/@enter-at/eslint-config-typescript-prettier) [![Install size](https://packagephobia.com/badge?p=@enter-at/eslint-config-typescript-prettier)](https://packagephobia.com/result?p=@enter-at/eslint-config-typescript-prettier)
|
3 |
|
4 |
|
5 | Enterat's ESLint config with TypeScript and Prettier support.
|
6 |
|
7 |
|
8 | ---
|
9 |
|
10 |
|
11 | It's 100% Open Source and licensed under the [APACHE2](LICENSE).
|
12 |
|
13 | ## Quick Start
|
14 |
|
15 | Install `typescript`, `eslint` and `prettier`, `@enter-at/eslint-config-typescript-prettier` and put it into your `.eslintrc.js`.
|
16 |
|
17 | ```bash
|
18 | $ npm install typescript eslint prettier @enter-at/eslint-config-typescript-prettier --save-dev
|
19 | ```
|
20 |
|
21 | Update your `.eslintrc.js` file to contain at least the following lines.
|
22 |
|
23 | ```js
|
24 | module.exports = {
|
25 | extends: "@enter-at/typescript-prettier"
|
26 | };
|
27 | ```
|
28 | ## Help
|
29 |
|
30 | **Got a question?**
|
31 |
|
32 | File a GitHub [issue](https://github.com/enter-at/eslint-config-typescript-prettier/issues).
|
33 |
|
34 | ## Contributing
|
35 |
|
36 | ### Bug Reports & Feature Requests
|
37 |
|
38 | Please use the [issue tracker](https://github.com/enter-at/eslint-config-typescript-prettier/issues) to report any bugs or file feature requests.
|
39 |
|
40 | ### Developing
|
41 |
|
42 | If you are interested in being a contributor and want to get involved in developing this project, we would love to hear from you!
|
43 |
|
44 | In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
|
45 |
|
46 | 1. **Fork** the repo on GitHub
|
47 | 2. **Clone** the project to your own machine
|
48 | 3. **Commit** changes to your own branch
|
49 | 4. **Push** your work back up to your fork
|
50 | 5. Submit a **Pull Request** so that we can review your changes
|
51 |
|
52 | **NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
|