https://github.com/pocket/tsconfig
https://github.com/pocket/tsconfig
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/pocket/tsconfig
- Owner: Pocket
- License: apache-2.0
- Created: 2022-03-18T23:30:21.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T05:23:14.000Z (about 1 year ago)
- Last Synced: 2025-04-14T06:29:10.785Z (about 1 year ago)
- Language: JavaScript
- Size: 117 KB
- Stars: 2
- Watchers: 13
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# TSConfig config
These are settings for TSConfig used by Pocket.
## What it does
This setups up your Typescript tslint settings based on best practices. Check the [tsconfig.json](https://github.com/Pocket/tsconfig/blob/main/tsconfig.json) file to see what is included. Feel free to override the rules that make sense for you.
## Installing
1. In your project folder, run:
```
npm i -D @pocket-tools/tsconfig # or yarn install --dev @pocket-tools/tsconfig
```
2. You will see several dependencies were installed. Now, create (or update) a `tsconfig.json` file with the following content:
If you don't already have one the NPM post install script will create it for you.
```json
{
"extends": "@pocket-tools/tsconfig",
"compilerOptions": {
"outDir": "dist",
"rootDir": "src"
},
"exclude": [
"node_modules/",
"dist/"
],
"include": [
"src/**/*.ts",
"src/config"
]
}
```
Concepts are used from