check-metadata-typos

Run codespell to detect spelling typos in ETL metadata files.

156|30|Updated Sep 17, 2021
One-click install
npx skills add https://github.com/owid/etl --skill check-metadata-typos
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-metadata-typos
Source: https://github.com/owid/etl/tree/main/.claude/skills/check-metadata-typos
Command: npx skills add https://github.com/owid/etl --skill check-metadata-typos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps ensure metadata quality by scanning .meta.yml files and snapshot .dvc files for spelling typos using codespell, reducing miscommunication and data confusion.

Core Features & Use Cases

  • Scope options mirror the Skill's guidance: current step only, all ETL metadata (garden, meadow, grapher), snapshot metadata, or all metadata, with archived items automatically excluded.
  • Codespell-based detection with a maintained ignore list to minimize false positives and support domain-specific terms.
  • Easy integration into CI pipelines or data quality workflows to catch typos before publication.

Quick Start

Scan active ETL metadata with codespell across the selected scope.

Frequently Asked Questions about check-metadata-typos

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check ETL metadata files for spelling typos?

You check ETL metadata files for spelling typos by running codespell across .meta.yml and snapshot .dvc files, which outputs a structured list of typos with file paths, line numbers, and suggested corrections.

Can I scan only the current ETL step metadata instead of all files?

You can select scope options to scan the current step only, all ETL metadata, snapshot metadata, or all metadata, with archived steps and snapshots automatically excluded from the spell-check.

Do I need codespell installed to run spell-check on .meta.yml files?

Yes, codespell must be installed to run spell-check validation on .meta.yml and .dvc files. The Skill leverages codespell detection with a maintained ignore list to minimize false positives for domain-specific terms.

What is the best way to integrate metadata spell-check into a CI pipeline?

The best way to integrate metadata spell-check into a CI pipeline is running codespell validation on .meta.yml and .dvc files across your selected scope to catch typos before data publication.

Are archived ETL steps included in the metadata spell-check validation?

Archived ETL steps and snapshots are automatically excluded from the metadata spell-check validation, ensuring codespell only scans active .meta.yml and .dvc files to maintain data quality.