fixlink README

There are a lot of coding rules out there and tools that check for conformance to these rules. Unfortunately, these rules often just tell what shouldn't be done but not how to write code with a better quality. Especially developers with few experience just try to get rid of the findings by try and error which does not lead to better code quality at all. This extension offers the possibility to attach fix-links to certain problems that when followed can lead to information how to solve a specific problem. If no concreate solution proposal can be linked generic links to stackoverflow or google search can be added.

Features

Offers possibility to add hyperlinks to the context menu of the light bulb. Via these links developers can get more information of how to solve a problem in a way that increases code quality.

Extension Settings

Include if your extension adds any VS Code settings through the contributes.configuration extension point.

For example:

This extension contributes the following settings:

• "fixlink.targets":

[
    {
        "name": "GoogleSearch",
        "url": "https://www.google.com/search?q=",
        "urlParameter": "${message}",
        "maxParamLength": 500
    },
    {
        "name": "Stackoverflow",
        "url": "https://www.stackoverflow.com/search?q=",
        "urlParameter": "${message}",
        "maxParamLength": 500
    }
]

Parameter:

• name: The context menu title
• url: Url to link to (without parameters)
• urlParameter: URL parameters with placeholders (described below)
• regexp: Regular Expression - can be used if not the complete diagnostic message shall be sent as parameter in the link - the result can be retrieved in placeholder regexp_match (Optional)
• maxParamLength: Parameters are truncated if longer (Optional)

Placeholders that can be used in urlParameter:

• ${languageId} - Replaced by language id of the current editor document
• ${code} - Replaced by diagnostic code of select problem
• ${message} - Replaced by diagnostic message of selected problem
• ${regexp_match} - Replaced by the match of the regexp applied to the message of selected problem

Release Notes

1.0.0

Initial release of FixLink