Release v0.1.0

.husky/pre-commit

@@ -1 +1 @@
-npx lint-staged
+pnpm exec lint-staged

README.md

@@ -1,24 +1,48 @@
 # CIS Pushover Client
 
+![GitHub License](https://img.shields.io/github/license/cis-oss/pushover)
+![NPM Version](https://img.shields.io/npm/v/%40cis-oss%2Fpushover)
+![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/cis-oss/pushover?label=bundle%20size)
+
 A client for Pushover, a service for sending notifications. Typesafe.
 Supports sending the same message to multiple users.
 
 ## Installation
 
-⚠️ This package is **not yet published** to npm.
-
 ```bash
 pnpm add @cis-oss/pushover
 ```
 
+<details>
+<summary>Or using npm</summary>
+
 ```bash
 npm install @cis-oss/pushover
 ```
 
+</details>
+
+<details>
+<summary>Or use our meta-packages</summary>
+
 ```bash
-yarn add @cis-oss/pushover
+pnpm add @cis-oss/notify
 ```
 
 ```bash
-bun add @cis-oss/pushover
+pnpm add @cis-oss/notify-push
 ```
+
+</details>
+
+# Documentation
+
+Documentation can be found at [https://cis-oss.github.io/pushover](https://cis-oss.github.io/pushover).
+
+# Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](https://github.com/cis-oss/.github/blob/main/CONTRIBUTING.md) for details.
+
+Please make sure to read our [Code of Conduct](https://github.com/cis-oss/.github/blob/main/CODE_OF_CONDUCT.md) and [Support Policy](https://github.com/cis-oss/.github/blob/main/SUPPORT.md).
+
+Disclose security issues responsibly by following our [Security Policy](https://github.com/cis-oss/.github/blob/main/SECURITY.md).

eslint.config.mjs

@@ -2,6 +2,7 @@ import globals from "globals";
 import pluginJs from "@eslint/js";
 import tseslint from "typescript-eslint";
 import eslintConfigPrettier from "eslint-config-prettier";
+import onlyWarn from "eslint-plugin-only-warn";
 
 /** @type {import('eslint').Linter.Config[]} */
 export default [
@@ -11,4 +12,9 @@ export default [
   pluginJs.configs.recommended,
   ...tseslint.configs.recommended,
   eslintConfigPrettier,
+  {
+    plugins: {
+      onlyWarn,
+    },
+  },
 ];

jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+export default {
+  testEnvironment: "node",
+  transform: {
+    "^.+\.tsx?$": ["ts-jest", {}],
+  },
+};

package.json

@@ -2,8 +2,8 @@
   "name": "@cis-oss/pushover",
   "description": "A client for Pushover, a service for sending notifications. Written in TypeScript. Supports sending to multiple users.",
   "homepage": "https://cis-oss.github.io/pushover",
-  "version": "0.0.1",
-  "main": "dist/index.js",
+  "version": "0.1.0",
+  "main": "src/index.ts",
   "author": {
     "email": "hi@b00tload.space",
     "name": "Alix von Schirp",
@@ -29,14 +29,20 @@
   "devDependencies": {
     "@eslint/js": "^9.22.0",
     "@shipgirl/typedoc-plugin-versions": "^0.3.0",
+    "@types/jest": "^29.5.14",
     "@types/node": "^22.13.10",
     "eslint": "^9.22.0",
     "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-only-warn": "^1.1.0",
     "finepack": "^2.12.7",
     "globals": "^16.0.0",
     "husky": "^9.1.7",
+    "jest": "^29.7.0",
     "lint-staged": "^15.4.3",
     "prettier": "3.5.3",
+    "shx": "^0.4.0",
+    "ts-jest": "^29.2.6",
+    "tsx": "^4.19.3",
     "typedoc": "^0.27.9",
     "typedoc-github-theme": "^0.2.1",
     "typedoc-plugin-coverage": "^3.4.1",
@@ -48,24 +54,47 @@
     "typescript": "^5.5.3",
     "typescript-eslint": "^8.26.0"
   },
+  "files": [
+    "dist/**/*.{js,ts,map}"
+  ],
   "scripts": {
     "build": "tsc",
-    "check": "pnpm lint && pnpm typecheck",
+    "build:watch": "tsc --watch",
+    "check": "pnpm run lint && pnpm run typecheck",
+    "clean": "shx rm -rf dist/",
     "docs:generate": "typedoc",
     "format:check": "prettier --check .",
     "lint": "eslint --cache .",
     "prepare": "husky",
+    "prepublishOnly": "pnpm run clean && pnpm run build",
+    "test": "jest",
     "typecheck": "tsc --noEmit"
   },
-  "private": true,
   "license": "MIT",
   "husky": {
     "shell": "bash"
   },
   "lint-staged": {
     "package.json": "finepack",
-    "*.{js,ts,jsx,tsx}": "eslint --cache --fix . || true",
+    "*.{js,ts,jsx,tsx}": "eslint --cache --fix .",
     "*.{js,ts,jsx,tsx,json,css,md}": "prettier --write"
   },
+  "maintainers": [
+    {
+      "name": "Alix von Schirp",
+      "email": "hi@b00tload.space",
+      "url": "https://b00tload.space"
+    },
+    {
+      "name": "Ole",
+      "email": "jateute123@gmail.com",
+      "url": "https://github.com/jateute"
+    }
+  ],
+  "packageManager": "pnpm@10.6.5",
+  "publishConfig": {
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts"
+  },
   "type": "module"
-}
+}