Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hotell/ts-setup
Monorepo for all things related to TsLint/TS setup
https://github.com/hotell/ts-setup
monorepo tslint tslint-config typescript typescript-configuration
Last synced: 27 days ago
JSON representation
Monorepo for all things related to TsLint/TS setup
- Host: GitHub
- URL: https://github.com/hotell/ts-setup
- Owner: Hotell
- License: mit
- Created: 2018-12-13T12:21:41.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-14T10:56:52.000Z (over 5 years ago)
- Last Synced: 2024-11-17T18:11:39.265Z (about 2 months ago)
- Topics: monorepo, tslint, tslint-config, typescript, typescript-configuration
- Language: JavaScript
- Homepage:
- Size: 315 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ts-setup
> Shared TypeScript and TSLint configs for sane developer
> **Enjoying/Using ts-setup packages ? 💪✅**
>
>
[](https://travis-ci.org/hotell/ts-setup)
[](https://lernajs.io/)
[](https://github.com/prettier/prettier)
[](https://github.com/conventional-changelog/standard-version)
[](https://conventionalcommits.org)
## Packages
This monorepo contains following packages 📦.
- [@martin_hotell/ts-config](./packages/ts-config): Shared base tsconfig.json
- [@martin_hotell/ts-lint-config](./packages/ts-lint-config): Shared tslint.json
## TS coding style-guides
> this style-guide consists mostly only rules, that can't be validate by TSLint
---
## Publishing
Execute `yarn release` which will handle following tasks:
- bump package version and git tag
- update/(create if it doesn't exist) CHANGELOG.md
- push to github master branch + push tags
- publish build packages to npm
> releases are handled by awesome [standard-version](https://github.com/conventional-changelog/standard-version)
### Pre-release
- To get from `1.1.2` to `1.1.2-0`:
`yarn release --prerelease`
- **Alpha**: To get from `1.1.2` to `1.1.2-alpha.0`:
`yarn release --prerelease alpha`
- **Beta**: To get from `1.1.2` to `1.1.2-beta.0`:
`yarn release --prerelease beta`
### Dry run mode
See what commands would be run, without committing to git or updating files
`yarn release --dry-run`
### Check what files are gonna be published to npm
- `yarn pack` OR `yarn release:preflight` which will create a tarball with everything that would get published to NPM
## Tests
Test are written and run via Jest 💪
```
yarn test
# OR
yarn test:watch
```
## Style guide
Style guides are enforced by robots, I meant prettier and tslint of course 🤖 , so they'll let you know if you screwed something, but most of the time, they'll autofix things for you. Magic right ?
### Style guide npm scripts
```sh
#Format and fix lint errors
yarn ts:style:fix
```
## Generate documentation
`yarn docs`
## Commit ( via commitizen )
- this is preferred way how to create conventional-changelog valid commits
- if you prefer your custom tool we provide a commit hook linter which will error out, it you provide invalid commit message
- if you are in rush and just wanna skip commit message validation just prefix your message with `WIP: something done` ( if you do this please squash your work when you're done with proper commit message so standard-version can create Changelog and bump version of your library appropriately )
`yarn commit` - will invoke [commitizen CLI](https://github.com/commitizen/cz-cli)
### Troubleshooting
## Licensing
[MIT](./LICENSE.md) as always
