AGENT SKILL

yaml-pro

YAML authoring and processing — gotchas, validation, and safe loading — use when writing configs or parsing YAML.

License 许可
MIT
所属仓库
TanNhatCMS/jarvis
最近更新
2026-11-07
Stars
★ 0
Forks
1

01 前言 Front Matter

name
yaml-pro
category
document-processing
description
YAML authoring and processing — gotchas, validation, and safe loading — use when writing configs or parsing YAML.

03 SKILL.md 正文

Overview

YAML is the config language of the DevOps world — readable, but full of footguns (the infamous no → false, octal surprises, billion-laughs attacks). This skill covers writing safe, predictable YAML and parsing it defensively in code.

When to use

  • Authoring configs (CI pipelines, Kubernetes manifests, app settings)
  • Designing YAML-based file formats or DSLs
  • Parsing YAML safely in applications (avoiding deserialization attacks)
  • Templating YAML (anchors, merge keys, and when to avoid them)
  • Validating YAML configs with schemas in CI

Core concepts

Quote defensively. YAML's implicit typing converts unquoted yes/no/on/off, 0o17-style numbers, and version-like strings (3.10 → 3.1). Quote strings that could be misinterpreted — especially versions, identifiers with leading zeros ("007"), and anything resembling a boolean. Explicit is better than clever.

Safe loading only. Never use a full YAML loader on untrusted input — it can instantiate arbitrary objects (the classic deserialization attack). Always use the safe loader, which handles only plain scalars, lists, and maps. This is non-negotiable for any YAML from users or networks.

Anchors and merge keys: use sparingly. &anchor / *alias / <<: *merge reduce duplication in hand-written configs, but they complicate programmatic processing and confuse newcomers. Fine for small DRY wins; for heavy reuse, prefer a templating layer or config generation in code.

Schema-validate configs. JSON Schema validates YAML too (YAML is a superset of JSON). Validate CI configs, app settings, and manifests against a schema in CI — catching a typo'd key at commit time beats debugging a silent misconfig in production.

Multi-document files. --- separates documents in one stream; some tools read only the first. Know whether your consumer handles multi-doc files before relying on them.

Practical workflow

  1. Start from a known-good example for the target system; adapt minimally rather than writing from memory.
  2. Quote aggressively: versions, booleans-as-strings, leading-zero numbers, and any value where the type matters downstream.
  3. Keep nesting shallow (3–4 levels max); deep nesting is hard to read and easy to mis-indent — refactor into flatter structures or multiple files.
  4. Validate in CI: schema check + a dry-run/parse of the consuming tool (e.g. kubectl --dry-run, CI config linter) on every change.
  5. In code, always safe-load; convert to typed config objects with defaults and validation immediately after parsing — don't pass raw dicts around.
  6. Document the config: a commented example file or schema with descriptions is worth more than a wiki page nobody updates.

Common pitfalls

  • The Norway problem: no/yes/on/off becoming booleans — quote country codes and string flags.
  • Tabs for indentation — forbidden in YAML; use spaces, consistently (2 is the convention).
  • Version 3.10 parsed as float 3.1 — quote versions, always.
  • Merge-key surprises: <<: *base silently overrides in non-obvious order with multiple merges; prefer explicit keys for critical settings.
  • Giant YAML files generated by tools — split into multiple files with clear naming; 2000-line YAML is unreviewable.
  • Secrets in YAML committed to git — configs get committed; secrets don't belong in them. Reference secret stores via placeholders resolved at deploy time.

04 同仓库更多 Skills

TanNhatCMS
TanNhatCMS/jarvis

web-scrape

Turn web pages into LLM-ready markdown via the Firecrawl API (renders JS, anti-bot handling). Use when browser_open/fetch fails on JS-heavy pages, or when you need clean markdown/structured extraction from a site. Requires FIRECRAWL_API_KEY.

★ 0
TanNhatCMS
TanNhatCMS/jarvis

design-taste-frontend

tasteskill v2, the anti-slop frontend skill. Art direction for websites, distilled from a study of 247 curated gallery sites (One Page Love, Awwwards Sites of the Day). Deals researched directions (idea, composition, type, palette, photographs, section blueprints) from a library, enforces a strict no-slop house style with a real-browser inspector, and runs a look-and-fix loop on screenshots. Use this whenever you build, design, redesign, restyle, polish or review a landing page, marketing site, portfolio, product page, one-pager, hero or any public-facing web page, in any stack (HTML/CSS, React, Next.js, Vue, Svelte, Astro, Tailwind) — also when the user says a page looks generic, templated, "AI-made", sloppy, or asks to make it look designed, premium, award-level or less like every other site. Not for dashboards or app screens.

★ 0
TanNhatCMS
TanNhatCMS/jarvis

test-driven-development

Use when implementing any feature or bugfix, before writing implementation code

★ 0
TanNhatCMS
TanNhatCMS/jarvis

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes

★ 0
TanNhatCMS
TanNhatCMS/jarvis

requesting-code-review

Use when completing tasks, implementing major features, or before merging to verify work meets requirements

★ 0
TanNhatCMS
TanNhatCMS/jarvis

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).

★ 0