https://github.com/eronana/typescript-package-sample

a sample project for typescript package
https://github.com/eronana/typescript-package-sample

sample-project typescript

Last synced: 6 days ago
JSON representation

a sample project for typescript package

• Host: GitHub
• URL: https://github.com/eronana/typescript-package-sample
• Owner: Eronana
• Created: 2018-10-24T15:01:29.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-24T15:02:55.000Z (about 6 years ago)
• Last Synced: 2024-10-20T14:28:36.702Z (18 days ago)
• Topics: sample-project, typescript
• Language: TypeScript
• Size: 10.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD

Awesome Lists containing this project

README

        
# typescript-package-sample

a sample project for typescript package

## How to use

- install deps: `npm i`

- run test: `npm test`

- run cover: `npm run cover`

- run lint: `npm run lint`

- watch code: `npm run watch`

- build: `npm run build`

- test pack before publish: `npm pack`

- publish: `npm publish`

## Directories

- `.vscode`: VS Code settings

- `src`: source code

- `test`: test code

- `dist`: generated by TypeScript compiler from `src`, you should modify it

- `coverage`: generate by `npm run cover`, you could found coverage result in it

## Notice

`.npmignore` is in whitelist mode right now, please update it if you added any other file