Skip to content

Commit

Permalink
fix: remove some configuration options, and add them as optional in r…
Browse files Browse the repository at this point in the history
…eadme
  • Loading branch information
Sławomir Marciniak committed May 15, 2023
1 parent d5eacf2 commit a9783a9
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 16 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,29 @@ This package contains a universal tsconfig file that is optimized for browser, l
}
```

4. Optionally, customize the configuration options based on your project setup::

- `rootDir`: set the root directory of your project(see ([rootDir](https://www.typescriptlang.org/tsconfig#rootDir))):

- `include`: specify which files should be included in the compilation process (see ([include](https://www.typescriptlang.org/tsconfig#include))):

- `exclude`: specify which files should be excluded from the compilation process (see([exclude](https://www.typescriptlang.org/tsconfig#exclude))):

Here's an example with customized options:
```json
{
"extends": "@getresponse/tsconfig/configs/browser/tsconfig.json",
"rootDir": "src",
"include": [
"src/**/*",
"types/**/*"
],
"exclude": [
"node_modules",
"src/example-nested"
]
}
```


That's it! Now you can enjoy the benefits of using a standardized tsconfig file in your TypeScript projects.
3 changes: 2 additions & 1 deletion configs/node-lts/tsconfig.cjs.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
"module": "commonjs",
"target": "es2022"
}
}
}

15 changes: 0 additions & 15 deletions configs/tsconfig.base.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
"moduleResolution": "nodenext",
"rootDir": "./src",
"noImplicitReturns": true,
"suppressImplicitAnyIndexErrors": true,
"noUnusedLocals": false,
"forceConsistentCasingInFileNames": true,
"skipLibCheck": true,
Expand All @@ -29,18 +28,4 @@
"resolveJsonModule": true,
"importHelpers": true
},
"include": [
"src/**/*",
"types/**/*"
],
"exclude": [
"node_modules",
"build",
"scripts",
"config",
"*/**/*.test.ts",
"*/**/*.test.tsx",
"lib",
"dist"
]
}

0 comments on commit a9783a9

Please sign in to comment.