Umbraco Skill Code Analyzer

What it does

This skill is a static analysis tool designed to validate code examples found within SKILL.md files, specifically for Umbraco development. It checks for issues related to import paths, extension types, deprecated coding patterns, and performs optional TypeScript compilation. The tool helps ensure code quality and adherence to Umbraco best practices by identifying potential problems early in the development process.

When to use it

• When developing or updating SKILL.md files containing Umbraco code examples.
• To proactively identify and fix issues with import paths, extension types, and deprecated patterns.
• As part of a continuous integration workflow to maintain consistent code quality across Umbraco skills.

Key capabilities

• Import Path Validation: Checks @umbraco-cms/backoffice/* imports against known modules.
• Extension Type Verification: Validates type: values against recognized Umbraco extension types.
• Deprecated Pattern Detection: Flags outdated code patterns for potential refactoring.
• TypeScript Compilation (Optional): Performs syntax and type checking using TypeScript.
• Detailed Reporting: Generates a code-analysis-report.json file with timestamped results, issue counts, and specific details about detected problems.

Example prompts

This skill doesn't directly respond to user prompts. Instead, it is run as a script within the development environment:

1. npx skills add https://github.com/umbraco/umbraco-cms-backoffice-skills --skill umbraco-skill-code-analyzer (to install)
2. cd .claude/skills/umbraco-skill-code-analyzer/scripts && npm install --silent && npx tsx analyze-code.ts (to run the analysis)

Tips & gotchas

• TypeScript Dependency: Requires Node.js and npm for TypeScript compilation. The CHECK_TYPESCRIPT environment variable can be set to false to skip this step if not needed.
• Updating Known Values: The tool relies on lists of known modules and extension types, which may need periodic updates via editing the analyze-code.ts script.
• Report Interpretation: The generated JSON report provides detailed information about identified issues; review it carefully to understand and address any flagged problems.