Skip to content

Commit 1cdbbf9

Browse files
authored
Merge pull request #38 from koonfoon:edit-readme
docs: 📝 add description for eslint-prettier sub gen
2 parents c5e57bb + ca13a76 commit 1cdbbf9

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
vscode with typescript and jest project generator. This package generate the project skeleton for visual studio code that use [typescript](https://www.typescriptlang.org/) as source code, and [jest](https://jestjs.io/) for unit test, [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) for linting and [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for prettier codes. This generator also compose with [generator-license](https://github.com/jozefizso/generator-license).
66

7+
For those who only need to setup eslint and prettier. Use the sub generator. (See instruction below)
8+
79
This generator will also setup [tsup](https://github.com/egoist/tsup), a tool for bundling codes into commonjs and esm at the same time.
810

911
## Installation
@@ -21,6 +23,15 @@ Then generate your new project:
2123
yo vscode-typescript-jest
2224
```
2325

26+
### Sub generator
27+
28+
```bash
29+
yo vscode-typescript-jest:eslint-prettier
30+
```
31+
32+
> **Note**
33+
> When using sub generator. If package.json already exist in the project, a warning message will be display. Giving you an warning that package.json is about to be overwritten, and asking user permission to proceed. But in reality, it does not overwrite the WHOLE package.json file, just inserting the dev dependencies for eslint and prettier. User can enter "d" option to see what will be inserted to the package.json before enter "y" option.
34+
2435
> **Note**
2536
> You should run `npx npm-check-updates` check and update the dependencies, as newer version may had released since the publication of this generator.
2637

0 commit comments

Comments
 (0)