oss-pulse 0.1.0

package/docs/report.schema.json

@@ -0,0 +1,136 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oss-pulse.dev/schemas/report.schema.json",
+  "title": "OSS Pulse Report",
+  "description": "Machine-readable schema for `oss-pulse scan --format json` output.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "actions",
+    "branch",
+    "checks",
+    "generatedAtIso",
+    "latestCommitIso",
+    "root",
+    "score",
+    "status"
+  ],
+  "properties": {
+    "actions": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/PulseAction" }
+    },
+    "branch": {
+      "type": "string",
+      "minLength": 1
+    },
+    "checks": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/PulseCheck" }
+    },
+    "generatedAtIso": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "latestCommitIso": {
+      "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }]
+    },
+    "root": {
+      "type": "string",
+      "minLength": 1
+    },
+    "score": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 100
+    },
+    "status": { "$ref": "#/$defs/ReportStatus" }
+  },
+  "$defs": {
+    "ActionId": {
+      "type": "string",
+      "enum": [
+        "add-readme",
+        "add-license",
+        "add-contributing-guide",
+        "add-issue-template",
+        "add-good-first-issue-template",
+        "add-pull-request-template",
+        "add-security-policy",
+        "add-ci-workflow",
+        "add-release-workflow",
+        "add-changelog",
+        "add-funding",
+        "invite-contributors",
+        "add-code-of-conduct",
+        "resume-maintenance"
+      ]
+    },
+    "CheckId": {
+      "type": "string",
+      "enum": [
+        "readme",
+        "license",
+        "contributing",
+        "issue-template",
+        "good-first-issue-template",
+        "pull-request-template",
+        "security",
+        "ci-workflow",
+        "release-workflow",
+        "changelog",
+        "funding",
+        "external-contributors",
+        "code-of-conduct",
+        "recent-activity"
+      ]
+    },
+    "PulseAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["detail", "id", "priority", "title"],
+      "properties": {
+        "detail": {
+          "type": "string",
+          "minLength": 1
+        },
+        "id": { "$ref": "#/$defs/ActionId" },
+        "priority": { "$ref": "#/$defs/Priority" },
+        "title": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "PulseCheck": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["detail", "id", "label", "passed", "points"],
+      "properties": {
+        "detail": {
+          "type": "string",
+          "minLength": 1
+        },
+        "id": { "$ref": "#/$defs/CheckId" },
+        "label": {
+          "type": "string",
+          "minLength": 1
+        },
+        "passed": { "type": "boolean" },
+        "points": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 15
+        }
+      }
+    },
+    "Priority": {
+      "type": "string",
+      "enum": ["high", "medium", "low"]
+    },
+    "ReportStatus": {
+      "type": "string",
+      "enum": ["ready", "needs-work"]
+    }
+  }
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "oss-pulse",
+  "version": "0.1.0",
+  "description": "A small CLI that turns repository maintenance signals into an actionable OSS health report.",
+  "type": "module",
+  "license": "MIT",
+  "bin": {
+    "oss-pulse": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "docs",
+    "README.md",
+    "CHANGELOG.md",
+    "CONTRIBUTING.md",
+    "CODE_OF_CONDUCT.md",
+    "SECURITY.md",
+    "LICENSE",
+    "action.yml"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "check": "npm run lint && npm run typecheck && npm test",
+    "lint": "biome check .",
+    "test": "rm -rf .tmp/test-dist && tsc -p tsconfig.test.json && node --test .tmp/test-dist/tests/*.test.js",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  },
+  "dependencies": {
+    "commander": "^12.1.0",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@types/node": "^22.10.1",
+    "typescript": "^5.7.2"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}