https://github.com/vidhill/npm-package-template
Template repo for npm packages
https://github.com/vidhill/npm-package-template
Last synced: 3 months ago
JSON representation
Template repo for npm packages
- Host: GitHub
- URL: https://github.com/vidhill/npm-package-template
- Owner: vidhill
- License: mit
- Created: 2021-06-08T11:55:02.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-23T20:53:12.000Z (almost 4 years ago)
- Last Synced: 2025-01-17T14:17:23.080Z (4 months ago)
- Language: JavaScript
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# npm-package-template
Repo intended to be used as a template for npm packages,
with opinionated build setup `babel`, `eslint`, `jest`, `husky` etc pre-configured
Add description
```bash
$ npm install package --save # replace with real npm package name
```
## Setup
```javascript
// add relevant setup here
```
## Usage
```javascript
// add example usage here
```
### Outputs
```html
```
### Reminder
Run
```bash
$ npx @vidhill/package-json-editor
```
\- to update the `package.json`
## Development
- Build: `npm run build`
- Watch build: `npm run dev`
- Run tests: `npm run test`
- Watch tests: `npm run test:watch`