@mateoserrano/simple-config 1.1.7 → 1.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,25 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Simple configuration for TypeScript development
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## Overview
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
This package provides a quite simple configuration for common tools in
|
|
6
|
+
TypeScript development. It will install the following dependencies to
|
|
7
|
+
your project:
|
|
8
|
+
|
|
9
|
+
1. TypeScript (tsx)
|
|
6
10
|
2. ESLint
|
|
7
11
|
3. Prettier
|
|
8
12
|
4. lint-staged
|
|
9
13
|
5. Husky
|
|
14
|
+
|
|
15
|
+
And will configure husky to run only lint-staged when pre-committing.
|
|
16
|
+
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
The following commands will install the package and configure it for your
|
|
20
|
+
project.
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm i -D @mateoserrano/simple-config
|
|
24
|
+
npx dev-config
|
|
25
|
+
```
|