From 284ac7de274453f4dc035cb3da2dd960ad72372f Mon Sep 17 00:00:00 2001 From: Alix von Schirp Date: Mon, 10 Mar 2025 20:44:34 +0100 Subject: [PATCH] docs: Added some documentation, added docs versioning --- README.md | 25 +++++++++++++++++++- package.json | 2 ++ pnpm-lock.yaml | 57 ++++++++++++++++++++++++++++++++++++++++++++++ typedoc.config.mjs | 2 ++ 4 files changed, 85 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 63e3743..1f0e753 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ -# cis-pushover +# CIS Pushover Client + +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 +``` + +```bash +npm install @cis-oss/pushover +``` + +```bash +yarn add @cis-oss/pushover +``` + +```bash +bun add @cis-oss/pushover +``` diff --git a/package.json b/package.json index ab969b1..33cd4ce 100644 --- a/package.json +++ b/package.json @@ -34,6 +34,7 @@ }, "devDependencies": { "@eslint/js": "^9.22.0", + "@shipgirl/typedoc-plugin-versions": "^0.3.0", "@types/node": "^22.13.10", "eslint": "^9.22.0", "eslint-config-prettier": "^10.1.1", @@ -44,6 +45,7 @@ "typedoc": "^0.27.9", "typedoc-plugin-coverage": "^3.4.1", "typedoc-plugin-extras": "^4.0.0", + "typedoc-plugin-include-example": "^2.0.2", "typedoc-plugin-inline-sources": "^1.2.1", "typedoc-plugin-mdn-links": "^5.0.1", "typedoc-plugin-zod": "^1.4.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 75ba99f..84bdd2c 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -15,6 +15,9 @@ importers: '@eslint/js': specifier: ^9.22.0 version: 9.22.0 + '@shipgirl/typedoc-plugin-versions': + specifier: ^0.3.0 + version: 0.3.0(typedoc@0.27.9(typescript@5.8.2)) '@types/node': specifier: ^22.13.10 version: 22.13.10 @@ -45,6 +48,9 @@ importers: typedoc-plugin-extras: specifier: ^4.0.0 version: 4.0.0(typedoc@0.27.9(typescript@5.8.2)) + typedoc-plugin-include-example: + specifier: ^2.0.2 + version: 2.0.2(typedoc@0.27.9(typescript@5.8.2)) typedoc-plugin-inline-sources: specifier: ^1.2.1 version: 1.2.1(typedoc@0.27.9(typescript@5.8.2)) @@ -145,6 +151,12 @@ packages: '@shikijs/vscode-textmate@10.0.2': resolution: {integrity: sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==} + '@shipgirl/typedoc-plugin-versions@0.3.0': + resolution: {integrity: sha512-hhXwnqp07qIoFMAXJEUQTWF4xy6T6UEgZHCO+vP7EAoaJriMDl5Ct4M7XfVMKfr+yKrauZLgGK+8XdpVYx232A==} + engines: {node: '>=14.0.0', npm: '>=6.0.0'} + peerDependencies: + typedoc: '>=0.26.0 <0.28.0' + '@types/estree@1.0.6': resolution: {integrity: sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==} @@ -410,6 +422,10 @@ packages: flatted@3.3.3: resolution: {integrity: sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg==} + fs-extra@11.3.0: + resolution: {integrity: sha512-Z4XaCL6dUDHfP/jT25jJKMmtxvuwbkrD1vNSMFlo9lNLY2c5FHYSQgHPRZUjAB26TpDEoW9HCOgplrdbaPV/ew==} + engines: {node: '>=14.14'} + get-east-asian-width@1.3.0: resolution: {integrity: sha512-vpeMIQKxczTD/0s2CdEWHcb0eeJe6TFjxb+J5xgX7hScxqrGuyjmv4c1D4A/gelKfyox0gJJwIHF+fLjeaM8kQ==} engines: {node: '>=18'} @@ -434,6 +450,9 @@ packages: resolution: {integrity: sha512-iInW14XItCXET01CQFqudPOWP2jYMl7T+QRQT+UNcR/iQncN/F0UNpgd76iFkBPgNQb4+X3LV9tLJYzwh+Gl3A==} engines: {node: '>=18'} + graceful-fs@4.2.11: + resolution: {integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==} + graphemer@1.4.0: resolution: {integrity: sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==} @@ -502,6 +521,9 @@ packages: json-stable-stringify-without-jsonify@1.0.1: resolution: {integrity: sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==} + jsonfile@6.1.0: + resolution: {integrity: sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==} + keyv@4.5.4: resolution: {integrity: sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==} @@ -739,6 +761,11 @@ packages: peerDependencies: typedoc: 0.27.x + typedoc-plugin-include-example@2.0.2: + resolution: {integrity: sha512-5TTfmUR4dzz68K6RJMVQJ6db0MNK+86n0BFuxYeEJ1+MRV546pE7y+vdUfSjc7spVOZhzNp+vxH76+9bTmSHyQ==} + peerDependencies: + typedoc: 0.26.x || 0.27.x + typedoc-plugin-inline-sources@1.2.1: resolution: {integrity: sha512-H+5AR5zhsGLB4ufrAQUO75bNUS74zoxDCRtFCEF2fEnrH62zM1YLi36x2utxWMCvrVRdpF1wLq2z0E3wxldmkQ==} peerDependencies: @@ -779,6 +806,10 @@ packages: undici-types@6.20.0: resolution: {integrity: sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==} + universalify@2.0.1: + resolution: {integrity: sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==} + engines: {node: '>= 10.0.0'} + uri-js@4.4.1: resolution: {integrity: sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==} @@ -896,6 +927,12 @@ snapshots: '@shikijs/vscode-textmate@10.0.2': {} + '@shipgirl/typedoc-plugin-versions@0.3.0(typedoc@0.27.9(typescript@5.8.2))': + dependencies: + fs-extra: 11.3.0 + semver: 7.7.1 + typedoc: 0.27.9(typescript@5.8.2) + '@types/estree@1.0.6': {} '@types/hast@3.0.4': @@ -1202,6 +1239,12 @@ snapshots: flatted@3.3.3: {} + fs-extra@11.3.0: + dependencies: + graceful-fs: 4.2.11 + jsonfile: 6.1.0 + universalify: 2.0.1 + get-east-asian-width@1.3.0: {} get-stream@8.0.1: {} @@ -1218,6 +1261,8 @@ snapshots: globals@16.0.0: {} + graceful-fs@4.2.11: {} + graphemer@1.4.0: {} has-flag@4.0.0: {} @@ -1263,6 +1308,12 @@ snapshots: json-stable-stringify-without-jsonify@1.0.1: {} + jsonfile@6.1.0: + dependencies: + universalify: 2.0.1 + optionalDependencies: + graceful-fs: 4.2.11 + keyv@4.5.4: dependencies: json-buffer: 3.0.1 @@ -1482,6 +1533,10 @@ snapshots: dependencies: typedoc: 0.27.9(typescript@5.8.2) + typedoc-plugin-include-example@2.0.2(typedoc@0.27.9(typescript@5.8.2)): + dependencies: + typedoc: 0.27.9(typescript@5.8.2) + typedoc-plugin-inline-sources@1.2.1(typedoc@0.27.9(typescript@5.8.2)): dependencies: typedoc: 0.27.9(typescript@5.8.2) @@ -1519,6 +1574,8 @@ snapshots: undici-types@6.20.0: {} + universalify@2.0.1: {} + uri-js@4.4.1: dependencies: punycode: 2.3.1 diff --git a/typedoc.config.mjs b/typedoc.config.mjs index 796fc72..0946e38 100644 --- a/typedoc.config.mjs +++ b/typedoc.config.mjs @@ -17,6 +17,8 @@ const config = { "typedoc-plugin-inline-sources", "typedoc-plugin-mdn-links", "typedoc-plugin-zod", + "typedoc-plugin-include-example", + "@shipgirl/typedoc-plugin-versions", ], footerTypedocVersion: true, footerLastModified: true,