https://github.com/wisersolutions/package-seed
Default setup for a JavaScript library package
https://github.com/wisersolutions/package-seed
Last synced: about 1 year ago
JSON representation
Default setup for a JavaScript library package
- Host: GitHub
- URL: https://github.com/wisersolutions/package-seed
- Owner: WiserSolutions
- License: mit
- Created: 2018-09-17T10:58:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T20:17:22.000Z (almost 3 years ago)
- Last Synced: 2024-04-14T04:48:46.925Z (about 2 years ago)
- Language: JavaScript
- Size: 1.21 MB
- Stars: 0
- Watchers: 11
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# package-seed
Default setup for a JavaScript library package
## Use
Create a new folder where you want to start a new package or check out a new, empty repository.
Run the following from that folder:
```sh
npx @wisersolutions/package-seed
```
This will seed the new package with the default setup. Package description should either be added
manually or using the `-d` command-line option.
_Note: The seed data expects the package to be hosted under the `WiserSolutions` GitHub organization.
If that's not the case, make sure to replace all instances of that label in the seeded sources._
## Development
### Install
Install dependencies using:
```sh
npm install
```
### Develop
After you modify sources, run the following (or set up your IDE to do it for you):
- format the code using `npm run format`
- lint it using `npm run lint`
- test it using `npm test`
and fix the errors, if there are any.
### Publish
Publishing is done in two steps:
1. Create a new version tag and push it to the repository:
```sh
npm version
git push --follow-tags
```
1. Build and publish the new version as a npm package:
```sh
npm publish --access public
```