https://github.com/rubriclab/package
https://github.com/rubriclab/package
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rubriclab/package
- Owner: RubricLab
- Created: 2024-09-26T15:22:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T17:17:42.000Z (over 1 year ago)
- Last Synced: 2024-10-25T02:03:00.633Z (over 1 year ago)
- Language: TypeScript
- Size: 428 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Package
A tool for scaffolding and publishing NPM packages quickly.
## Getting Started
### Global Installation
Run `bun add -g @rubriclab/package`.
### Per-project Installation
Run `bun add -d @rubriclab/package`.
### Init a package
Ensure you have a `package.json`. If not, run `bun init`.
Run `bunx rubriclab-setuppackage`. This will add a few resources to your package:
- a publish workflow
- on push to main, the NPM package will be bumped and auto-published
- scripts
- `lint`: checks for code issues
- `format`: tries to fix code issues
- `bleed`: updates all dependencies to `latest`
- `clean`: clears node modules and cache