MTA-6288 Centralized configuration in Visual Studio Code plugin#313
Open
MTA-6288 Centralized configuration in Visual Studio Code plugin#313
Conversation
added 2 commits
February 19, 2026 16:36
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
📝 WalkthroughWalkthroughAdds a new VS Code procedure documenting how to run static analysis using Hub-managed analysis profiles, and updates the VS Code extension guide to include the new topic; also fixes a small typo in an existing VS Code settings doc. Changes
Sequence Diagram(s)(omitted) 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)
📝 Coding Plan
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
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
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?
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
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
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
3 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