Developed to streamline my personal workflow in CTF crypto challenges, this plugin improves the SageMath development experience in VS Code.
This extension currently provides enhanced syntax highlighting through custom grammar rules (TextMate) and offers basic code completion and hover documentation by parsing SageMath introspection data.
Please note: This extension does not implement a full SageMath Language Server (Language Server Protocol, LSP).
This means that compared to mature language environments with full LSP support (e.g., standard Python with Pylance), you may not experience all modern IDE advanced features with this extension.
The completion and hover functionalities we currently offer are based on a pre-generated list of symbols, rather than real-time, deep semantic analysis of your current project code.
Currently, this extension aims to significantly improve the basic editing experience for SageMath code in VS Code, particularly in terms of syntax highlighting, lookup of common symbols, and basic completion, addressing pain points where standard Python extensions do not recognize SageMath-specific syntax.
-
Enhanced Syntax Highlighting
- Recognizes SageMath-specific keywords, functions, and classes.
- Correctly highlights ring definition syntax such as
R.<x> = ....
-
Basic Code Completion
- Automatically extracts symbols from the SageMath environment to provide completion suggestions.
- Offers real-time suggestions to improve coding efficiency.
-
Hover Documentation
- Displays the docstring when hovering over SageMath functions or classes.
- Uses
docutilsto convert RST-formatted docs into HTML for better readability.
-
Code Runner Integration
-
Supports multiple execution modes for
.sagefiles:- Run normally: Execute Sage scripts directly.
- Run and clean: Execute and then automatically remove the generated
.pyfiles to keep the workspace clean.
-
This project is licensed under the MIT License.