Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add monorepo instructions to the README #68

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add monorepo instructions to the README #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions readme.md
View file
Open in desktop
Expand Up @@ -48,6 +48,23 @@ import "@total-typescript/ts-reset";

3. Enjoy improved typings across your _entire_ project.

## Get Started (Monorepo)

1. Install: `npm i -D @total-typescript/ts-reset` to your root package.json

2. Create a `reset.d.ts` file in the root of your project:

```ts
import "@total-typescript/ts-reset";
```

3. In your individual packages `tsconfig.json`, add the relative path from your package to the `reset.d.ts` file
```json
"include": [
"../../reset.d.ts",
]
```

### Installing only certain rules

By importing from `@total-typescript/ts-reset`, you're bundling _all_ the recommended rules.
Expand Down