MTA-6288 Centralized configuration in Visual Studio Code plugin#313
Merged
MTA-6288 Centralized configuration in Visual Studio Code plugin#313
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds a new VS Code procedure documenting running static analysis using Hub-managed analysis profiles, updates the VS Code extension guide to include the new topic, and fixes a small typo in an existing VS Code settings doc. Changes
Sequence Diagram(s)sequenceDiagram
participant VSCode as "VS Code Extension"
participant User as "Developer"
participant Hub as "Hub (Profiles)"
participant FS as "Local FS (.konveyor/profiles)"
participant SS as "Solution Server"
participant LLM as "LLM Proxy (optional)"
rect rgba(200,200,255,0.5)
User->>VSCode: Open Analysis Panel, select Hub profile
end
rect rgba(200,255,200,0.5)
VSCode->>Hub: Request available profiles (auth, URL, SSL)
Hub-->>VSCode: Return profile list / profile data
VSCode->>FS: Store selected profile in .konveyor/profiles
end
rect rgba(255,200,200,0.5)
VSCode->>SS: Trigger analysis using selected profile
SS->>LLM: (if used) Proxy analysis requests
SS-->>VSCode: Analysis results
VSCode-->>User: Display results
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (4)
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc (4)
35-35: Strengthen security guidance for SSL certificate verification.The option to skip SSL certificate verification is a significant security concern. Consider adding a more explicit warning that this option should only be used in development/testing environments and never in production.
🛡️ Suggested security guidance enhancement
-.. Enable *Skip SSL certificate verification* if you want to connect to your Hub without verifying the local SSL certificate in the host. +.. Enable *Skip SSL certificate verification* if you want to connect to your Hub without verifying the local SSL certificate in the host. ++ +WARNING: Skipping SSL certificate verification should only be used in development or testing environments. Do not use this option in production as it exposes your connection to security risks.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc` at line 35, Update the sentence that mentions "Skip SSL certificate verification" to include a clear, explicit security warning: state that skipping SSL verification should only be used in development or testing environments, never in production, and briefly note the risk (exposes you to man-in-the-middle attacks and insecure connections); locate and edit the line containing the phrase "Skip SSL certificate verification" in the docs topic (proc_vscode-analyzing-application-using-profiles.adoc) and replace or append text to make the environment restriction and risk explicit.
8-8: Consider using more formal terminology.The phrase "hard disk" could be replaced with "local disk" or "local file system" for more formal technical documentation.
📝 Suggested terminology update
-When you connect to the Hub from your Visual Studio Code instance, {ProductShortName} downloads the analysis profiles and custom rules present in the Hub to the `.konveyor/profiles` location in your hard disk. You can use the analysis profile that contains custom rules to perform analyses in your Visual Studio Code IDE environment. If you connect to the Hub, the profile configuration options in your IDE instance are disabled. +When you connect to the Hub from your Visual Studio Code instance, {ProductShortName} downloads the analysis profiles and custom rules present in the Hub to the `.konveyor/profiles` location on your local file system. You can use the analysis profile that contains custom rules to perform analyses in your Visual Studio Code IDE environment. If you connect to the Hub, the profile configuration options in your IDE instance are disabled.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc` at line 8, Replace the informal phrase "hard disk" in the sentence that mentions the ".konveyor/profiles" location with a more formal term such as "local disk" or "local file system"; specifically update the sentence "downloads the analysis profiles and custom rules present in the Hub to the `.konveyor/profiles` location in your hard disk." to use "local disk" or "local file system" so the documentation uses consistent formal terminology.
21-24: Consider adding a reference to supported languages documentation.Line 23 mentions "supported languages" but doesn't specify which languages or link to where this is documented. If this information is available elsewhere in the documentation, consider adding a cross-reference for user convenience.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc` around lines 21 - 24, Update the "Prerequisites" section so the phrase "supported languages" links to or lists the documentation that enumerates supported languages; modify the line that currently reads "* You opened a project written in one of the supported languages in your VS Code workspace." to include a cross-reference or short parenthetical (e.g., "see Supported Languages") pointing to the canonical doc or page that lists supported languages so readers can quickly find which languages are supported.
39-39: Improve sentence clarity by breaking into multiple sentences.This sentence is quite long and covers multiple concepts (enabling, periodic downloads, and consequences of not syncing). Consider breaking it into shorter, clearer sentences for better readability.
📝 Suggested clarity improvement
-.. Enable *Profile Sync* to sync the profiles with the Hub. {ProductShortName} periodically downloads the latest version of the profiles from the Hub. {ProductShortName} does not update the profiles and rules if you do not sync the profiles with the Hub. +.. Enable *Profile Sync* to sync the profiles with the Hub. When enabled, {ProductShortName} periodically downloads the latest version of the profiles from the Hub. If you do not enable profile sync, {ProductShortName} does not update the profiles and rules.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc` at line 39, The long sentence starting with "Enable *Profile Sync*" should be split into multiple sentences for clarity: first state that users should enable Profile Sync to sync profiles with the Hub (reference the phrase "Enable *Profile Sync*"), then add a second sentence saying that {ProductShortName} periodically downloads the latest profiles from the Hub, and a third sentence clarifying that {ProductShortName} will not update profiles and rules unless Profile Sync is enabled; keep wording concise and preserve the terms "profiles", "rules", and "{ProductShortName}" for consistency.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc`:
- Line 35: Update the sentence that mentions "Skip SSL certificate verification"
to include a clear, explicit security warning: state that skipping SSL
verification should only be used in development or testing environments, never
in production, and briefly note the risk (exposes you to man-in-the-middle
attacks and insecure connections); locate and edit the line containing the
phrase "Skip SSL certificate verification" in the docs topic
(proc_vscode-analyzing-application-using-profiles.adoc) and replace or append
text to make the environment restriction and risk explicit.
- Line 8: Replace the informal phrase "hard disk" in the sentence that mentions
the ".konveyor/profiles" location with a more formal term such as "local disk"
or "local file system"; specifically update the sentence "downloads the analysis
profiles and custom rules present in the Hub to the `.konveyor/profiles`
location in your hard disk." to use "local disk" or "local file system" so the
documentation uses consistent formal terminology.
- Around line 21-24: Update the "Prerequisites" section so the phrase "supported
languages" links to or lists the documentation that enumerates supported
languages; modify the line that currently reads "* You opened a project written
in one of the supported languages in your VS Code workspace." to include a
cross-reference or short parenthetical (e.g., "see Supported Languages")
pointing to the canonical doc or page that lists supported languages so readers
can quickly find which languages are supported.
- Line 39: The long sentence starting with "Enable *Profile Sync*" should be
split into multiple sentences for clarity: first state that users should enable
Profile Sync to sync profiles with the Hub (reference the phrase "Enable
*Profile Sync*"), then add a second sentence saying that {ProductShortName}
periodically downloads the latest profiles from the Hub, and a third sentence
clarifying that {ProductShortName} will not update profiles and rules unless
Profile Sync is enabled; keep wording concise and preserve the terms "profiles",
"rules", and "{ProductShortName}" for consistency.
mpershina
reviewed
Feb 23, 2026
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
Outdated
Show resolved
Hide resolved
mpershina
reviewed
Feb 23, 2026
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
Outdated
Show resolved
Hide resolved
mpershina
reviewed
Feb 23, 2026
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
Outdated
Show resolved
Hide resolved
mpershina
reviewed
Feb 23, 2026
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
Outdated
Show resolved
Hide resolved
mpershina
reviewed
Feb 23, 2026
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
Outdated
Show resolved
Hide resolved
mpershina
reviewed
Feb 23, 2026
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
Outdated
Show resolved
Hide resolved
mpershina
reviewed
Feb 23, 2026
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
Outdated
Show resolved
Hide resolved
Collaborator
Author
abrugaro
reviewed
Mar 11, 2026
|
|
||
| .Prerequisites | ||
|
|
||
| * You opened a project written in one of the supported languages in your Visual Studio Code workspace. {ProductShortName} can analyze source code written in `Java`, `C#`, `.NET`, `Node.js`, and `Python`. |
There was a problem hiding this comment.
For the VScode extensions the languajes are java, javascript, .net, go and c#.
Collaborator
Author
There was a problem hiding this comment.
I've modified the languages. Could you check, please?
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/topics/vscode/proc_configuring-lighstspeed-ide-settings.adoc (1)
5-5:⚠️ Potential issue | 🟡 MinorFix typo in anchor ID and corresponding cross-reference.
The anchor ID contains "lighstspeed" (a typo for "lightspeed"). An xref in
docs/topics/vscode/proc_configuring-profile-settings.adoc:15references this anchor. Update both the anchor ID and the xref together:
docs/topics/vscode/proc_configuring-lighstspeed-ide-settings.adoc:5: Change toconfiguring-lightspeed-ide-settings_{context}docs/topics/vscode/proc_configuring-profile-settings.adoc:15: Changexref:configuring-lighstspeed-ide-settings_vsc-extension-guidetoxref:configuring-lightspeed-ide-settings_vsc-extension-guide🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/vscode/proc_configuring-lighstspeed-ide-settings.adoc` at line 5, Update the misspelled anchor ID "configuring-lighstspeed-ide-settings_{context}" to "configuring-lightspeed-ide-settings_{context}" and update the cross-reference token "xref:configuring-lighstspeed-ide-settings_vsc-extension-guide" to "xref:configuring-lightspeed-ide-settings_vsc-extension-guide" so the anchor and xref match.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/topics/vscode/proc_configuring-lighstspeed-ide-settings.adoc`:
- Line 5: Update the misspelled anchor ID
"configuring-lighstspeed-ide-settings_{context}" to
"configuring-lightspeed-ide-settings_{context}" and update the cross-reference
token "xref:configuring-lighstspeed-ide-settings_vsc-extension-guide" to
"xref:configuring-lightspeed-ide-settings_vsc-extension-guide" so the anchor and
xref match.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 23338442-3b51-4297-985c-40b348b09635
📒 Files selected for processing (1)
docs/topics/vscode/proc_configuring-lighstspeed-ide-settings.adoc
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc (1)
37-37: Consider clarifying the SSL certificate phrasing.The phrase "local SSL certificate in the host" could be clearer. Consider rephrasing as "host's SSL certificate" or "SSL certificate on the host" for better readability.
♻️ Suggested rewording
-.. If you want to connect to your Hub without verifying the local SSL certificate in the host, enable *Skip SSL certificate verification*. +.. If you want to connect to your Hub without verifying the host's SSL certificate, enable *Skip SSL certificate verification*.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc` at line 37, Replace the unclear phrase "local SSL certificate in the host" in the sentence that mentions enabling "Skip SSL certificate verification" with a clearer wording such as "host's SSL certificate" or "SSL certificate on the host"; update the sentence to read something like: "If you want to connect to your Hub without verifying the host's SSL certificate, enable Skip SSL certificate verification." Ensure the changed sentence preserves emphasis on "Skip SSL certificate verification."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc`:
- Line 25: The documentation line listing supported languages uses the incorrect
capitalization "Javascript"; update the text to "JavaScript" (capital S) in the
sentence that reads "{ProductShortName} can analyze source code written in
`Java`, `C#`, `.NET`, `Go`, and `Javascript`", replacing `Javascript` with
`JavaScript` so the language name is spelled correctly.
- Line 43: Update the sentence to correct the grammar: change "administrator
deployed LLM proxy" to include an article and proper tense, e.g., "the
administrator has deployed an LLM proxy" or "the administrator deployed an LLM
proxy", so the full line reads: "{ProductShortName} does not update the profiles
and rules if you do not sync the profiles with the Hub. When you enable the
profile sync and the administrator has deployed an LLM proxy in the cluster,
{ProductShortName} uses the proxy service to connect to the LLM."
---
Nitpick comments:
In `@docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc`:
- Line 37: Replace the unclear phrase "local SSL certificate in the host" in the
sentence that mentions enabling "Skip SSL certificate verification" with a
clearer wording such as "host's SSL certificate" or "SSL certificate on the
host"; update the sentence to read something like: "If you want to connect to
your Hub without verifying the host's SSL certificate, enable Skip SSL
certificate verification." Ensure the changed sentence preserves emphasis on
"Skip SSL certificate verification."
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 41e3cc55-47fb-4892-ab86-95189901e062
📒 Files selected for processing (1)
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
Outdated
Show resolved
Hide resolved
| .. To use the Solution Server to suggest resolutions for the issues in the source code, enable *Solution Server* . | ||
| .. To sync the profiles with the Hub, enable *Profile Sync*. {ProductShortName} periodically downloads the latest version of the profiles from the Hub. | ||
| + | ||
| {ProductShortName} does not update the profiles and rules if you do not sync the profiles with the Hub. When you enable the profile sync and the administrator deployed LLM proxy in the cluster, {ProductShortName} uses the proxy service to connect to the LLM. |
There was a problem hiding this comment.
Fix the grammatical error.
The phrase "administrator deployed LLM proxy" is missing an article and has a verb tense issue. It should read "administrator has deployed an LLM proxy" or "administrator deployed an LLM proxy".
📝 Proposed fix
-{ProductShortName} does not update the profiles and rules if you do not sync the profiles with the Hub. When you enable the profile sync and the administrator deployed LLM proxy in the cluster, {ProductShortName} uses the proxy service to connect to the LLM.
+{ProductShortName} does not update the profiles and rules if you do not sync the profiles with the Hub. When you enable the profile sync and the administrator has deployed an LLM proxy in the cluster, {ProductShortName} uses the proxy service to connect to the LLM.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| {ProductShortName} does not update the profiles and rules if you do not sync the profiles with the Hub. When you enable the profile sync and the administrator deployed LLM proxy in the cluster, {ProductShortName} uses the proxy service to connect to the LLM. | |
| {ProductShortName} does not update the profiles and rules if you do not sync the profiles with the Hub. When you enable the profile sync and the administrator has deployed an LLM proxy in the cluster, {ProductShortName} uses the proxy service to connect to the LLM. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc` at
line 43, Update the sentence to correct the grammar: change "administrator
deployed LLM proxy" to include an article and proper tense, e.g., "the
administrator has deployed an LLM proxy" or "the administrator deployed an LLM
proxy", so the full line reads: "{ProductShortName} does not update the profiles
and rules if you do not sync the profiles with the Hub. When you enable the
profile sync and the administrator has deployed an LLM proxy in the cluster,
{ProductShortName} uses the proxy service to connect to the LLM."
fabianvf
approved these changes
Mar 19, 2026
djzager
approved these changes
Mar 20, 2026
abrugaro
approved these changes
Mar 23, 2026
anarnold97
reviewed
Mar 24, 2026
|
|
||
| The centralized configuration management standardizes the analysis configuration and custom rules across projects to produce a consistent result. This allows the architect to create and manage the necessary profiles, thereby simplifying the lifecycle of analysis configurations and rules. Migrators can run analyses either by using local profile configuration or by using profiles from the Hub. | ||
|
|
||
| When you connect to the Hub from your Visual Studio Code instance, {ProductShortName} downloads the analysis profiles and custom rules present in the Hub to the `.konveyor/profiles` location in your hard disk. You can use the analysis profile that has custom rules to perform analyses in your Visual Studio Code IDE environment. If you connect to the Hub, the {ProductShortName} extension disables profile manager options in your IDE instance. |
Contributor
There was a problem hiding this comment.
Suggested change
| When you connect to the Hub from your Visual Studio Code instance, {ProductShortName} downloads the analysis profiles and custom rules present in the Hub to the `.konveyor/profiles` location in your hard disk. You can use the analysis profile that has custom rules to perform analyses in your Visual Studio Code IDE environment. If you connect to the Hub, the {ProductShortName} extension disables profile manager options in your IDE instance. | |
| When you connect to the Hub from your Visual Studio Code instance, {ProductShortName} downloads the analysis profiles and custom rules present in the Hub to the `.konveyor/profiles` location on your hard disk. You can use the analysis profile that has custom rules to perform analyses in your Visual Studio Code IDE environment. If you connect to the Hub, the {ProductShortName} extension disables profile manager options in your IDE instance. |
the preposition on feels a bit weird
anarnold97
reviewed
Mar 24, 2026
|
|
||
| . Click the {mta-dl-plugin} extension and click *Open Analysis Panel*. | ||
|
|
||
| . In settings (image:settings-icon.png[]), click *Configure Hub Settings* . |
Contributor
There was a problem hiding this comment.
you need to add a title to any image used
it could be flagged as an accesibility issue
Collaborator
Author
There was a problem hiding this comment.
Got it 👍 Done, thanks!
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Pkylas007
force-pushed
the
mta-6288-centralized-config-vscode-ide-plugin
branch
from
bb03b43 to
ef91070
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
JIRA
Version
Preview
Summary by CodeRabbit