skref 1.0.0

Reference implementation of the Agent Skills tooling: validate, read-properties, and to-prompt for SKILL.md skills
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196

//! Tests for the parser module — ported from `tests/test_parser.py`.

use skref::errors::SkillError;
use skref::parser::{find_skill_md, parse_frontmatter, read_properties};
use std::fs;
use tempfile::tempdir;

#[test]
fn valid_frontmatter() {
    let content =
        "---\nname: my-skill\ndescription: A test skill\n---\n# My Skill\n\nInstructions here.\n";
    let (metadata, body) = parse_frontmatter(content).unwrap();
    assert_eq!(metadata.get("name").unwrap().as_str(), Some("my-skill"));
    assert_eq!(
        metadata.get("description").unwrap().as_str(),
        Some("A test skill")
    );
    assert!(body.contains("# My Skill"));
}

#[test]
fn missing_frontmatter() {
    let err = parse_frontmatter("# No frontmatter here").unwrap_err();
    assert!(matches!(err, SkillError::Parse(_)));
    assert!(err.to_string().contains("must start with YAML frontmatter"));
}

#[test]
fn unclosed_frontmatter() {
    let content = "---\nname: my-skill\ndescription: A test skill\n";
    let err = parse_frontmatter(content).unwrap_err();
    assert!(err.to_string().contains("not properly closed"));
}

#[test]
fn invalid_yaml() {
    let content = "---\nname: [invalid\ndescription: broken\n---\nBody here\n";
    let err = parse_frontmatter(content).unwrap_err();
    assert!(err.to_string().contains("Invalid YAML"));
}

#[test]
fn non_dict_frontmatter() {
    let content = "---\n- just\n- a\n- list\n---\nBody\n";
    let err = parse_frontmatter(content).unwrap_err();
    assert!(err.to_string().contains("must be a YAML mapping"));
}

#[test]
fn read_valid_skill() {
    let tmp = tempdir().unwrap();
    let skill_dir = tmp.path().join("my-skill");
    fs::create_dir(&skill_dir).unwrap();
    fs::write(
        skill_dir.join("SKILL.md"),
        "---\nname: my-skill\ndescription: A test skill\nlicense: MIT\n---\n# My Skill\n",
    )
    .unwrap();
    let props = read_properties(&skill_dir).unwrap();
    assert_eq!(props.name, "my-skill");
    assert_eq!(props.description, "A test skill");
    assert_eq!(props.license.as_deref(), Some("MIT"));
}

#[test]
fn read_with_metadata() {
    let tmp = tempdir().unwrap();
    let skill_dir = tmp.path().join("my-skill");
    fs::create_dir(&skill_dir).unwrap();
    fs::write(
        skill_dir.join("SKILL.md"),
        "---\nname: my-skill\ndescription: A test skill\nmetadata:\n  author: Test Author\n  version: 1.0\n---\nBody\n",
    )
    .unwrap();
    let props = read_properties(&skill_dir).unwrap();
    assert_eq!(
        props.metadata,
        vec![
            ("author".to_string(), "Test Author".to_string()),
            ("version".to_string(), "1.0".to_string()),
        ]
    );
}

#[test]
fn missing_skill_md() {
    let tmp = tempdir().unwrap();
    let err = read_properties(tmp.path()).unwrap_err();
    assert!(err.to_string().contains("SKILL.md not found"));
}

#[test]
fn missing_name() {
    let tmp = tempdir().unwrap();
    let skill_dir = tmp.path().join("my-skill");
    fs::create_dir(&skill_dir).unwrap();
    fs::write(
        skill_dir.join("SKILL.md"),
        "---\ndescription: A test skill\n---\nBody\n",
    )
    .unwrap();
    let err = read_properties(&skill_dir).unwrap_err();
    assert!(matches!(err, SkillError::Validation { .. }));
    assert!(err.to_string().contains("Missing required field") && err.to_string().contains("name"));
}

#[test]
fn missing_description() {
    let tmp = tempdir().unwrap();
    let skill_dir = tmp.path().join("my-skill");
    fs::create_dir(&skill_dir).unwrap();
    fs::write(
        skill_dir.join("SKILL.md"),
        "---\nname: my-skill\n---\nBody\n",
    )
    .unwrap();
    let err = read_properties(&skill_dir).unwrap_err();
    assert!(
        err.to_string().contains("Missing required field")
            && err.to_string().contains("description")
    );
}

#[test]
fn find_skill_md_prefers_uppercase() {
    let tmp = tempdir().unwrap();
    let skill_dir = tmp.path().join("my-skill");
    fs::create_dir(&skill_dir).unwrap();
    fs::write(skill_dir.join("SKILL.md"), "uppercase").unwrap();
    // On case-insensitive filesystems these are the same file; only assert the
    // uppercase-preference contract when both can coexist.
    let lower = skill_dir.join("skill.md");
    if !lower.exists() {
        fs::write(&lower, "lowercase").unwrap();
    }
    let result = find_skill_md(&skill_dir).unwrap();
    assert_eq!(
        result.file_name().unwrap().to_string_lossy().to_lowercase(),
        "skill.md"
    );
}

#[test]
fn find_skill_md_accepts_lowercase() {
    let tmp = tempdir().unwrap();
    let skill_dir = tmp.path().join("my-skill");
    fs::create_dir(&skill_dir).unwrap();
    fs::write(skill_dir.join("skill.md"), "lowercase").unwrap();
    let result = find_skill_md(&skill_dir).unwrap();
    assert_eq!(
        result.file_name().unwrap().to_string_lossy().to_lowercase(),
        "skill.md"
    );
}

#[test]
fn find_skill_md_returns_none_when_missing() {
    let tmp = tempdir().unwrap();
    let skill_dir = tmp.path().join("my-skill");
    fs::create_dir(&skill_dir).unwrap();
    assert!(find_skill_md(&skill_dir).is_none());
}

#[test]
fn read_properties_with_lowercase_skill_md() {
    let tmp = tempdir().unwrap();
    let skill_dir = tmp.path().join("my-skill");
    fs::create_dir(&skill_dir).unwrap();
    fs::write(
        skill_dir.join("skill.md"),
        "---\nname: my-skill\ndescription: A test skill\n---\n# My Skill\n",
    )
    .unwrap();
    let props = read_properties(&skill_dir).unwrap();
    assert_eq!(props.name, "my-skill");
    assert_eq!(props.description, "A test skill");
}

#[test]
fn read_with_allowed_tools() {
    let tmp = tempdir().unwrap();
    let skill_dir = tmp.path().join("my-skill");
    fs::create_dir(&skill_dir).unwrap();
    fs::write(
        skill_dir.join("SKILL.md"),
        "---\nname: my-skill\ndescription: A test skill\nallowed-tools: Bash(jq:*) Bash(git:*)\n---\nBody\n",
    )
    .unwrap();
    let props = read_properties(&skill_dir).unwrap();
    assert_eq!(
        props.allowed_tools.as_deref(),
        Some("Bash(jq:*) Bash(git:*)")
    );
    let d = props.to_dict();
    assert_eq!(d["allowed-tools"], "Bash(jq:*) Bash(git:*)");
}