workproof 0.1.3 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "workproof",
3
- "version": "0.1.3",
4
- "description": "Turn a private git repository into a verifiable engineering report for one author, without showing any code.",
3
+ "version": "0.3.0",
4
+ "description": "Turn a private git repository into a verifiable engineering report for one author, without showing any code: thirteen figures from git, a hash anyone can recompute offline, verify, and an in-toto attestation.",
5
5
  "type": "module",
6
6
  "main": "./dist/src/index.js",
7
7
  "types": "./dist/src/index.d.ts",
@@ -12,30 +12,47 @@
12
12
  }
13
13
  },
14
14
  "bin": {
15
- "workproof": "./dist/src/cli.js"
15
+ "workproof": "dist/src/cli.js"
16
16
  },
17
17
  "files": [
18
18
  "dist/src",
19
+ "schema",
19
20
  "README.md",
20
21
  "LICENSE"
21
22
  ],
23
+ "sideEffects": false,
22
24
  "scripts": {
23
25
  "build": "tsc -p tsconfig.json",
24
26
  "lint": "tsc -p tsconfig.json --noEmit",
25
- "test": "npm run build && node --test dist/test/figures.test.js dist/test/report.test.js dist/test/cli.test.js",
27
+ "test": "npm run build && node --test dist/test/figures.test.js dist/test/exclusions.test.js dist/test/adversarial.test.js dist/test/integrity.test.js dist/test/attest.test.js dist/test/report.test.js dist/test/summary.test.js dist/test/cli.test.js dist/test/action.test.js test/release.test.mjs",
26
28
  "prepublishOnly": "npm test",
27
- "examples": "npm run build && node examples/basic.mjs"
29
+ "examples": "npm run build && node examples/basic.mjs",
30
+ "release": "node scripts/release.mjs",
31
+ "release-gate": "npm run build && node scripts/release-gate.mjs",
32
+ "bench:adversarial": "npm run build && node bench/adversarial.mjs"
28
33
  },
29
34
  "engines": {
30
35
  "node": ">=20"
31
36
  },
32
37
  "keywords": [
33
38
  "git",
34
- "portfolio",
39
+ "git-blame",
40
+ "engineering-report",
41
+ "verifiable",
35
42
  "proof-of-work",
43
+ "portfolio",
44
+ "resume",
45
+ "hiring",
36
46
  "career",
37
- "blame",
38
- "engineering-evidence"
47
+ "authorship",
48
+ "code-ownership",
49
+ "surviving-lines",
50
+ "engineering-evidence",
51
+ "in-toto",
52
+ "sigstore",
53
+ "attestation",
54
+ "github-action",
55
+ "cli"
39
56
  ],
40
57
  "author": "Efe Genc",
41
58
  "license": "MIT",
@@ -44,6 +61,13 @@
44
61
  "url": "git+https://github.com/Bubblegunn/workproof.git"
45
62
  },
46
63
  "homepage": "https://github.com/Bubblegunn/workproof#readme",
64
+ "bugs": {
65
+ "url": "https://github.com/Bubblegunn/workproof/issues"
66
+ },
67
+ "publishConfig": {
68
+ "access": "public",
69
+ "provenance": true
70
+ },
47
71
  "dependencies": {
48
72
  "surviving-lines": "^0.1.1"
49
73
  },
@@ -0,0 +1,74 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://workproof.dev/schema/report-2.json",
4
+ "title": "workproof report",
5
+ "description": "A verifiable engineering report for one author. hash is sha256 over the RFC 8785 canonical JSON of { params, repositories }.",
6
+ "type": "object",
7
+ "required": ["tool", "schemaVersion", "version", "generatedAt", "params", "repositories", "hash"],
8
+ "properties": {
9
+ "tool": { "const": "workproof" },
10
+ "schemaVersion": { "const": 2 },
11
+ "version": { "type": "string" },
12
+ "generatedAt": { "type": "string", "format": "date-time" },
13
+ "params": { "type": "object" },
14
+ "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$" },
15
+ "repositories": {
16
+ "type": "array",
17
+ "minItems": 1,
18
+ "items": {
19
+ "type": "object",
20
+ "required": ["name", "head", "fingerprint", "identity", "environment", "excluded", "figures"],
21
+ "properties": {
22
+ "name": { "type": "string" },
23
+ "head": { "type": "string", "pattern": "^[0-9a-f]{40}$" },
24
+ "fingerprint": { "type": "string", "pattern": "^[0-9a-f]{64}$" },
25
+ "fingerprintKeyed": { "type": "boolean" },
26
+ "identity": {
27
+ "type": "object",
28
+ "required": ["emails", "names", "count"],
29
+ "properties": {
30
+ "emails": { "type": "array", "items": { "type": "string" } },
31
+ "names": { "type": "array", "items": { "type": "string" } },
32
+ "count": { "type": "integer", "minimum": 0 }
33
+ }
34
+ },
35
+ "environment": {
36
+ "type": "object",
37
+ "required": ["git", "blame"],
38
+ "properties": {
39
+ "git": { "type": "string" },
40
+ "blame": { "type": "array", "items": { "type": "string" } },
41
+ "ignoreRevs": { "type": ["string", "null"] },
42
+ "seed": { "type": "string" }
43
+ }
44
+ },
45
+ "excluded": {
46
+ "type": "object",
47
+ "required": ["botCommits", "files", "linesAddedShare"],
48
+ "properties": {
49
+ "botCommits": { "type": "integer", "minimum": 0 },
50
+ "files": { "type": "integer", "minimum": 0 },
51
+ "linesAddedShare": { "type": "number", "minimum": 0, "maximum": 1 },
52
+ "enabled": { "type": "boolean" }
53
+ }
54
+ },
55
+ "figures": {
56
+ "type": "array",
57
+ "minItems": 1,
58
+ "items": {
59
+ "type": "object",
60
+ "required": ["id", "title", "value", "command", "limits"],
61
+ "properties": {
62
+ "id": { "type": "string", "minLength": 1 },
63
+ "title": { "type": "string" },
64
+ "value": {},
65
+ "command": { "type": "string" },
66
+ "limits": { "type": "array", "items": { "type": "string" } }
67
+ }
68
+ }
69
+ }
70
+ }
71
+ }
72
+ }
73
+ }
74
+ }