https://github.com/charlypoly/typescript-npm-module-bootstrap

TypeScript NPM module bootstrap
https://github.com/charlypoly/typescript-npm-module-bootstrap

Last synced: 10 months ago
JSON representation

TypeScript NPM module bootstrap

• Host: GitHub
• URL: https://github.com/charlypoly/typescript-npm-module-bootstrap
• Owner: charlypoly
• License: mit
• Created: 2016-11-28T14:36:21.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-12-01T11:17:50.000Z (over 9 years ago)
• Last Synced: 2025-03-30T11:02:37.908Z (about 1 year ago)
• Language: JavaScript
• Size: 6.84 KB
• Stars: 17
• Watchers: 0
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# How to write a NPM module using TypeScript

> Targeting Node.js (v6) and TypeScript

*- see [related article on Medium](https://medium.com/french-make-beautiful/5-things-to-know-when-writing-a-typescript-npm-module-e9a334efd544)*

Provide : 

- packaging for TypeScript use

- packaging for Node.js (v6) use

- TypeScript testing with Jasmine

- Gulp automatisation

#### How to run

```

npm i

gulp

gulp test

```

##### Notes

- `index.ts` at root is mandatory for `tsc` in order to make the module discoverable

- `dist/index.js` is the entry point for node.js targeting

- `.npmignore` allow to expose `dist/` and `definitions` folders without versionning it.