lint

Lint and format Kurtosis Starlark (.star) files for syntax and docstrings.

547|97|Updated Feb 14, 2023
One-click install
npx skills add https://github.com/kurtosis-tech/kurtosis --skill lint-kurtosis-tech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: lint
Source: https://github.com/kurtosis-tech/kurtosis/tree/main/skills/lint
Command: npx skills add https://github.com/kurtosis-tech/kurtosis --skill lint-kurtosis-tech

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Lint and format Kurtosis Starlark (.star) files to ensure consistent syntax and readable docstrings, reducing runtime errors and improving code quality.

Core Features & Use Cases

  • Check Formatting: Detect and report style inconsistencies across single files or whole packages.
  • Auto-format: Automatically reformat code to match project style guidelines.
  • Docstring Validation: Verify that the main function contains a descriptive docstring for parameters and behavior.
  • CI Integration: Integrate lint checks into CI pipelines to fail builds on formatting or docstring violations.

Quick Start

Run kurtosis lint on your-package/main.star to check formatting and docstrings.

Frequently Asked Questions about lint

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

FAQPage Schema
How do I format Kurtosis Starlark files and fix style inconsistencies?

To validate Starlark docstrings, run kurtosis lint to verify the main function contains descriptive docstrings for parameters and behavior. This ensures readable code and reduces runtime errors.

Can I integrate Starlark lint checks into a CI pipeline?

Yes, you can integrate Starlark lint checks into CI pipelines to automatically fail builds on formatting or docstring violations. This enforces code quality standards across entire projects during development.

What does Starlark lint validation check for in .star files?

Starlark lint validation checks .star files for correct syntax, formatting consistency, and proper docstrings in the main function. It validates parameters and behavior descriptions to improve overall code quality.

How do I validate Starlark docstrings in my Kurtosis package?

To validate Starlark docstrings, run kurtosis lint to verify the main function contains descriptive docstrings for parameters and behavior. This ensures readable code and reduces runtime errors.

Does kurtosis lint support auto-formatting for entire Starlark projects?

Kurtosis lint supports auto-formatting capabilities for entire Starlark projects by automatically reformatting code to match style guidelines. It validates single files, whole packages, or full project directories during development and CI.