From 1cd32461a7a704dacdf3aaed521f66cd2ac3afc9 Mon Sep 17 00:00:00 2001 From: Yannik Schmidt Date: Mon, 12 Aug 2024 17:10:28 +0200 Subject: [PATCH] Add base-ide plugin documentation --- images/base-ide/README.md | 101 +++++++++++++++++++++++++++++++++++ images/base-ide/package.json | 6 +-- 2 files changed, 103 insertions(+), 4 deletions(-) create mode 100644 images/base-ide/README.md diff --git a/images/base-ide/README.md b/images/base-ide/README.md new file mode 100644 index 000000000..f79037112 --- /dev/null +++ b/images/base-ide/README.md @@ -0,0 +1,101 @@ +# Artemis Theia Base-IDE +The Basis IDE serves as the foundational image within our Theia-based IDE ecosystem. It is designed to provide a minimal and lightweight development environment, forming the core upon which more specialized IDE images are built. The Basis IDE includes the essential features and plugins necessary for basic development tasks, allowing users to extend its functionality with additional plugins as needed. Simplicity and being lightweight is key here. + +For more information on the overall structure, including details on the available Theia IDE images, please refer to the main [Artemis Theia IDE Images README](../README.md). + +## Plugins shipped with the Base-IDE +The Basis IDE includes a limited set of plugins to maintain its lightweight nature. As recommended by the creators of Theia, the plugins are sourced from their `builtin-extension-pack` available [here](https://open-vsx.org/extension/eclipse-theia/builtin-extension-pack). + +The following list shows all sub-plugins/folders shipped with it and whether they are included in this base image. + +| Package Name | Description | Included | +|----------------------------------------------|----------|:--------:| +| eclipse-theia.builtin-extension-pack | Builtin extension pack associated to a version of vscode | ✔️ | +| ms-vscode.js-debug | An extension for debugging Node.js programs and Chrome. | | +| ms-vscode.js-debug-companion | Companion extension to js-debug that provides capability for remote debugging | | +| vscode.bat | Provides snippets, syntax highlighting, bracket matching and folding in Windows batch files. | | +| vscode.builtin-notebook-renderers | Provides basic output renderers for notebooks | | +| vscode.clojure | Provides syntax highlighting and bracket matching in Clojure files. | | +| vscode.coffeescript | Provides snippets, syntax highlighting, bracket matching and folding in CoffeeScript files. | | +| vscode.configuration-editing | Provides capabilities (advanced IntelliSense, auto-fixing) in configuration files like settings, launch, and extension recommendation files. | | +| vscode.cpp | Provides snippets, syntax highlighting, bracket matching and folding in C/C++ files. | | +| vscode.csharp | Provides snippets, syntax highlighting, bracket matching and folding in C# files. | | +| vscode.css | Provides syntax highlighting and bracket matching for CSS, LESS and SCSS files. | | +| vscode.css-language-features | Provides rich language support for CSS, LESS and SCSS files. | | +| vscode.dart | Provides syntax highlighting & bracket matching in Dart files. | | +| vscode.debug-auto-launch | Helper for auto-attach feature when node-debug extensions are not active. | | +| vscode.debug-server-ready | Open URI in browser if server under debugging is ready. | | +| vscode.diff | Provides syntax highlighting & bracket matching in Diff files. | ✔️ | +| vscode.docker | Provides syntax highlighting and bracket matching in Docker files. | | +| vscode.emmet | Emmet support for VS Code | | +| vscode.extension-editing | Provides linting capabilities for authoring extensions. | | +| vscode.fsharp | Provides snippets, syntax highlighting, bracket matching and folding in F# files. | | +| vscode.git | Git SCM Integration | ✔️ | +| vscode.git-base | Git static contributions and pickers. | ✔️ | +| vscode.github | GitHub features for VS Code | | +| vscode.github-authentication | GitHub Authentication Provider | | +| vscode.go | Provides syntax highlighting and bracket matching in Go files. | | +| vscode.groovy | Provides snippets, syntax highlighting and bracket matching in Groovy files. | | +| vscode.grunt | Extension to add Grunt capabilities to VS Code. | | +| vscode.gulp | Extension to add Gulp capabilities to VSCode. | | +| vscode.handlebars | Provides syntax highlighting and bracket matching in Handlebars files. | | +| vscode.hlsl | Provides syntax highlighting and bracket matching in HLSL files. | | +| vscode.html | Provides syntax highlighting, bracket matching & snippets in HTML files. | | +| vscode.html-language-features | Provides rich language support for HTML and Handlebar files | | +| vscode.ini | Provides syntax highlighting and bracket matching in Ini files. | | +| vscode.ipynb | Provides basic support for opening and reading Jupyter's .ipynb notebook files | | +| vscode.jake | Extension to add Jake capabilities to VS Code. | | +| vscode.java | Provides snippets, syntax highlighting, bracket matching and folding in Java files. | | +| vscode.javascript | Provides snippets, syntax highlighting, bracket matching and folding in JavaScript files. | | +| vscode.json | Provides syntax highlighting & bracket matching in JSON files. | ✔️ | +| vscode.json-language-features | Provides rich language support for JSON files. | ✔️ | +| vscode.julia | Provides syntax highlighting & bracket matching in Julia files. | | +| vscode.less | Provides syntax highlighting, bracket matching and folding in Less files. | | +| vscode.log | Provides syntax highlighting for files with .log extension. | ✔️ | +| vscode.lua | Provides syntax highlighting and bracket matching in Lua files. | | +| vscode.make | Provides syntax highlighting and bracket matching in Make files. | | +| vscode.markdown | Provides snippets and syntax highlighting for Markdown. | ✔️ | +| vscode.markdown-language-features | Provides rich language support for Markdown. | ✔️ | +| vscode.markdown-math | Adds math support to Markdown in notebooks. | | +| vscode.media-preview | Provides VS Code's built-in previews for images, audio, and video | ✔️ | +| vscode.merge-conflict | Highlighting and commands for inline merge conflicts. | ✔️ | +| vscode.npm | Extension to add task support for npm scripts. | | +| vscode.objective-c | Provides syntax highlighting and bracket matching in Objective-C files. | | +| vscode.perl | Provides syntax highlighting and bracket matching in Perl files. | | +| vscode.php | Provides syntax highlighting and bracket matching for PHP files. | | +| vscode.php-language-features | Provides rich language support for PHP files. | | +| vscode.powershell | Provides snippets, syntax highlighting, bracket matching and folding in Powershell files. | | +| vscode.pug | Provides syntax highlighting and bracket matching in Pug files. | | +| vscode.python | Provides syntax highlighting, bracket matching and folding in Python files. | | +| vscode.r | Provides syntax highlighting and bracket matching in R files. | | +| vscode.references-view | Reference Search results as separate, stable view in the sidebar | ✔️ | +| vscode.restructuredtext | Provides syntax highlighting in reStructuredText files. | | +| vscode.ruby | Provides syntax highlighting and bracket matching in Ruby files. | | +| vscode.rust | Provides syntax highlighting and bracket matching in Rust files. | | +| vscode.scss | Provides syntax highlighting, bracket matching and folding in SCSS files. | | +| vscode.search-result | Provides syntax highlighting and language features for tabbed search results. | ✔️ | +| vscode.shaderlab | Provides syntax highlighting and bracket matching in Shaderlab files. | | +| vscode.shellscript | Provides syntax highlighting and bracket matching in Shell Script files. | | +| vscode.simple-browser | A very basic built-in webview for displaying web content. | | +| vscode.sql | Provides syntax highlighting and bracket matching in SQL files. | | +| vscode.swift | Provides snippets, syntax highlighting and bracket matching in Swift files. | | +| vscode.theme-abyss | Abyss theme for Visual Studio Code | | +| vscode.theme-defaults | The default Visual Studio light and dark themes | | +| vscode.theme-kimbie-dark | Kimbie dark theme for Visual Studio Code | | +| vscode.theme-monokai | Monokai theme for Visual Studio Code | | +| vscode.theme-monokai-dimmed | Monokai dimmed theme for Visual Studio Code | | +| vscode.theme-quietlight | Quiet light theme for Visual Studio Code | | +| vscode.theme-red | Red theme for Visual Studio Code | | +| vscode.theme-solarized-dark | Solarized dark theme for Visual Studio Code | | +| vscode.theme-solarized-light | Solarized light theme for Visual Studio Code | | +| vscode.theme-tomorrow-night-blue | Tomorrow night blue theme for Visual Studio Code | | +| vscode.tunnel-forwarding | Allows forwarding local ports to be accessible over the internet. | | +| vscode.typescript | Provides snippets, syntax highlighting, bracket matching and folding in TypeScript files. | | +| vscode.typescript-language-features | Provides rich language support for JavaScript and TypeScript. | | +| vscode.vb | Provides snippets, syntax highlighting, bracket matching and folding in Visual Basic files. | | +| vscode.vscode-theme-seti | A file icon theme made out of the Seti UI file icons | | +| vscode.xml | Provides syntax highlighting and bracket matching in XML files. | ✔️ | +| vscode.yaml | Provides syntax highlighting and bracket matching in YAML files. | ✔️ | + + +Moreover, the Artemis plugin for Theia `Scorpio` is automatically bundled with the base image. This allows users seamless integration with their exercises. diff --git a/images/base-ide/package.json b/images/base-ide/package.json index dc7ce38e4..64fce164f 100644 --- a/images/base-ide/package.json +++ b/images/base-ide/package.json @@ -104,6 +104,7 @@ "vscode.less", "vscode.lua", "vscode.make", + "vscode.markdown-math", "vscode.npm", "vscode.objective-c", "vscode.perl", @@ -114,7 +115,6 @@ "vscode.python", "vscode.r", "vscode.razor", - "vscode.references-view", "vscode.restructuredtext", "vscode.ruby", "vscode.rust", @@ -139,9 +139,7 @@ "vscode.typescript", "vscode.typescript-language-features", "vscode.vb", - "vscode.vscode-theme-seti", - "vscode.xml", - "vscode.yaml" + "vscode.vscode-theme-seti" ], "workspaces": [ "applications/*",