https://github.com/pod-point/node-package
A template repository for a Node.js package using TypeScript.
https://github.com/pod-point/node-package
node software-team
Last synced: 10 months ago
JSON representation
A template repository for a Node.js package using TypeScript.
- Host: GitHub
- URL: https://github.com/pod-point/node-package
- Owner: Pod-Point
- License: mit
- Created: 2019-12-30T09:57:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-30T14:53:34.000Z (over 6 years ago)
- Last Synced: 2025-03-22T08:27:06.734Z (about 1 year ago)
- Topics: node, software-team
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node Package Template
A template repository for a Node.js package using TypeScript.
## Usage
See the following link for how to create a repository from a template:
https://help.github.com/en/articles/creating-a-repository-from-a-template
### Installation
To install the latest version of this templates dev dependencies, run the following command:
```bash
npm install --save-dev @types/faker @types/jest @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-airbnb-typescript eslint-plugin-import faker jest ts-jest typescript
```
## Development
### Testing
This package uses jest. To run the test suites for this project, run the following command:
```bash
npm run test
```
### Releases
This package is distributed via NPM and published automatically by Travis when creating a tagged commit. This can be done in one of 2 ways:
#### 1. Pre-merge via the CLI
**Before** merging your PR following code review & QA, run the following commands to update the package version and create a new release/tag.
```
npm version
git push && git push --tags
```
If you forget to do this before merging, this is not a problem, just create a new branch from master and run these same commands, remembering to open and merge a PR for this branch so that the `package.json` file is updated, alternatively, see option 2.
#### 2. Post-merge via code & GitHub
**After** merging your code changes, create a new branch/PR from master and update the package version in `package.json` to whatever you wish the next release to be.
**Before** merging this PR, create a release via GitHub with a tag version to match this package version number, this will trigger the tagged commit and in turn the automatic deployment to NPM.