open-backlog 0.0.0-stage → 0.1.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/LICENSE +21 -0
- package/README.md +308 -2
- package/dist/cli/main.d.ts +2 -0
- package/dist/cli/main.js +9 -0
- package/dist/cli/run.d.ts +27 -0
- package/dist/cli/run.js +486 -0
- package/dist/core/add.d.ts +37 -0
- package/dist/core/add.js +99 -0
- package/dist/core/fix.d.ts +30 -0
- package/dist/core/fix.js +87 -0
- package/dist/core/git.d.ts +93 -0
- package/dist/core/git.js +267 -0
- package/dist/core/hierarchy.d.ts +62 -0
- package/dist/core/hierarchy.js +78 -0
- package/dist/core/ids.d.ts +14 -0
- package/dist/core/ids.js +25 -0
- package/dist/core/index.d.ts +36 -0
- package/dist/core/index.js +25 -0
- package/dist/core/init.d.ts +35 -0
- package/dist/core/init.js +77 -0
- package/dist/core/list.d.ts +40 -0
- package/dist/core/list.js +79 -0
- package/dist/core/read.d.ts +18 -0
- package/dist/core/read.js +151 -0
- package/dist/core/rules.d.ts +18 -0
- package/dist/core/rules.js +21 -0
- package/dist/core/show.d.ts +38 -0
- package/dist/core/show.js +87 -0
- package/dist/core/spec.d.ts +4 -0
- package/dist/core/spec.js +4 -0
- package/dist/core/types.d.ts +70 -0
- package/dist/core/types.js +10 -0
- package/dist/core/validate.d.ts +28 -0
- package/dist/core/validate.js +227 -0
- package/dist/core/write.d.ts +56 -0
- package/dist/core/write.js +160 -0
- package/dist/core/yaml.d.ts +13 -0
- package/dist/core/yaml.js +28 -0
- package/package.json +52 -4
- package/schema/0.1/config.schema.json +32 -0
- package/schema/0.1/item.schema.json +91 -0
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"$id": "https://openbacklog.org/schema/0.1/config.schema.json",
|
|
4
|
+
"title": "Open Backlog 0.1 config.yml",
|
|
5
|
+
"description": "A backlog's config.yml [config]. See spec/README.md, section 5.",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"required": ["spec", "name"],
|
|
8
|
+
"properties": {
|
|
9
|
+
"spec": {
|
|
10
|
+
"description": "The spec version the backlog follows, MAJOR.MINOR. Text, not a number [read-as-text].",
|
|
11
|
+
"type": ["string", "number"],
|
|
12
|
+
"pattern": "^\\d+\\.\\d+$"
|
|
13
|
+
},
|
|
14
|
+
"name": {
|
|
15
|
+
"description": "The backlog's name, used by other backlogs as name/2.3.4.",
|
|
16
|
+
"type": "string",
|
|
17
|
+
"pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
|
|
18
|
+
},
|
|
19
|
+
"estimate": { "description": "The unit of every estimate. Points if absent.", "enum": ["points", "hours", "days"] },
|
|
20
|
+
"done-folders": { "description": "File finished items into stories/done/YYYY-MM/.", "const": "month" },
|
|
21
|
+
"repos": {
|
|
22
|
+
"description": "Repository name to clone URL (T3).",
|
|
23
|
+
"type": "object",
|
|
24
|
+
"additionalProperties": { "type": "string" }
|
|
25
|
+
},
|
|
26
|
+
"backlogs": {
|
|
27
|
+
"description": "Backlog name to clone URL (T4).",
|
|
28
|
+
"type": "object",
|
|
29
|
+
"additionalProperties": { "type": "string" }
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"$id": "https://openbacklog.org/schema/0.1/item.schema.json",
|
|
4
|
+
"title": "Open Backlog 0.1 item front matter",
|
|
5
|
+
"description": "The front matter of a capability, epic, feature, story, bug, spike or task file. Checks what one file can show; rules that span files (parents, unique IDs, folders) are for a validator. See spec/README.md.",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"required": ["id", "type", "title"],
|
|
8
|
+
"properties": {
|
|
9
|
+
"id": {
|
|
10
|
+
"description": "The item's ID: epic 2, feature 2.3, story-level 2.3.4, capability C1. Text, not a number: 2.10 is not 2.1 [read-as-text].",
|
|
11
|
+
"type": ["string", "number"]
|
|
12
|
+
},
|
|
13
|
+
"type": {
|
|
14
|
+
"description": "One of the seven types [fields].",
|
|
15
|
+
"enum": ["capability", "epic", "feature", "story", "bug", "spike", "task"]
|
|
16
|
+
},
|
|
17
|
+
"title": {
|
|
18
|
+
"description": "A short name, on one line [fields].",
|
|
19
|
+
"type": "string",
|
|
20
|
+
"pattern": "^[^\\n]*\\S[^\\n]*$"
|
|
21
|
+
},
|
|
22
|
+
"parent": {
|
|
23
|
+
"description": "The ID of the item above: a feature for story-level items, an epic for features, a capability (optional) for epics.",
|
|
24
|
+
"type": ["string", "number"]
|
|
25
|
+
},
|
|
26
|
+
"rank": { "description": "Order within a status folder, lowest first.", "type": "number" },
|
|
27
|
+
"sprint": { "description": "The name of a file in sprints/, such as 2026-S24.", "type": "string" },
|
|
28
|
+
"estimate": { "description": "The size of the work, in the backlog's unit.", "type": "number", "minimum": 0 },
|
|
29
|
+
"assignee": {
|
|
30
|
+
"description": "A handle: lowercase letters, digits, -, _ and . [fields].",
|
|
31
|
+
"type": "string",
|
|
32
|
+
"pattern": "^[a-z0-9][a-z0-9._-]*$"
|
|
33
|
+
},
|
|
34
|
+
"release": { "description": "The release the item ships in, such as 0.1.0.", "type": ["string", "number"] },
|
|
35
|
+
"due": { "description": "A date, YYYY-MM-DD.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" },
|
|
36
|
+
"repo": {
|
|
37
|
+
"description": "A repository listed under repos: in config.yml, or a list of them [repo-listed].",
|
|
38
|
+
"oneOf": [
|
|
39
|
+
{ "type": "string", "minLength": 1 },
|
|
40
|
+
{ "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 }
|
|
41
|
+
]
|
|
42
|
+
},
|
|
43
|
+
"children": { "description": "Never listed: children are worked out [not-stored].", "not": {} },
|
|
44
|
+
"status": { "description": "Never stored: the folder is the status [not-stored].", "not": {} },
|
|
45
|
+
"progress": { "description": "Never stored: progress is worked out [not-stored].", "not": {} }
|
|
46
|
+
},
|
|
47
|
+
"additionalProperties": {
|
|
48
|
+
"description": "Fields of a backlog's own are allowed and kept by tools [keep-unknown], but hold no email address [no-email].",
|
|
49
|
+
"not": { "type": "string", "pattern": "[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}" }
|
|
50
|
+
},
|
|
51
|
+
"allOf": [
|
|
52
|
+
{
|
|
53
|
+
"if": { "properties": { "type": { "enum": ["story", "bug", "spike", "task"] } }, "required": ["type"] },
|
|
54
|
+
"then": {
|
|
55
|
+
"required": ["parent"],
|
|
56
|
+
"properties": {
|
|
57
|
+
"id": { "pattern": "^(0|[1-9]\\d*)\\.[1-9]\\d*\\.[1-9]\\d*$" },
|
|
58
|
+
"parent": { "pattern": "^(0|[1-9]\\d*)\\.[1-9]\\d*$" }
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"if": { "properties": { "type": { "const": "feature" } }, "required": ["type"] },
|
|
64
|
+
"then": {
|
|
65
|
+
"required": ["parent"],
|
|
66
|
+
"properties": {
|
|
67
|
+
"id": { "pattern": "^(0|[1-9]\\d*)\\.[1-9]\\d*$" },
|
|
68
|
+
"parent": { "type": ["string", "integer"], "pattern": "^(0|[1-9]\\d*)$" }
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"if": { "properties": { "type": { "const": "epic" } }, "required": ["type"] },
|
|
74
|
+
"then": {
|
|
75
|
+
"properties": {
|
|
76
|
+
"id": { "type": ["string", "integer"], "minimum": 0, "pattern": "^(0|[1-9]\\d*)$" },
|
|
77
|
+
"parent": { "type": "string", "pattern": "^C[1-9]\\d*$" }
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"if": { "properties": { "type": { "const": "capability" } }, "required": ["type"] },
|
|
83
|
+
"then": {
|
|
84
|
+
"properties": {
|
|
85
|
+
"id": { "type": "string", "pattern": "^C[1-9]\\d*$" },
|
|
86
|
+
"parent": false
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
]
|
|
91
|
+
}
|