Strict shared tsconfig out-of-box
- Strictest configs with best practices.
- One-line of tsconfig.
- Support
ESM
andCommonJS
. - Support FE (eg: React) & BE (eg: Nest) project.
- Typescript 5.0+.
- Node 18+.
npm i @git-validator/tsconfig -D
For node project, you may need to install @types/node
additionally.
npm i @types/node -D
For frontend project (like React), you may need to install @types/web
additionally.
npm i @types/web -D
{
"extends": "@git-validator/tsconfig"
}
Here are the best practices if you are using this package.
├── src
│ └── index.ts
├── test
│ └── index.spec.ts
├── package.json
├── tsconfig.build.json
└── tsconfig.json
{
"extends": "@git-validator/tsconfig"
}
{
"extends": "./tsconfig",
"include": ["src"],
"exclude": ["**/*.spec.ts", "**/*.test.ts"],
"compilerOptions": {
"outDir": "dist"
}
}
├── apps
│ ├── app1
│ │ ├── src
│ │ │ └── main.ts
│ │ ├── test
│ │ │ └── main.spec.ts
│ │ ├── package.json
│ │ ├── tsconfig.build.json
│ │ └── tsconfig.json
│ └── app2
│ ├── src
│ │ └── main.ts
│ ├── test
│ │ └── main.spec.ts
│ ├── package.json
│ ├── tsconfig.build.json
│ └── tsconfig.json
├── package.json
└── tsconfig.json
{
"extends": "@git-validator/tsconfig"
}
{
"extends": "../../tsconfig"
}
{
"extends": "./tsconfig",
"include": ["src"],
"exclude": ["**/*.spec.ts", "**/*.test.ts"],
"compilerOptions": {
"outDir": "dist"
}
}
After installing @git-validator/tsconfig
, you can run npx tsconfig init
command to generate a tsconfig.json
file. Run npx tsconfig -h
for all commands details:
Usage: tsconfig [options] [command]
Options:
-h, --help display help for command
Commands:
init [options] init a tsconfig file
diff [options] show differences between recommended tsconfig and current project tsconfig
help [command] display help for command
MIT