https://github.com/owsas/typescript-module-template

A typescript boilerplate to publish modules to npm
https://github.com/owsas/typescript-module-template

bootstrap javascript module template typescript

Last synced: about 1 year ago
JSON representation

A typescript boilerplate to publish modules to npm

• Host: GitHub
• URL: https://github.com/owsas/typescript-module-template
• Owner: owsas
• Created: 2017-10-22T21:52:06.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-09-14T11:30:32.000Z (over 7 years ago)
• Last Synced: 2025-04-19T18:53:41.894Z (about 1 year ago)
• Topics: bootstrap, javascript, module, template, typescript
• Language: Shell
• Size: 101 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Typescript module template

A typescript boilerplate to publish modules to npm. Also available as a `yeoman` generator, here: https://github.com/owsas/generator-typescript-module

## Dev mode

Clone this repo, and start adding your code in the `index.ts` file.  

When you are done, write the tests in the `index.test.ts` file. For testing, this repo works with [Jest](https://facebook.github.io/jest/).

Once you finished, you can publish your module to npm with `npm publish`. This will compile your Typescript code

and send it to npm.

Make sure to change the name of the package in `package.json`

## Dev Features

* Testing with Jest

* Linting out of the box (checks the style of your code), with TSLint

* Build, prepublish and other scripts to help you to develop

* Works with Typescript: Static typing for your JS Applications, reducing amount of runtime errors

* Coverage out of the box, thanks to Jest

* Uses deterministic module resolving, with `package-lock.json`

## Credits

Developed by Juan Camilo Guarín Peñaranda,  

Otherwise SAS, Colombia  

2017

## License 

MIT.

## Support us on Patreon

[![patreon](./repo/patreon.png)](https://patreon.com/owsas)