https://github.com/lostintime/devcon-ts
Development configs for TypeScript projects
https://github.com/lostintime/devcon-ts
Last synced: 2 months ago
JSON representation
Development configs for TypeScript projects
- Host: GitHub
- URL: https://github.com/lostintime/devcon-ts
- Owner: lostintime
- License: apache-2.0
- Created: 2018-09-05T15:32:32.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-03T13:45:28.000Z (over 3 years ago)
- Last Synced: 2025-02-23T11:36:16.162Z (over 1 year ago)
- Language: JavaScript
- Size: 490 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DEVCON-TS
[](https://travis-ci.org/lostintime/devcon-ts)
Opinionated development configs for TypeScript projects.
Package brings `devDependencies` required for [prettier](https://prettier.io/) and [conventional commits](https://www.conventionalcommits.org/) support.
## Installation
Install the package and link config files.
```
npm install --save-dev @lostintime/devcon-ts
```
### Conventional Commits
Dependencies brought by `@lostintime/devcon-ts`.
```
ln -s ./node_modules/@lostintime/devcon-ts/.huskyrc
ln -s ./node_modules/@lostintime/devcon-ts/.czrc
ln -s ./node_modules/@lostintime/devcon-ts/.lintstagedrc
ln -s ./node_modules/@lostintime/devcon-ts/.commitlintrc.json
```
### Prettier
```
ln -s ./node_modules/@lostintime/devcon-ts/.editorconfig
ln -s ./node_modules/@lostintime/devcon-ts/.prettierrc
```
### TypeScript
Extend `@lostintime/devcon-ts` in your `tsconfig.json`, ex:
```json
{
"extends": "@lostintime/devcon-ts",
"compilerOptions": {
"rootDir": "./src",
"outDir": "./dist",
"declarationDir": "./dist",
"composite": true
},
"include": ["src"]
}
```
### Testing
... with mocha, chai and nyc.
```
npm install --save-dev mocha chai @types/mocha @types/chai nyc
```
Link configs
```
ln -s ./node_modules/@lostintime/devcon-ts/.mocharc.json
ln -s ./node_modules/@lostintime/devcon-ts/.nycrc
```
### Updates
`mocha.opts` is not deprecated in favor of `.mocharc.json`