@devdroplets/stager-co (8.2.2)
Installation
@devdroplets:registry=npm install @devdroplets/stager-co@8.2.2"@devdroplets/stager-co": "8.2.2"About this package
A library for interfacing with Stager.co
A Stager.co implementation that enables NodeJS to control a private Stager.co instance. It allows for CRUD functionality of events, programs and program topics.
⚠️ This is an unofficial implementation by DevDroplets and should be treated as such.
Installation
Installing can be done with the following steps:
- Create a new file next to your
package.jsonnamed.npmrcand paste the following:
@devdroplets:registry=https://git.devdroplets.com/api/v4/packages/npm/
//git.devdroplets.com/api/v4/packages/npm/:_auth="Z2l0bGFiK2RlcGxveS10b2tlbi04NzprbzVXbjFyNHMxd0tfRGl4Wm5Ydg=="
always-auth=true
- Now you should be able to just install any
@devdroplets/package:
pnpm i @devdroplets/stager-co
Development setup
After cloning the repository and having installed nodejs and pnpm you should setup the environment.
devdroplets/stager-co requires a valid stager installation.
- Install dependencies (
pnpm install) - Setup env (
cp .env.sample .env) and change the variables in.env
At any moment you can test the library with pnpm test <glob?>
Commiting
We use commitlint within this project!
You should adhere to the following commit message format:
type(scope?)!?: subject
body?
footer?
- The
!is for breaking changes. This should always trigger a major release!
This is automatically validated via 🐶 husky.
Releasing
We automatically build using Gitlab's CI/CD. You can easily release a new version using the built-in npm-version command.
For example releasing a minor version:
npm version minor
Now push both the commit (where the version is modified in package.json) and the tag:
git push # For the commits
git push --tags # For the tags
It is important to keep in mind that we adopt semantic versioning. Therefor, releasing should consider breaking commits (commits with a !).
Dependencies
Dependencies
| ID | Version |
|---|---|
| @commitlint/cli | ^19.5.0 |
| @commitlint/config-conventional | ^19.5.0 |
| axios | ^1.7.7 |
| axios-cookiejar-support | ^5.0.2 |
| cheerio | ^1.0.0 |
| dotenv | ^16.4.5 |
| qs | ^6.13.0 |
| tough-cookie | ^5.0.0 |
Development dependencies
| ID | Version |
|---|---|
| @types/lodash | ^4.17.9 |
| @types/qs | ^6.9.16 |
| @types/tough-cookie | ^4.0.5 |
| @typescript-eslint/eslint-plugin | ^8.7.0 |
| @typescript-eslint/parser | ^8.7.0 |
| @vitest/coverage-v8 | ^2.1.1 |
| chai-datetime | ^1.8.1 |
| date-fns | ^4.1.0 |
| domhandler | ^5.0.3 |
| eslint | ^9.11.1 |
| eslint-config-xo | ^0.46.0 |
| eslint-config-xo-typescript | ^7.0.0 |
| husky | ^9.1.6 |
| lodash | ^4.17.21 |
| prettier-eslint | ^16.3.0 |
| prettier-eslint-cli | ^8.0.1 |
| typescript | ^5.6.2 |
| vitest | ^2.1.1 |