Name: lint
Author: hass-energy

Prompt file imported from hass-energy/hafo (.github/prompts/lint.prompt.md). Copyright stays with the author.

---
description: Run linting, type checking, and formatting checks, then fix any issues found
---

# Lint, Format, and Type Check

Run all code quality checks and fix any issues found.

## Step 1: Run All Checks

Execute the following commands to check code quality:

### Python Linting

```bash
uv run ruff check
```

### Python Formatting

```bash
uv run ruff format --check
```

### Type Checking

```bash
uv run pyright
```

### Markdown Formatting

```bash
git ls-files -z '*.md' '*.mdx' | xargs -0 uv run mdformat --check
```

### JSON Formatting

```bash
npm ci
npx --yes prettier@3 --check .
```

## Step 2: Fix Issues

For each tool that reports issues:

### Ruff Linting Issues

- Run `uv run ruff check --fix` to auto-fix issues where possible
- Manually fix remaining issues according to Ruff's suggestions
- Follow HAFO coding standards from `.github/instructions/python.instructions.md`

### Ruff Formatting Issues

- Run `uv run ruff format` to automatically format Python code
- This will fix all formatting issues according to the project's style

### Pyright Type Errors

- Fix type errors by adding proper type hints
- Use `str | None` syntax, not `Optional[str]`
- Ensure all functions, methods, and variables have type hints
- See `.github/instructions/python.instructions.md` for typing guidelines

### Markdown Formatting Issues

- Run `git ls-files -z '*.md' '*.mdx' | xargs -0 uv run mdformat` to format markdown files
- Ensure semantic line breaks (one sentence per line)

### JSON Formatting Issues

- Run `npx --yes prettier@3 --write .` to format JSON files
- This will fix all JSON formatting issues

## Step 3: Verify All Checks Pass

After fixing issues, re-run all checks to ensure everything passes:

```bash
# Python checks
uv run ruff check
uv run ruff format --check
uv run pyright

# Markdown check
git ls-files -z '*.md' '*.mdx' | xargs -0 uv run mdformat --check

# JSON check
npx --yes prettier@3 --check .
```

## Step 4: Summary

Provide a summary of:

- Which checks initially failed
- What issues were fixed
- Any remaining issues that need manual attention
- Confirmation that all checks now pass

## Notes

- **Ruff** handles both linting and formatting for Python code
- **Pyright** provides strict type checking (typeCheckingMode = "strict")
- **mdformat** ensures markdown follows semantic line breaks
- **Prettier** formats JSON files consistently
- All fixes should maintain code functionality while improving quality
- When in doubt, follow existing code patterns in the codebase

````prompt --- description: Run linting, type checking, and formatting checks, then fix any issues found --- # Lint, Format, and Type Check Run all code quality checks and fix any issues found. ## Step 1: Run All Checks Execute the following commands to check code quality: ### Python Linting ```bash uv run ruff check ``` ### Python Formatting ```bash uv run ruff format --check ``` ### Type Checking ```bash uv run pyright ``` ### Markdown Formatting ```bash git ls-files -z '*.md' '*.mdx' | xargs -0 uv run mdformat --check ``` ### JSON Formatting ```bash npm ci npx --yes prettier@3 --check . ``` ## Step 2: Fix Issues For each tool that reports issues: ### Ruff Linting Issues - Run `uv run ruff check --fix` to auto-fix issues where possible - Manually fix remaining issues according to Ruff's suggestions - Follow HAFO coding standards from `.github/instructions/python.instructions.md` ### Ruff Formatting Issues - Run `uv run ruff format` to automatically format Python code - This will fix all formatting issues according to the project's style ### Pyright Type Errors - Fix type errors by adding proper type hints - Use `str | None` syntax, not `Optional[str]` - Ensure all functions, methods, and variables have type hints - See `.github/instructions/python.instructions.md` for typing guidelines ### Markdown Formatting Issues - Run `git ls-files -z '*.md' '*.mdx' | xargs -0 uv run mdformat` to format markdown files - Ensure semantic line breaks (one sentence per line) ### JSON Formatting Issues - Run `npx --yes prettier@3 --write .` to format JSON files - This will fix all JSON formatting issues ## Step 3: Verify All Checks Pass After fixing issues, re-run all checks to ensure everything passes: ```bash # Python checks uv run ruff check uv run ruff format --check uv run pyright # Markdown check git ls-files -z '*.md' '*.mdx' | xargs -0 uv run mdformat --check # JSON check npx --yes prettier@3 --check . ``` ## Step 4: Summary Provide a summary of: - Which checks initially failed - What issues were fixed - Any remaining issues that need manual attention - Confirmation that all checks now pass ## Notes - **Ruff** handles both linting and formatting for Python code - **Pyright** provides strict type checking (typeCheckingMode = "strict") - **mdformat** ensures markdown follows semantic line breaks - **Prettier** formats JSON files consistently - All fixes should maintain code functionality while improving quality - When in doubt, follow existing code patterns in the codebase ````

