Merge pull request #18 from n-WN/copilot/fix-17

Complete rewrite: Implement full LSP architecture with enhanced SageMath support

Author: n-WN

CHANGELOG.md

@@ -1,9 +1,54 @@
 # Change Log
 
-All notable changes to the "helloworld" extension will be documented in this file.
+All notable changes to the "SageMath Enhanced" extension will be documented in this file.
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
-## [Unreleased]
+## [2.0.0] - 2024-01-XX
 
-- Initial release
+### Added - Major Rewrite with LSP Implementation
+
+- **Language Server Protocol (LSP) Support**: Complete rewrite with full LSP implementation
+- **Intelligent Code Completion**: Context-aware autocompletion for SageMath functions, classes, and methods
+- **Hover Documentation**: Instant documentation and type information on hover
+- **Enhanced Syntax Highlighting**: Comprehensive syntax highlighting for SageMath-specific constructs:
+  - Ring and field declarations (ZZ, QQ, RR, CC, GF, etc.)
+  - Polynomial rings and generators
+  - Mathematical functions and operators
+  - Linear algebra operations
+  - Plotting and visualization functions
+  - Number theory and combinatorics functions
+  - Cryptographic functions
+  - Graph theory constructs
+- **Code Snippets**: 30+ pre-built code snippets for common SageMath patterns
+- **Enhanced Language Configuration**: Improved indentation, bracket matching, and auto-closing pairs
+- **Real-time Diagnostics**: Syntax validation and error detection
+- **Server Management**: Restart language server command for troubleshooting
+- **Extended Configuration**: New settings for controlling LSP features
+
+### Changed
+
+- Completely rewritten extension architecture with proper LSP client-server design
+- Enhanced TextMate grammar with comprehensive SageMath pattern recognition
+- Improved language configuration with better editor experience
+- Updated package.json with new commands and configuration options
+
+### Technical Improvements
+
+- Migrated from simple command-based extension to full LSP implementation
+- Added TypeScript language server with SageMath-specific capabilities
+- Implemented proper client-server communication via JSON-RPC
+- Enhanced build system to support both client and server compilation
+- Added comprehensive code snippets for better developer experience
+
+## [1.3.3] - Previous Version
+
+- Basic script execution functionality
+- Simple TextMate grammar inheriting from Python
+- Windows WSL support (partial)
+- Automatic .sage.py file cleanup
+
+## [1.0.0] - Initial Release
+
+- Basic SageMath file execution
+- Simple syntax highlighting

README.md

@@ -29,13 +29,27 @@ Enhance your SageMath coding experience in Visual Studio Code with the SageMath
 
 ## Features
 
-- **Run SageMath Code**: Directly execute `.sage` files from the editor with a simple click.
-- **Syntax Highlighting**: Enjoy enhanced syntax highlighting tailored for SageMath-specific operations and functions.
-- **Integrated Terminal**: Interact with SageMath directly within VS Code's integrated terminal.
-- **Automatic `.sage.py` File Cleanup**: Automatically deletes the temporary `.sage.py` file generated after running a SageMath script, keeping your workspace clean.
-- **WSL Support(Fixing)**: For Windows users, run SageMath scripts inside the Windows Subsystem for Linux (WSL) for improved compatibility and performance.
-
-![Run SageMath File Button](images/start.png) *👆🏻 the Run SageMath File button, 👇🏻 Demo video*
+- **Language Server Protocol (LSP) Support**: Complete LSP implementation providing advanced language features
+- **Intelligent Code Completion**: Context-aware autocompletion for SageMath functions, classes, and methods
+- **Hover Documentation**: Instant documentation and type information on hover
+- **Syntax Highlighting**: Comprehensive syntax highlighting for SageMath-specific constructs including:
+  - Ring and field declarations (ZZ, QQ, RR, CC, GF, etc.)
+  - Polynomial rings and generators
+  - Mathematical functions and operators
+  - Linear algebra operations
+  - Plotting and visualization functions
+  - Number theory and combinatorics functions
+  - Cryptographic functions
+  - Graph theory constructs
+- **Code Snippets**: Pre-built code snippets for common SageMath patterns
+- **Enhanced Language Configuration**: Improved indentation, bracket matching, and auto-closing pairs
+- **Script Execution**: Run SageMath files directly from the editor
+- **Automatic Cleanup**: Optional removal of generated `.sage.py` files
+- **WSL Support**: Enhanced Windows Subsystem for Linux compatibility
+- **Diagnostics**: Real-time error detection and syntax validation
+- **Server Management**: Restart language server command for troubleshooting
+
+![Run SageMath File Button](images/start.png) *The Run SageMath File button (shown above), demo video below*
 
 https://github.com/n-WN/sagemath-vscode-enhanced/assets/30841158/2a8d5cea-8c21-4886-8e18-b48893691fe4
 
