https://github.com/metadevpro/ts-project-seed
Project seed with tooling for TypeScript
https://github.com/metadevpro/ts-project-seed
ci-mode coverage nodejs seed tdd-mode typescript
Last synced: about 2 months ago
JSON representation
Project seed with tooling for TypeScript
- Host: GitHub
- URL: https://github.com/metadevpro/ts-project-seed
- Owner: metadevpro
- License: cc0-1.0
- Created: 2017-09-25T08:37:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-16T21:25:24.000Z (over 1 year ago)
- Last Synced: 2025-05-08T00:13:34.816Z (about 2 months ago)
- Topics: ci-mode, coverage, nodejs, seed, tdd-mode, typescript
- Language: TypeScript
- Size: 790 KB
- Stars: 12
- Watchers: 1
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# ts-project-seed
TypeScript seed project. Use it to scaffold a TS project with all the tooling need to *properly* (opinated) set up a project.
[](https://travis-ci.org/metadevpro/ts-project-seed)
[](https://coveralls.io/github/metadevpro/ts-project-seed)
[](https://david-dm.org/metadevpro/ts-project-seed)
[](https://david-dm.org/metadevpro/ts-project-seed?type=dev)
[](https://snyk.io/test/github/metadevpro/ts-project-seed)
## How to use it
1. Clone from github
2. Remove origin to seed project
3. Change the license, metadata, etc. and start building.
```bash
git clone https://github.com/metadevpro/ts-project-seed
cd
git remote remove origin
npm (or yarn) install
```
## Features
Scripts provided:
### Lint
Linting using tslint.
```bash
npm run lint
```
### Clean
Clear the `dist/` folder.
```bash
npm run clean
```
### Build
Transpile TS code to JS in `dist/` folder. Maps included.
```bash
npm run build
```
Continous build:
```bash
npm run build:w
```
### Uglify
Concat and minify all JS files in `dist/` folder to one output (default `dist/all.min.js`).
```bash
npm run uglify
```
### Unit Test
Tests framework used are: mocha & chai.
TDD mode to run it concurrently with your editions:
```bash
npm run test:tdd
```
CI mode to run it only one:
```bash
npm test
```
Testing with coverage:
```bash
nyc npm test
nyc report -r text lcov html
coverage/index.html
```
### Coverage Test
TDD mode to run it concurrently with your editions:
```bash
npm run test:tdd
```
CI mode to run it only one:
```bash
npm run test
```
## Code Structure
- `/src` Place your TS code under this folder. Test also following the naming convention `*.spec.ts` next to file to be unit tested.
- `/dist` Output folder for transpiled project output.
- `/coverage` Output folder for coverage reports.
## Tools used
- `ts-node` Node tool to compile TS code on the fly.
- `mocha` Testing framework.
- `chai` Assertion framework.
- `rimraf` Safe cross-platform rmdir for clean step.
- `eslint` JS/TS linter.
- `prettier` for clean and consistent style-code.
- `typescript`, of course.
This project seed will be updated to keep the dependences up to date.
## License
This project seed is licensed as Public Domain. Therefore, do whatever you want including changing the license for your needs in your project.
More specifically, it was licensed as CC0 (Creative Commons 0) to further improve the freedom of a Public Domain Licence in context where it is not applicable.
## Credits
**Contact:** Pedro J. Molina | github: [pjmolina](https://github.com/pjmolina) | twitter: [pmolinam](https://twitter.com/pmolinam)
(c) 2017-2023. Metadev S.L. [https://metadev.pro](https://metadev.pro) twitter: [metad3v](https://twitter.com/metad3v)