@web-configs/typescript
v0.2.2
Published
A set of typescript configuration files that can be extended.
Downloads
260
Readme
@web-configs/typescript
In TypeScript, the configuration file can extend from a base file. This package provided a few common base configuration files to simplify TypeScript project setup.
To read more about how this extensibility works. See typescript handbook.
Below are two documentation we have also found useful to have on hand while setting up a configuration file.
Installation
$ yarn add --dev @web-configs/typescript
Usage
React Application Project
To start, create a tsconfig.json
in the root of your project.
A typical setup where the application sit in [project root]/app
folder is as follow:
{
"extends": "@web-configs/typescript/application.json",
"compilerOptions": {
"baseUrl": ".",
"rootDir": ".",
"paths": {"*": ["*", "app/*"]}
},
"include": ["./app/**/*", "./client/**/*", "./server/**/*", "./tests/**/*"]
}
React Library Project
Similarly for a react library project. Create a tsconfig.json
in the root of your project with a setup below assuming the library code sit in [project root]/src
folder.
{
"extends": "@web-configs/typescript/library.json",
"compilerOptions": {
"baseUrl": "./src",
"rootDir": "."
},
"include": ["./src/**/*"]
}
Next.js Project
Similarly for a react library project. Create a tsconfig.json
in the root of your project with a setup below assuming the library code sit in [project root]/src
folder.
{
"extends": "@web-configs/typescript/nextjs.json",
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
"exclude": ["node_modules"]
}
Project that run in the browser
A configuration file is provided that included styles setup and a more conservative build target.
{
"extends": "@web-configs/typescript/dom.json",
"compilerOptions": {
"baseUrl": ".",
"rootDir": "."
}
}
All Other Project
A base configuration file is also provided if the above does not fit your need.
{
"extends": "@web-configs/typescript/base.json",
"compilerOptions": {
"baseUrl": ".",
"rootDir": "."
}
}
Common Got Ya
Type Checking does not honour skipLibCheck: true
setting
There are times when the type failure occur inside of a library your project is consuming, and having skipLibCheck: true
does not resolved it. In this scenario, add an exclude
option to your tsconfig.json
.
eg.
{
"extends": "@web-configs/typescript/base.json",
"compilerOptions": {
"baseUrl": ".",
"rootDir": ".",
"exclude": ["./node_modules/**/*"]
}
}