https://github.com/fullpipe/ts-package-boilerplate
Typescript boilerplate for npm packages
https://github.com/fullpipe/ts-package-boilerplate
boilerplate boilerplate-template npm typescript
Last synced: 4 months ago
JSON representation
Typescript boilerplate for npm packages
- Host: GitHub
- URL: https://github.com/fullpipe/ts-package-boilerplate
- Owner: fullpipe
- License: mit
- Created: 2021-04-24T17:43:26.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T13:03:56.000Z (over 1 year ago)
- Last Synced: 2025-03-26T10:21:16.028Z (about 1 year ago)
- Topics: boilerplate, boilerplate-template, npm, typescript
- Language: TypeScript
- Homepage:
- Size: 135 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ts-package-boilerplate
## Setup
Use this repository as a template.
*Sed* package name
```
sed -i '' 's/ts-package-boilerplate/am-i-online/' package.json
sed -i '' 's/fullpipe/your-github-username/' package.json
```
Also fix other stuff in `package.json`
That's it. Use it
```
npm i
npm run test
```
## What's inside?
**gts** with some tweaks
**mocha + chai** for tests
**build/** dir not ignored by default
**npm publish** automation
## Publish
### Login
In order to publish your package, you need to create an NPM account.
If you don’t have an account run command `npm adduser`
If you already have an account, run `npm login` to login to you NPM account.
### Publish
To publish your package run
```
npm publish
```
### Versioning
To patch
```
npm version patch
npm publish
```
`version` command executes `git add ...` and `git push`, see `package.json`
## Todo
- [ ] add github actions for tests and build?