Skip to content

Commit

Permalink
fix(docs): update usage of typescript reset (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
nichtsam authored Jan 4, 2025
1 parent a8912bc commit d9b6e44
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,7 @@ Create a `tsconfig.json` file in your project root with the following content:
```json
{
"extends": ["@epic-web/config/typescript"],
"include": [
"@epic-web/config/reset.d.ts",
"**/*.ts",
"**/*.tsx",
"**/*.js",
"**/*.jsx"
],
"include": ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"],
"compilerOptions": {
"paths": {
"#app/*": ["./app/*"],
Expand All @@ -106,6 +100,12 @@ Create a `tsconfig.json` file in your project root with the following content:
}
```

Create a `reset.d.ts` file in your project with these contents:

```typescript
import '@epic-web/config/reset.d.ts'
```

<details>
<summary>Customizing TypeScript</summary>

Expand Down
4 changes: 2 additions & 2 deletions docs/decisions/001-reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ wouldn't want the reset to be applied.

## Decision

We'll create a `reset.d.ts` file and consumers will have to include it in their
`includes` manually.
We'll create a `reset.d.ts` file and consumers will have to import it in their
project manually.

## Consequences

Expand Down
1 change: 0 additions & 1 deletion reset.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import '@total-typescript/ts-reset'
import '@total-typescript/ts-reset/dom'

import 'react'
Expand Down

0 comments on commit d9b6e44

Please sign in to comment.