@xenonbyte/xsk 0.1.1 → 0.1.2
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/README.md +2 -0
- package/README.zh-CN.md +2 -0
- package/package.json +1 -1
- package/skills/archive-req/SKILL.md +6 -1
- package/skills/write-req/SKILL.md +6 -1
- package/templates/fragments/archive-req.behavior.md +5 -0
- package/templates/fragments/archive-req.output.md +1 -1
- package/templates/fragments/write-req.behavior.md +5 -0
- package/templates/fragments/write-req.output.md +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# xsk
|
|
2
2
|
|
|
3
|
+
**English** | [简体中文](README.zh-CN.md)
|
|
4
|
+
|
|
3
5
|
> Curate a small set of agent skills and install them across Claude Code, Codex, opencode, and Gemini, with manifest-backed safety.
|
|
4
6
|
|
|
5
7
|
[](https://nodejs.org/)
|
package/README.zh-CN.md
CHANGED
package/package.json
CHANGED
|
@@ -24,10 +24,15 @@ Match the intent, not the exact words. Common cues:
|
|
|
24
24
|
5. Write the fully-updated archived content to `.xsk/requirements/archive/<slug>.md`: set `status: archived`, add `archived_at: <ISO date>`, and preserve every other frontmatter field and the entire body unchanged.
|
|
25
25
|
6. Confirm it landed as written, then remove the source active doc.
|
|
26
26
|
7. After archiving, confirm zero active documents remain.
|
|
27
|
+
8. Offer to commit the archival, git-aware. The archive copy lives under the git-ignored `requirements/archive/`, so from git's view the only change is the deletion of the source active doc. If the project is a git repository and that active doc was tracked (`git ls-files --error-unmatch <path>` succeeds), ask the user once whether to commit this archival, and act on the answer:
|
|
28
|
+
- On yes, commit only that deleted path. Stage the deletion first, then commit only that path: `git add -- <the removed active doc path> && git commit -m "docs(xsk): archive requirement <slug>" -- <the removed active doc path>`. Never `git add -A` or `git add .`.
|
|
29
|
+
- On no, leave the working tree as is and report that the deletion was left for the user to commit.
|
|
30
|
+
|
|
31
|
+
If the doc was untracked, or the project is not a git repository, skip the prompt and say nothing about committing.
|
|
27
32
|
|
|
28
33
|
## Output
|
|
29
34
|
|
|
30
|
-
Either a one-line refusal that names the missing/invalid slug, a stop-and-ask response when `.xsk/requirements/archive/<slug>.md` already exists and it was left unchanged, writing nothing, or the archived path (`.xsk/requirements/archive/<slug>.md`) plus confirmation that it landed before the source active doc was removed and that no active requirement docs remain.
|
|
35
|
+
Either a one-line refusal that names the missing/invalid slug, a stop-and-ask response when `.xsk/requirements/archive/<slug>.md` already exists and it was left unchanged, writing nothing, or the archived path (`.xsk/requirements/archive/<slug>.md`) plus confirmation that it landed before the source active doc was removed and that no active requirement docs remain, and, when the removed doc was tracked by git, whether the user committed the archival or left it uncommitted.
|
|
31
36
|
|
|
32
37
|
## Conventions shared across xsk skills
|
|
33
38
|
|
|
@@ -53,9 +53,14 @@ created_at: <ISO date>
|
|
|
53
53
|
---
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
+
**9. Offer to commit, git-aware.** Only after the doc passes the self-audit and is finalized, decide whether to offer a commit. If the project is not a git repository (`git rev-parse --is-inside-work-tree` fails), or the requirement doc is byte-identical to what git already tracks, skip silently and say nothing about committing. Otherwise ask the user once whether to commit this requirement, and act on the answer:
|
|
57
|
+
|
|
58
|
+
- On yes, commit only the paths this run wrote: the requirement doc, plus `.xsk/.gitignore` if this run created it. Stage those exact paths first, then commit only them: `git add -- <those paths> && git commit -m "docs(xsk): write requirement <slug>" -- <those paths>`. Stage first because a bare `git commit -- <path>` rejects an untracked new doc. Never `git add -A` or `git add .`, so unrelated working-tree changes are never swept in.
|
|
59
|
+
- On no, leave the doc uncommitted and report that it was left for the user to commit.
|
|
60
|
+
|
|
56
61
|
## Output
|
|
57
62
|
|
|
58
|
-
The path of the requirement file, with confirmation that it is now the single active doc.
|
|
63
|
+
The path of the requirement file, with confirmation that it is now the single active doc, and, when a commit was offered, whether the user committed it or left it uncommitted.
|
|
59
64
|
|
|
60
65
|
## Conventions shared across xsk skills
|
|
61
66
|
|
|
@@ -5,3 +5,8 @@
|
|
|
5
5
|
5. Write the fully-updated archived content to `.xsk/requirements/archive/<slug>.md`: set `status: archived`, add `archived_at: <ISO date>`, and preserve every other frontmatter field and the entire body unchanged.
|
|
6
6
|
6. Confirm it landed as written, then remove the source active doc.
|
|
7
7
|
7. After archiving, confirm zero active documents remain.
|
|
8
|
+
8. Offer to commit the archival, git-aware. The archive copy lives under the git-ignored `requirements/archive/`, so from git's view the only change is the deletion of the source active doc. If the project is a git repository and that active doc was tracked (`git ls-files --error-unmatch <path>` succeeds), ask the user once whether to commit this archival, and act on the answer:
|
|
9
|
+
- On yes, commit only that deleted path. Stage the deletion first, then commit only that path: `git add -- <the removed active doc path> && git commit -m "docs(xsk): archive requirement <slug>" -- <the removed active doc path>`. Never `git add -A` or `git add .`.
|
|
10
|
+
- On no, leave the working tree as is and report that the deletion was left for the user to commit.
|
|
11
|
+
|
|
12
|
+
If the doc was untracked, or the project is not a git repository, skip the prompt and say nothing about committing.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
Either a one-line refusal that names the missing/invalid slug, a stop-and-ask response when `.xsk/requirements/archive/<slug>.md` already exists and it was left unchanged, writing nothing, or the archived path (`.xsk/requirements/archive/<slug>.md`) plus confirmation that it landed before the source active doc was removed and that no active requirement docs remain.
|
|
1
|
+
Either a one-line refusal that names the missing/invalid slug, a stop-and-ask response when `.xsk/requirements/archive/<slug>.md` already exists and it was left unchanged, writing nothing, or the archived path (`.xsk/requirements/archive/<slug>.md`) plus confirmation that it landed before the source active doc was removed and that no active requirement docs remain, and, when the removed doc was tracked by git, whether the user committed the archival or left it uncommitted.
|
|
@@ -33,3 +33,8 @@ slug: <slug>
|
|
|
33
33
|
created_at: <ISO date>
|
|
34
34
|
---
|
|
35
35
|
```
|
|
36
|
+
|
|
37
|
+
**9. Offer to commit, git-aware.** Only after the doc passes the self-audit and is finalized, decide whether to offer a commit. If the project is not a git repository (`git rev-parse --is-inside-work-tree` fails), or the requirement doc is byte-identical to what git already tracks, skip silently and say nothing about committing. Otherwise ask the user once whether to commit this requirement, and act on the answer:
|
|
38
|
+
|
|
39
|
+
- On yes, commit only the paths this run wrote: the requirement doc, plus `.xsk/.gitignore` if this run created it. Stage those exact paths first, then commit only them: `git add -- <those paths> && git commit -m "docs(xsk): write requirement <slug>" -- <those paths>`. Stage first because a bare `git commit -- <path>` rejects an untracked new doc. Never `git add -A` or `git add .`, so unrelated working-tree changes are never swept in.
|
|
40
|
+
- On no, leave the doc uncommitted and report that it was left for the user to commit.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
The path of the requirement file, with confirmation that it is now the single active doc.
|
|
1
|
+
The path of the requirement file, with confirmation that it is now the single active doc, and, when a commit was offered, whether the user committed it or left it uncommitted.
|