Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SAINIAbhishek committed Nov 21, 2024
1 parent daeb39d commit 5c60fac
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ If you are developing a production application, we recommend updating the config
"module": "ESNext",
"moduleResolution": "node",
"jsx": "react-jsx",
"allowJs": true,
"strict": true,
"noImplicitAny": true,
"strictNullChecks": true,
Expand Down Expand Up @@ -80,7 +81,13 @@ If you are developing a production application, we recommend updating the config
## Includes and Excludes

```json
"include": ["src/**/*.ts", "src/**/*.tsx", "./vite.config.ts"],,
"include": [
"src/**/*.ts",
"src/**/*.tsx",
"./vite.config.ts",
"./tailwind.config.js",
"./postcss.config.js"
],
"exclude": ["node_modules", "dist"]
```

Expand Down Expand Up @@ -119,20 +126,15 @@ If you are developing a production application, we recommend updating the config

```json
{
"extends": "./tsconfig.base.json",
"extends": "./tsconfig.json",
"compilerOptions": {
"types": ["vitest/globals", "vitest", "@testing-library/jest-dom"],
"noUnusedLocals": false,
"noUnusedParameters": false
"target": "ESNext",
"module": "ESNext",
"types": ["@testing-library/jest-dom", "node"],
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"skipLibCheck": true,
"noEmit": true
}
}
```

## Test Configuration Explanation

- **extends:** Inherits from tsconfig.base.json, so the settings from the base configuration are shared across all configurations.
- **types:** Specifies additional type definitions for testing. This includes types for Vitest and Jest DOM, which are commonly used in testing React components:
- **vitest/globals:** Global types for Vitest.
- **vitest:** Types for Vitest itself.
- **@testing-library/jest-dom:** Types for testing React components with Jest DOM.
- **noUnusedLocals and noUnusedParameters:** These are set to false during testing to allow temporary or incomplete code while writing tests, where unused variables and parameters might be present.

0 comments on commit 5c60fac

Please sign in to comment.