{ "prompt": "````prompt\n---\ndescription: Run linting, type checking, and formatting checks, then fix any issues found\n---\n\n# Lint, Format, and Type Check\n\nRun all code quality checks and fix any issues found.\n\n## Step 1: Run All Checks\n\nExecute the following commands to check code quality:\n\n### Python Linting\n\n```bash\nuv run ruff check\n```\n\n### Python Formatting\n\n```bash\nuv run ruff format --check\n```\n\n### Type Checking\n\n```bash\nuv run pyright\n```\n\n### Markdown Formatting\n\n```bash\ngit ls-files -z '*.md' '*.mdx' | xargs -0 uv run mdformat --check\n```\n\n### JSON Formatting\n\n```bash\nnpm ci\nnpx --yes prettier@3 --check .\n```\n\n## Step 2: Fix Issues\n\nFor each tool that reports issues:\n\n### Ruff Linting Issues\n\n- Run `uv run ruff check --fix` to auto-fix issues where possible\n- Manually fix remaining issues according to Ruff's suggestions\n- Follow HAFO coding standards from `.github/instructions/python.instructions.md`\n\n### Ruff Formatting Issues\n\n- Run `uv run ruff format` to automatically format Python code\n- This will fix all formatting issues according to the project's style\n\n### Pyright Type Errors\n\n- Fix type errors by adding proper type hints\n- Use `str | None` syntax, not `Optional[str]`\n- Ensure all functions, methods, and variables have type hints\n- See `.github/instructions/python.instructions.md` for typing guidelines\n\n### Markdown Formatting Issues\n\n- Run `git ls-files -z '*.md' '*.mdx' | xargs -0 uv run mdformat` to format markdown files\n- Ensure semantic line breaks (one sentence per line)\n\n### JSON Formatting Issues\n\n- Run `npx --yes prettier@3 --write .` to format JSON files\n- This will fix all JSON formatting issues\n\n## Step 3: Verify All Checks Pass\n\nAfter fixing issues, re-run all checks to ensure everything passes:\n\n```bash\n# Python checks\nuv run ruff check\nuv run ruff format --check\nuv run pyright\n\n# Markdown check\ngit ls-files -z '*.md' '*.mdx' | xargs -0 uv run mdformat --check\n\n# JSON check\nnpx --yes prettier@3 --check .\n```\n\n## Step 4: Summary\n\nProvide a summary of:\n\n- Which checks initially failed\n- What issues were fixed\n- Any remaining issues that need manual attention\n- Confirmation that all checks now pass\n\n## Notes\n\n- **Ruff** handles both linting and formatting for Python code\n- **Pyright** provides strict type checking (typeCheckingMode = \"strict\")\n- **mdformat** ensures markdown follows semantic line breaks\n- **Prettier** formats JSON files consistently\n- All fixes should maintain code functionality while improving quality\n- When in doubt, follow existing code patterns in the codebase\n\n````", "variables": [], "notes": "Run all code quality checks and fix any issues found.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/hass-energy/hafo", "path": ".github/prompts/lint.prompt.md", "ref": "6899e179c6369525acab2adf5d26c38c950fd646", "url": "https://github.com/hass-energy/hafo/blob/6899e179c6369525acab2adf5d26c38c950fd646/.github/prompts/lint.prompt.md", "key": "hass-energy/hafo/.github/prompts/lint.prompt.md" } } }

lint

About

Use it

Manifest

Reviews