@@ -59,17 +73,63 @@ Follow these steps to install the SageMath Enhanced extension:
 
 Using the SageMath Enhanced extension is simple and intuitive, providing a seamless experience for SageMath coding within VS Code.
 
+### Language Server Features
+
+The extension now includes a full Language Server Protocol implementation providing:
+
+- **Code Completion**: Press `Ctrl+Space` (or `Cmd+Space` on macOS) to trigger intelligent autocompletion
+- **Hover Information**: Hover over SageMath functions to see documentation
+- **Snippet Support**: Type snippet prefixes like `var`, `matrix`, `plot` and press Tab to expand
+- **Real-time Diagnostics**: Get immediate feedback on syntax errors
+
 ### Opening and Running SageMath Files
 
 1. **Opening a Sage File**: Open your `.sage` file in VS Code, or create a new one by selecting `File > New File` and saving it with the `.sage` extension.
-2. **Running the Code**: Once a `.sage` file is open in the editor, you'll notice a **Run SageMath File** button (▶️ icon) in the editor's title bar. Clicking this button will execute the SageMath code in the currently active `.sage` file.
+2. **Running the Code**: Once a `.sage` file is open in the editor, you'll notice a **Run SageMath File** button (play icon) in the editor's title bar. Clicking this button will execute the SageMath code in the currently active `.sage` file.
 3. **Automatic Cleanup**: If enabled in the extension settings, the temporary `.sage.py` file generated during execution will be automatically deleted after the script finishes running.
 4. **WSL Support**: If you're on Windows and have WSL installed, the extension can run SageMath scripts inside WSL for enhanced compatibility.
 
+### Language Server Management
+
+- **Restart Server**: Use the Command Palette (`Ctrl+Shift+P`) and search for "Restart SageMath Language Server" if you encounter any language server issues.
+
+### Available Code Snippets
+
+The extension includes numerous code snippets for common SageMath patterns:
+
+- `var` - Create symbolic variables
+- `matrix` - Create matrices
+- `plot` - Plot functions
+- `solve` - Solve equations
+- `factor` - Factor expressions
+- `integrate` - Compute integrals
+- `diff` - Take derivatives
+- And many more...
+
 ### Viewing Output
 
 - **Integrated Terminal**: The output from your SageMath script, along with any errors or warnings, will be displayed in VS Code's integrated terminal. This allows for easy debugging and interaction with your code.
 
