Tomcat Config Lens

Tomcat Config Lens is a read-only VS Code extension that explains Tomcat-related configuration files while you edit them.

Open a supported configuration file, place the cursor on a configuration line, and the Tomcat Explain panel shows what that line means, common examples, defaults, risks, and version context.

这是一个面向 Tomcat 配置阅读场景的解释器。它不会自动修改你的配置文件，也不使用 AI；当前解释来自本地规则库。

Features

• Activity Bar entry for Tomcat.
• Side panel named Tomcat Explain.
• Cursor-following explanations for supported configuration files.
• Multiple matched options on the same line shown as tabs.
• Tomcat version detection from comments, web.xml, paths, and fallback rules.
• Localized UI with zh-CN, en, fr, de, and es.
• Rule text falls back to Chinese when a translation is not available.

Supported Files

Tomcat:

• server.xml
• context.xml
• web.xml
• tomcat-users.xml
• catalina.properties
• logging.properties

Tomcat-adjacent framework files:

• application.properties
• application.yml
• application.yaml
• mybatis-config.xml
• *Mapper.xml

Spring Boot and MyBatis support is intentionally focused on deployment-related configuration, such as embedded Tomcat ports, context paths, datasource settings, mapper paths, and mapper SQL entries.

How To Use

1. Install Tomcat Config Lens.
2. Open a supported configuration file, such as server.xml.
3. Click the Tomcat icon in the Activity Bar.
4. Open Tomcat Explain.
5. Move the cursor to a configuration line.

The panel updates automatically when tomcatConfigLens.autoRevealExplain is enabled.

Settings

• tomcatConfigLens.displayLanguage
  • auto follows VS Code.
  • Also supports zh-CN, en, fr, de, and es.
• tomcatConfigLens.autoRevealExplain
  • When enabled, the explain panel updates as the cursor moves.

Scope

Tomcat Config Lens is currently an explainer, not a configuration editor.

It does not rewrite files, generate production-ready server configurations, or replace the official Tomcat documentation. It is designed to help you understand what you are looking at before you change it.

Feedback

If an important Tomcat configuration line is not recognized, please open an issue with the file name and a small configuration snippet.