Skip to content
atomize
GitHub

VS Code

Author Atomize YAML in VS Code

Development docs · main. Your installed version may differ.

Keep shared Templates recognizable as Atomize YAML Files so teammates get the same authoring tools when they open them.

The full authoring surface is enabled for Durable Atomize YAML Opt-In files:

  • .atomize.yaml
  • .atomize.yml
  • YAML files whose first line is # atomize-yaml

Durable opt-in enables CodeLens actions, save-time validation, diagnostics, snippets, and schema association.

Session Atomize YAML Opt-In provides schema-backed hovers and completions when the extension recognizes a YAML document by structure, without changing its YAML language ID or writing a marker into the file. It does not enable CodeLens or save-time Atomize validation. Prefer a durable marker for shared Templates. GitHub Actions workflow files are excluded from content detection to avoid treating their YAML as Atomize content.

For example, name a shared file feature.atomize.yaml, or put this modeline on the very first line of an otherwise named YAML file:

# atomize-yaml
formatVersion: "1.0"
name: "Feature Breakdown"

Keep the editor language as YAML. The legacy atomize-yaml language ID is not required for schema support. A Mixin can have schema support and snippets, but cannot be run or resolved on its own; add it to a Template before previewing.

Atomize YAML authoring includes:

  • schema hovers and completions
  • snippets for common Template and Mixin structures (type atm- to list them)
  • save-time diagnostics for durable Atomize YAML files
  • CodeLens actions for Validate, Preview, and Generate
  • quick fixes for supported validation warnings

VS Code authoring a built-in Atomize YAML File with YAML syntax highlighting, Atomize CodeLens actions, and the Template filter and task definitions visible.VS Code authoring a built-in Atomize YAML File with YAML syntax highlighting, Atomize CodeLens actions, and the Template filter and task definitions visible.

PrefixInserts
atm-template, atm-mixin, atm-extendsTemplate, Mixin and inheriting-Template scaffolds
atm-task, atm-task-conditionA task, or a task created only when the Story has a tag
atm-task-repeatA task created several times as identical copies (repeat)
atm-filter, atm-filter-ado, atm-filter-saved-query, atm-filter-tagsFilter blocks. The saved-query snippet declares workItemTypes, which describes what the query returns and doesn't filter
atm-estimationStrategy, rounding and normalize
atm-estimation-factor, atm-estimation-tableA Story Estimate conversion by factor (points to hours), or by table (T-shirt sizes, with optional multipliers)
atm-estimation-targettaskType and targetFields for customised processes
atm-estimation-percent-conditionA conditional estimationPercent rule
atm-condition, atm-condition-field, atm-condition-number, atm-condition-customCondition clauses on tags, built-in text fields, numbers (estimation, priority) or custom fields, each offering only the operators its field supports
atm-condition-all, atm-condition-anyCompound AND / OR conditions
atm-validation, atm-custom-fieldsValidation rules and task custom fields

Quick fixes appear on validation warnings that have a safe automatic fix:

  • Add id field derived from task title, for a task that has dependencies or is depended on but has no id
  • Remove conflicting structured filter fields, which a savedQuery ignores (workItemTypes is kept, because it declares the query's types)
  • Strip newlines from single-line field value
  • Rename minimumTaskPoints to minimumTaskEstimate
  • Remove deprecated minimumTaskPoints, when minimumTaskEstimate is also set

Validation runs on saved file content. If you explicitly validate a dirty document, the extension asks you to save first.

Run Offline Validation, then Mock Preview. For inheritance or Mixins, inspect the Resolved Template before editing the source.