+## Configuration
+
+The extension provides several configuration options to customize your SageMath development experience:
+
+### Basic Settings
+
+- `sagemathEnhanced.interpreterPath`: Path to the SageMath interpreter (default: "sage")
+- `sagemathEnhanced.autoDeleteGeneratedFile`: Automatically delete generated .sage.py files (default: false)
+- `sagemathEnhanced.useWSL`: Use Windows Subsystem for Linux (default: false)
+
+### Language Server Settings
+
+- `sagemathEnhanced.enableDiagnostics`: Enable diagnostic messages and error checking (default: true)
+- `sagemathEnhanced.enableCompletion`: Enable code completion and IntelliSense (default: true)
+- `sagemathEnhanced.enableHover`: Enable hover documentation (default: true)
+- `sagemathEnhanced.maxNumberOfProblems`: Maximum number of diagnostic problems shown (default: 100)
+- `sagemathEnhanced.logLevel`: Language server log level (default: "info")
+
+You can configure these settings in your VS Code settings (File > Preferences > Settings) by searching for "SageMath Enhanced".
+
 ## Requirements
 
 - [Visual Studio Code](https://code.visualstudio.com/) version 1.76.0 or higher.
@@ -95,13 +155,20 @@ This project is licensed under the AGPL-3.0 License - see the [LICENSE](LICENSE)
 
 ## TODO (Also Known As "Need Help")
 
-- [ ] **Code Completion**: Enhance code completion for SageMath-specific syntax.
+- [x] **Code Completion**: Enhanced code completion for SageMath-specific syntax implemented via LSP.
+- [x] **Syntax Highlighting**: Comprehensive syntax highlighting for SageMath operations and functions.
+- [x] **Error Highlighting**: Real-time diagnostic feedback on syntax errors and computational exceptions.
+- [x] **Language Server Protocol**: Full LSP implementation with hover, completion, and diagnostics.
+- [x] **Code Snippets**: Pre-built snippets for common SageMath patterns.
 - [ ] **Interactive Plots**: Enable rendering of interactive SageMath plots within VS Code.
-- [ ] **Documentation Integration**: Provide direct access to SageMath documentation via hover tooltips.
-- [ ] **Performance Optimization**: Improve startup time and responsiveness of the extension.
-- [ ] **Customizable Settings**: Introduce settings to customize the extension's behavior according to user preferences.
-- [ ] **Error Highlighting**: Provide immediate feedback on syntax errors and computational exceptions to streamline the coding process.
-- [ ] **Indentation and Autocomplete**: Currently, there might be issues with indentation shortcuts and the inability to autocomplete brackets and quotes. These advanced editing features might require the implementation or integration of a language server.
+- [ ] **Documentation Integration**: Enhanced hover tooltips with comprehensive SageMath documentation.
+- [ ] **Performance Optimization**: Further improve startup time and responsiveness of the extension.
+- [ ] **Advanced Diagnostics**: Deep integration with SageMath for semantic error checking.
+- [ ] **Refactoring Support**: Code refactoring capabilities for SageMath symbols.
+- [ ] **Debugging Support**: Step-through debugging for SageMath scripts.
+- [ ] **Notebook Integration**: Support for SageMath notebooks (.ipynb with SageMath kernel).
+
+The extension now provides a solid foundation with proper LSP architecture. Future enhancements will focus on deeper SageMath integration and advanced IDE features.
 
 <!-- For the issues with indentation and autocomplete, if they cannot be resolved through simple configuration changes, it might indeed necessitate the assistance of a more sophisticated language server (such as implementing a Language Server Protocol server specifically for SageMath) to provide advanced support similar to what Pylance does for Python. This could involve a significant development effort, including a deep understanding of SageMath syntax and features, as well as integration with VS Code's language server APIs. -->
 

README.zh.md

@@ -29,13 +29,27 @@
 
 ## 特性 
 
-- **运行SageMath代码**：只需简单点击即可直接从编辑器执行`.sage`文件。
-- **语法高亮**：享受为SageMath特定操作和函数量身定做的增强语法高亮。
-- **集成终端**：直接在VS Code的集成终端中与SageMath交互。
-- **自动`.sage.py`文件清理**：运行SageMath脚本后自动删除临时生成的`.sage.py`文件，保持您的工作空间整洁。
-- **WSL支持（修复中）**：对于Windows用户，可在Windows子系统Linux（WSL）内运行SageMath脚本，以提高兼容性和性能。
-
-![运行SageMath文件按钮](images/start.png) *👆🏻 运行 SageMath 文件按钮的屏幕截图，👇🏻 演示视频（下载或打开 Github 仓库在线观看）*
+- **语言服务器协议 (LSP) 支持**: 完整的LSP实现，提供高级语言功能
+- **智能代码补全**: 针对SageMath函数、类和方法的上下文感知自动补全
+- **悬停文档**: 悬停时即时显示文档和类型信息
+- **语法高亮**: 全面的SageMath特定构造语法高亮，包括：
+  - 环和域声明 (ZZ, QQ, RR, CC, GF等)
+  - 多项式环和生成元
+  - 数学函数和运算符
+  - 线性代数运算
+  - 绘图和可视化函数
+  - 数论和组合数学函数
+  - 密码学函数
+  - 图论构造
+- **代码片段**: 常见SageMath模式的预制代码片段
+- **增强的语言配置**: 改进的缩进、括号匹配和自动闭合配对
+- **脚本执行**: 直接从编辑器运行SageMath文件
+- **自动清理**: 可选择移除生成的`.sage.py`文件
+- **WSL支持**: 增强的Windows子系统Linux兼容性
+- **诊断**: 实时错误检测和语法验证
+- **服务器管理**: 重启语言服务器命令用于故障排除
+
+![运行SageMath文件按钮](images/start.png) *运行 SageMath 文件按钮的屏幕截图（如上图所示），演示视频如下（下载或打开 Github 仓库在线观看）*
 
 https://github.com/n-WN/sagemath-vscode-enhanced/assets/30841158/2a8d5cea-8c21-4886-8e18-b48893691fe4
 
@@ -62,7 +76,7 @@ https://github.com/n-WN/sagemath-vscode-enhanced/assets/30841158/2a8d5cea-8c21-4
 ### 打开和运行SageMath文件
 
 1. **打开Sage文件**：在VS Code中打开您的`.sage`文件，或通过选择`File > New File`并以`.sage`扩展名保存来创建一个新文件。
-2. **运行代码**：一旦`.sage`文件在编辑器中打开，您会在编辑器标题栏中注意到一个**Run SageMath File**按钮（▶️图标）。点击此按钮将执行当前活动的`.sage`文件中的SageMath代码。
+2. **运行代码**：一旦`.sage`文件在编辑器中打开，您会在编辑器标题栏中注意到一个**Run SageMath File**按钮（播放图标）。点击此按钮将执行当前活动的`.sage`文件中的SageMath代码。
 3. **自动清理**：如果在扩展设置中启用，执行期间生成的临时`.sage.py`文件将在脚本运行结束后自动删除。
 4. **WSL支持**：如果您使用的是Windows并安装了WSL，该扩展可以在WSL中运行SageMath脚本以增强兼容性。
 
@@ -97,14 +111,22 @@ https://github.com/n-WN/sagemath-vscode-enhanced/assets/30841158/2a8d5cea-8c21-4
 
 ## 待办事项（又名"需要帮助"）
 
-- [ ] **代码补全**：增强SageMath特定语法的代码补全功能。
+- [x] **代码补全**：通过LSP实现了SageMath特定语法的增强代码补全功能。
+- [x] **语法高亮**：全面的SageMath操作和函数语法高亮。
+- [x] **错误高亮**：实时诊断反馈，提供语法错误和计算异常的即时反馈。
+- [x] **语言服务器协议**：完整的LSP实现，包含悬停、补全和诊断功能。
+- [x] **代码片段**：常见SageMath模式的预制片段。
 - [ ] **交互式绘图**：在VS Code内启用交互式SageMath绘图的渲染。
-- [ ] **文档集成**：通过悬停提示直接提供对SageMath文档的访问。
-- [ ] **性能优化**：改善扩展的启动时间和响应速度。
-- [ ] **自定义设置**：引入设置以根据用户偏好自定义扩展的行为。
-- [ ] **错误高亮**：为语法错误和计算异常提供即时反馈，以简化编码过程。
+- [ ] **文档集成**：通过增强的悬停提示提供全面的SageMath文档访问。
+- [ ] **性能优化**：进一步改善扩展的启动时间和响应速度。
+- [ ] **高级诊断**：与SageMath深度集成进行语义错误检查。
+- [ ] **重构支持**：SageMath符号的代码重构功能。
+- [ ] **调试支持**：SageMath脚本的逐步调试。
+- [ ] **笔记本集成**：支持SageMath笔记本(.ipynb with SageMath kernel)。
+
+扩展现在提供了具有适当LSP架构的坚实基础。未来的增强将专注于更深入的SageMath集成和高级IDE功能。
 - [ ] **缩进和自动补全**：当前，可能存在缩进快捷键问题，以及无法自动补全括号和引号。这些高级编辑功能可能需要实现或集成语言服务器支持。
 
 ## 致谢
 
-- 特别感谢[SageMath](http://www.sagemath.org/)社区提供的宝贵资源和支持。
+- 特别感谢[SageMath](http://www.sagemath.org/)社区提供的宝贵资源和支持。��资源和支持。

language-configuration.json

@@ -0,0 +1,41 @@
+{
+    "comments": {
+        "lineComment": "#",
+        "blockComment": ["'''", "'''"]
+    },
+    "brackets": [
+        ["{", "}"],
+        ["[", "]"],
+        ["(", ")"],
+        ["<", ">"]
+    ],
+    "autoClosingPairs": [
+        { "open": "{", "close": "}" },
+        { "open": "[", "close": "]" },
+        { "open": "(", "close": ")" },
+        { "open": "<", "close": ">", "notIn": ["string", "comment"] },
+        { "open": "'", "close": "'", "notIn": ["string", "comment"] },
+        { "open": "\"", "close": "\"", "notIn": ["string", "comment"] },
+        { "open": "'''", "close": "'''", "notIn": ["string"] },
+        { "open": "\"\"\"", "close": "\"\"\"", "notIn": ["string"] }
+    ],
+    "surroundingPairs": [
+        ["'", "'"],
+        ["\"", "\""],
+        ["[", "]"],
+        ["(", ")"],
+        ["{", "}"],
+        ["<", ">"]
+    ],
+    "folding": {
+        "markers": {
+            "start": "^\\s*#\\s*region\\b",
+            "end": "^\\s*#\\s*endregion\\b"
+        }
+    },
+    "wordPattern": "(-?\\d*\\.\\d\\w*)|([^\\`\\~\\!\\@\\#\\%\\^\\&\\*\\(\\)\\-\\=\\+\\[\\{\\]\\}\\\\\\|\\;\\:\\'\\\"\\,\\.\\<\\>\\/\\?\\s]+)",
+    "indentationRules": {
+        "increaseIndentPattern": "^\\s*(class|def|if|elif|else|for|while|try|except|finally|with)\\b.*:.*$",
+        "decreaseIndentPattern": "^\\s*(elif|else|except|finally)\\b.*:.*$"
+    }
+}