Disable Auto-Escaping In VS Code MSSQL For Readability

Introduction

This article addresses a critical usability issue within the Microsoft VS Code MSSQL extension, specifically concerning the automatic escaping and quoting of generated SQL code. For users with dyslexia, this feature can significantly hinder readability and workflow efficiency. This article proposes a solution: an option to disable the automatic escaping of all generated SQL code, providing users with greater control over code formatting and style.

Problem Statement: The Readability Barrier

The core issue revolves around the automatic insertion of square brackets around every element of generated SQL code. This behavior, inherited from SQL Server Management Studio (SSMS) or similar environments, applies to code snippets generated from rote scripts (e.g., "SELECT TOP 1000"), scaffolding tools, and even AI-powered code completions like those from GitHub Copilot. While intended to ensure proper syntax and prevent errors, this excessive escaping creates a significant readability barrier for some users, particularly those with dyslexia.

For individuals with dyslexia, the visual clutter introduced by these square brackets can make it challenging to parse the code and understand its structure. This visual noise effectively obscures the underlying logic and increases the cognitive load required to interpret the code, leading to frustration and reduced productivity. The forced adherence to a specific formatting style, which may not be conducive to individual reading preferences, further exacerbates the problem.

The current lack of control over this automatic escaping forces users to resort to manual workarounds, such as running regular expressions to clean up the code after it has been generated. This not only defeats the purpose of using scaffolding and AI code completion tools but also adds an unnecessary step to the development process. The need to constantly reformat code detracts from more important tasks and reduces overall efficiency.

The Dyslexic Perspective: A Matter of Accessibility

It is important to recognize that readability is not a one-size-fits-all concept. What may be considered best practice or standard formatting for some can be a significant obstacle for others. In the case of dyslexia, the visual presentation of code plays a crucial role in comprehension and accessibility. The ability to customize formatting and style is essential for creating a comfortable and productive coding environment.

By providing an option to disable automatic escaping, the VS Code MSSQL extension can cater to a wider range of user preferences and needs. This simple change can have a profound impact on the usability of the tool for individuals with dyslexia, empowering them to work more efficiently and effectively.

Proposed Solution: An Option to Disable Automatic Escaping

The proposed solution is straightforward: introduce an option within the VS Code MSSQL extension to disable the automatic escaping of all generated SQL code. This option would allow users to control whether square brackets are automatically added around identifiers, keywords, and other code elements.

Implementation Details

• Settings Panel: The option could be implemented as a simple checkbox or toggle switch in the extension's settings panel. This would provide a clear and intuitive way for users to enable or disable the feature.
• Granularity: While the primary focus is on disabling all automatic escaping, consideration could be given to providing more granular control. For example, users might want to disable escaping for identifiers but retain it for keywords.
• Default Behavior: The default behavior should be carefully considered. It may be appropriate to leave automatic escaping enabled by default to maintain backward compatibility and avoid unexpected behavior for existing users. However, the option should be clearly discoverable and easily accessible.

Benefits of the Solution

• Improved Readability: Disabling automatic escaping can significantly improve the readability of SQL code for users with dyslexia, reducing visual clutter and cognitive load.
• Enhanced Productivity: By eliminating the need for manual cleanup, users can focus on writing code and solving problems, rather than spending time reformatting generated code.
• Greater Customization: The option to disable automatic escaping provides users with greater control over the appearance of their code, allowing them to tailor it to their individual preferences and needs.
• Increased Accessibility: This feature makes the VS Code MSSQL extension more accessible to users with dyslexia, promoting inclusivity and diversity in the development community.

Illustrative Example

Consider the following SQL code snippet generated with automatic escaping enabled:

SELECT [LET].[MeSetMyOwnStyle]
    ,[LET].[PLEASE]
FROM [This].[is].[MyCode] AS [LET]
WHERE [LET].[MicrosftKnowsBetterThanMe] = 0

With automatic escaping disabled, the same code would appear as follows:

SELECT LET.MeSetMyOwnStyle,
       LET.PLEASE
FROM This.is.MyCode AS LET
WHERE LET.MicrosftKnowsBetterThanMe = 0

The latter version is significantly easier to read for many users, particularly those with dyslexia. The removal of the square brackets reduces visual clutter and allows the underlying structure of the code to become more apparent.

Problem and Motivation

The primary motivation behind this feature request is to address the readability challenges faced by dyslexic users when working with scaffolded and AI-suggested code completions in the VS Code MSSQL extension. While the intention behind automatic escaping is to ensure code correctness, it inadvertently creates a barrier for individuals who struggle with visual processing. The ability to customize formatting is crucial for creating an inclusive and accessible coding environment.

The current lack of control over automatic escaping stands in contrast to the flexibility offered in other areas of code editing. Users can typically customize the formatting and style of C#, TypeScript, JSON, and XML code, but not SQL. This inconsistency is frustrating and undermines the overall user experience.

By implementing the proposed solution, the VS Code MSSQL extension can better serve the needs of all users, regardless of their individual learning styles or visual processing abilities. This simple change can have a significant impact on productivity and job satisfaction.

Related Areas

The proposed feature request primarily affects the following areas of the VS Code MSSQL extension:

• Query Editor: The query editor is the primary interface for writing and executing SQL code. The option to disable automatic escaping would directly impact the appearance of code within the editor.
• GitHub Copilot Integration: The automatic escaping of code completions suggested by GitHub Copilot can be particularly problematic for dyslexic users. Disabling automatic escaping would improve the readability of these suggestions.
• Other: This feature request also relates to any other area of the extension that generates SQL code, such as scaffolding tools and canned queries (e.g., "SELECT TOP 1000").

Confirmation

• [x] I have searched existing feature requests and couldn't find a match
• [ ] I want to help implement this feature

Conclusion

The request to include an option to disable automatic escaping in the VS Code MSSQL extension represents a crucial step toward enhancing usability and accessibility for all users, particularly those with dyslexia. By granting users greater control over code formatting, the extension can foster a more inclusive and productive coding environment. This feature would not only address a significant readability barrier but also align the VS Code MSSQL extension with the customization options available for other programming languages.

For more information on dyslexia and coding, visit the British Dyslexia Association.