Proposal: gcsim VS Code Extension for Enhanced Authoring (Linting/Syntax Highlighting)

[beive60]

Hey everyone,

I'd like to start a discussion about the potential development of a VS Code extension to improve the gcsim authoring experience. This extension would include linting and syntax highlighting capabilities.

Currently, gcsim scripts are written in either a Web IDE or a plain text editor. Both approaches have limitations:

• Web IDEs might not support familiar hotkeys, impacting efficiency.
• Text editors lack built-in error checking and rule validation, making it tedious to ensure accuracy.

A dedicated VS Code extension could address these challenges and offer several benefits:

• Early Error Detection: The linting feature would catch syntax mistakes in real-time, prompting immediate correction and reducing runtime errors.
• Improved Authoring Efficiency: Syntax highlighting enhances code readability and reduces the likelihood of errors, leading to more productive development.
• Lower Learning Curve: The extension would ease the process of learning and remembering gcsim syntax rules, making it more accessible to beginners.
• Faster Iteration: Familiar hotkeys and streamlined workflows would shorten the time to run gcsim simulations, enabling more rapid data acquisition.

Here are some of the features we could consider implementing:

• Linting: Real-time error checking based on gcsim syntax rules.
• Syntax Highlighting: Color-coding of gcsim keywords and variables for improved readability.
• Code Completion: Autocompletion suggestions for gcsim functions and variables.
• Documentation Pop-ups: Displaying documentation for gcsim functions and variables on hover.

I believe these features would significantly enhance the gcsim authoring experience. I'm eager to hear your thoughts, suggestions, and any ideas you might have!

Let me know what you think!