Skip to content

docs: add t-linter integration guide#27

Merged
koxudaxi merged 2 commits into
mainfrom
docs/add-t-linter-integration
Mar 19, 2026
Merged

docs: add t-linter integration guide#27
koxudaxi merged 2 commits into
mainfrom
docs/add-t-linter-integration

Conversation

@koxudaxi

@koxudaxi koxudaxi commented Mar 19, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Documentation
    • Added comprehensive editor integration guide for t-linter, covering installation (pip/uv), CLI commands for checking and formatting templates, running an LSP server, VSCode setup with configuration options, support for other LSP-capable editors, and pyproject.toml configuration examples.

@coderabbitai

coderabbitai Bot commented Mar 19, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cbb1ca3e-bff5-49c0-8ba1-4a9c88467862

📥 Commits

Reviewing files that changed from the base of the PR and between 4862105 and b227502.

📒 Files selected for processing (6)
  • README.md
  • docs/index.md
  • docs/llms-full.txt
  • docs/llms.txt
  • docs/usage/editor-integration.md
  • zensical.toml

Walkthrough

Added comprehensive documentation for t-linter, a Python linter/formatter/LSP server for PEP 750 t-strings. Updates include installation instructions, CLI command reference (check and format operations), LSP server setup, and editor-specific integration guidance for VSCode and other LSP-capable editors.

Changes

Cohort / File(s) Summary
Editor Integration Documentation
docs/usage/editor-integration.md
New comprehensive guide covering t-linter installation (pip/uv), CLI commands (check with output formats and --error-on-issues, format with --check and stdin support), LSP server usage, VSCode setup (with optional Python language server disable and serverPath config), other editor LSP guidance, and pyproject.toml configuration under [tool.t-linter].
Documentation Navigation & References
README.md, docs/index.md, docs/llms.txt, docs/llms-full.txt, zensical.toml
Added "Editor Integration (t-linter)" navigation entries and references across documentation index, generated LLM context files, and site navigation configuration to surface the new editor integration documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A linter bounces through the editor's domain,
With checks and formats—t-strings explained!
VSCode hops along with configuration neat,
LSP whispers diagnostics so sweet,
Documentation blossoms, integration complete! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add t-linter integration guide' accurately summarizes the main change: adding comprehensive documentation for t-linter editor integration across multiple documentation files and configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-t-linter-integration
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

Copy link
Copy Markdown
Contributor

📚 Docs Preview: https://pr-27.tstring-structured-data.pages.dev

@koxudaxi
koxudaxi merged commit 22419d9 into main Mar 19, 2026
9 checks passed
@koxudaxi
koxudaxi deleted the docs/add-t-linter-integration branch March 19, 2026 17:27
@github-actions github-actions Bot added the breaking-change-analyzed PR has been analyzed for breaking changes label Mar 19, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Breaking Change Analysis

Result: No breaking changes detected

Reasoning: PR #27 is purely a documentation change that adds an editor integration guide for t-linter. All changes are to markdown documentation files (README.md, docs/usage/editor-integration.md), LLM-friendly text files (llms.txt, llms-full.txt), navigation config (docs/index.md, zensical.toml), and changelog updates. No source code was modified - no changes to parsing logic, Python APIs, Rust bindings, output formats, or default behaviors.


This analysis was performed by Claude Code Action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking-change-analyzed PR has been analyzed for breaking changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant