Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fox1t/typescript-lib-starter
Stater kit for modern TypeScript library. Generate JS ready to be published on npm.
https://github.com/fox1t/typescript-lib-starter
Last synced: 4 months ago
JSON representation
Stater kit for modern TypeScript library. Generate JS ready to be published on npm.
- Host: GitHub
- URL: https://github.com/fox1t/typescript-lib-starter
- Owner: fox1t
- License: mit
- Created: 2018-09-21T13:10:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-19T16:35:49.000Z (over 3 years ago)
- Last Synced: 2024-10-18T06:30:06.912Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 103 KB
- Stars: 13
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript Lib Starter 
[](https://github.com/fox1t/typescript-lib-starter/actions)
[](https://github.com/microsoft/TypeScript)
[](https://github.com/prettier/prettier)
[](https://eslint.org)
[](https://github.com/tapjs/node-tap)
Starter kit for modern TypeScript libraries. Generates JavaScript ready to be published on npm.
Batteries included. Period.
- [Prettier](https://prettier.io/) and [ESLlint](https://eslint.org) for formatting and linting
- [ts-node](https://github.com/TypeStrong/ts-node) for tests execution
- [node-tap](https://github.com/tapjs/node-tap) for testing and code coverage
- [tap-mocha-reporter](https://github.com/tapjs/tap-mocha-reporter) for test reporting
- [GitHub Actions](https://github.com/features/actions) configuration file for github actions workflow
## Clone the repo
`$ git clone [email protected]:fox1t/typescript-lib-starter.git {your_project_name}`
`$ cd {your_project_name}`
## Remove reference to this starter and re-init package.json
`$ rm -rf .git && git init && npm init`
## Install development dependencies
`$ npm i`
## Add remote origin and make initial commit
`$ git remote add origin [email protected]:{your_repository}.git`
`$ git add .`
`$ git commit -m "Initial commit"`
`$ git push -u origin master`
## Scripts
- `npm run build`: build TypeScript sources to dist directory
- `npm publish`: builds and publishes lib to [npmjs.com](https://www.npmjs.com)
- `npm test`: run tests in `./test` directory using [tap](https://www.npmjs.com/package/tap)
- `npm run test:watch`: watches `./src/` and `./test/` folders and restarts compilation and tests
- `npm run test:report`: saves test report to `out.tap` file
- `npm run test:reporter`: converts `out.tap` file to junit
## External typings augmentation
This starter is already configured to allow you to extend typings of external packages. The logic behind it is based on [this](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-plugin-d-ts.html) official template. To augment a module, just create a folder with the same name as the module you are augmenting and add an index.d.ts in it. [Here](https://github.com/fox1t/fastify-websocket-router/tree/master/typings/fastify) you can find a real world example.
## Automatic Test and Code Coverage
Includes `azure-pipelines.yml` configuration file. You can build, test and publish code coverage on [Azure DevOps](https://docs.microsoft.com/en-us/azure/devops/organizations/public/?toc=%2Fazure%2Fdevops%2Forganizations%2Fpublic%2Ftoc.json&bc=%2Fazure%2Fdevops%2Forganizations%2Fpublic%2Fbreadcrumb%2Ftoc.json&view=azure-devops) for free with GitHub integration for OSS projects.
## Dev Dependencies
- `husky`: runs precommit `lint` hook
- `rimraf`: removes `lib` folder crossplatform
- `chokidar-cli`: file watcher
- `tap`: test runner
- `tap-mocha-reporter`: mocha reporter for tap
- `ts-node`: runs tests without compiling
- `prettier`
- `eslint`
- `eslint-config-prettier`: makes ESLint work nice with prettier
- `typescript`
## Spread the word
If you use this starter, add this badge to your project to help standardising TS library development.
`[](https://github.com/fox1t/typescript-lib-starter)`
[](https://github.com/fox1t/typescript-lib-starter)
## Node.js libraries built with TypeScript Lib Starter
- [fastify-flash](https://github.com/fastify/fastify-flash)
- [qs-to-mongo](https://github.com/fox1t/qs-to-mongo)
- [mongo-autoincrement](https://github.com/fox1t/mongo-autoincrement)
- [fastify-websocket-router](https://github.com/fox1t/fastify-websocket-router)
## License
MIT