robotframework-testdoc 0.6.2__tar.gz → 0.6.3a2__tar.gz

{robotframework_testdoc-0.6.2 → robotframework_testdoc-0.6.3a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.6.2
+Version: 0.6.3a2
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
 Project-URL: Repository, https://github.com/MarvKler/robotframework-testdoc
 Project-URL: Issues, https://github.com/MarvKler/robotframework-testdoc/issues
@@ -47,6 +47,17 @@ Visit the project at [GitHub - robotframework-testdoc](https://github.com/MarvKl
 
 Visit the official documentation for more details: [Documentation - robotframework-testdoc](https://marvkler.github.io/robotframework-testdoc/)
 
+## VS Code Extension
+
+Generate test documentation directly from the VS Code Explorer — no terminal required.  
+Download the latest `.vsix` from [GitHub Releases](https://github.com/MarvKler/robotframework-testdoc/releases) and install it locally.
+
+```bash
+code --install-extension testdoc-vscode-<version>.vsix
+```
+
+See the [VS Code Extension documentation](https://marvkler.github.io/robotframework-testdoc/usage/vscode-extension/) for details.
+
 ## Statistics
 
 [![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)  
@@ -81,6 +92,20 @@ testdoc [OPTIONS] suite_directory output.html
 > [!TIP]
 > **Included Help:** Visit the [CLI Documentation](https://marvkler.github.io/robotframework-testdoc/cli/cli/) for further arguments & details.
 
+### Output Formats
+
+By default testdoc generates an HTML file. Use `-f` / `--output-format` to choose a different format:
+
+```shell
+# HTML (default)
+testdoc tests/ TestDocumentation.html
+
+# JSON — machine-readable suite tree
+testdoc -f json tests/ TestDocumentation.json
+```
+
+Available values: `html` (default), `json`.
+
 ### Plugin Usage
 
 You can use the testdoc tool also as plugin integration.  

{robotframework_testdoc-0.6.2 → robotframework_testdoc-0.6.3a2}/README.md

@@ -10,6 +10,17 @@ Visit the project at [GitHub - robotframework-testdoc](https://github.com/MarvKl
 
 Visit the official documentation for more details: [Documentation - robotframework-testdoc](https://marvkler.github.io/robotframework-testdoc/)
 
+## VS Code Extension
+
+Generate test documentation directly from the VS Code Explorer — no terminal required.  
+Download the latest `.vsix` from [GitHub Releases](https://github.com/MarvKler/robotframework-testdoc/releases) and install it locally.
+
+```bash
+code --install-extension testdoc-vscode-<version>.vsix
+```
+
+See the [VS Code Extension documentation](https://marvkler.github.io/robotframework-testdoc/usage/vscode-extension/) for details.
+
 ## Statistics
 
 [![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)  
@@ -44,6 +55,20 @@ testdoc [OPTIONS] suite_directory output.html
 > [!TIP]
 > **Included Help:** Visit the [CLI Documentation](https://marvkler.github.io/robotframework-testdoc/cli/cli/) for further arguments & details.
 
+### Output Formats
+
+By default testdoc generates an HTML file. Use `-f` / `--output-format` to choose a different format:
+
+```shell
+# HTML (default)
+testdoc tests/ TestDocumentation.html
+
+# JSON — machine-readable suite tree
+testdoc -f json tests/ TestDocumentation.json
+```
+
+Available values: `html` (default), `json`.
+
 ### Plugin Usage
 
 You can use the testdoc tool also as plugin integration.  

{robotframework_testdoc-0.6.2 → robotframework_testdoc-0.6.3a2}/src/testdoc/html/templates/jinja_html_default/jinja_template.html

@@ -53,6 +53,16 @@
             <span class="topbar-stat-label">Tests</span>
         </div>
         {% endif %}
+        {% if suite %}
+        <button class="dashboard-toggle" id="dashboardToggle" aria-label="Statistics Dashboard" title="Statistics Dashboard">
+            <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" aria-hidden="true">
+                <rect x="2" y="12" width="4" height="9" rx="1"/>
+                <rect x="9" y="7" width="4" height="14" rx="1"/>
+                <rect x="16" y="3" width="4" height="18" rx="1"/>
+            </svg>
+            <span>Statistics</span>
+        </button>
+        {% endif %}
         <button class="theme-toggle" id="themeToggle" aria-label="Toggle theme">
             <svg class="icon-sun" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" aria-hidden="true">
                 <circle cx="12" cy="12" r="5"/>
@@ -129,6 +139,15 @@
                 {% endif %}
             </ul>
         </div>
+        <!-- TAG FILTER PANEL -->
+        <div class="tag-filter-panel" id="tagFilterPanel">
+            <div class="tag-filter-header">
+                <span class="tag-filter-title">Filter by Tag</span>
+                <button class="tag-filter-clear-btn" id="tagFilterClear">Clear all</button>
+            </div>
+            <div class="tag-filter-tags" id="tagFilterList"></div>
+            <div class="tag-filter-status" id="tagFilterStatus"></div>
+        </div>
     </aside>
 
     <!-- MAIN CONTENT -->
@@ -153,7 +172,7 @@
         {% endmacro %}
 
         {% macro render_suite_block(s, level) %}
-        <section class="suite-block" data-suite-id="{{ s.id }}">
+        <section class="suite-block" data-suite-id="{{ s.id }}" data-suite-name="{{ s.name }}" data-suite-depth="{{ level }}" data-test-count="{{ s.test_count }}">
 
             <!-- Per-suite sticky header -->
             <header class="content-header" id="suite-{{ s.id }}">
@@ -216,6 +235,43 @@
                 </section>
                 {% endif %}
 
+                <!-- Suite Setup / Teardown -->
+                {% if s.setup or s.teardown %}
+                <section class="section suite-fixture-block" data-suite-id="{{ s.id }}">
+                    <div class="section-header">
+                        <span class="section-title">Suite Setup &amp; Teardown</span>
+                        <span class="section-subtitle">Lifecycle keywords for this suite</span>
+                    </div>
+                    <script type="application/x-ndjson" class="kw-doc-ndjson" data-test-target="suite-fixture-{{ s.id }}">
+{% if s.setup and s.setup.keyword_doc %}
+{{ {'name': s.setup.name, 'owner': s.setup.keyword_owner, 'doc': s.setup.keyword_doc, 'args': s.setup.args, 'fixture': 'setup'} | dump_json }}
+{% endif %}
+{% if s.teardown and s.teardown.keyword_doc %}
+{{ {'name': s.teardown.name, 'owner': s.teardown.keyword_owner, 'doc': s.teardown.keyword_doc, 'args': s.teardown.args, 'fixture': 'teardown'} | dump_json }}
+{% endif %}
+                    </script>
+                    <div class="code-wrapper">
+                        <button class="code-toggle">
+                            <span>Show / Hide Code</span>
+                            <span class="code-toggle-icon" aria-hidden="true">
+                                <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"/></svg>
+                            </span>
+                        </button>
+                        <div class="code-toggle-body">
+                        {% set setup_line = [s.setup] | format_test_body | join('') if s.setup else '' %}
+                        {% set teardown_line = [s.teardown] | format_test_body | join('') if s.teardown else '' %}
+                        {% set code -%}
+*** Settings ***
+{% if s.setup %}Suite Setup    {{ setup_line }}
+{% endif %}{% if s.teardown %}Suite Teardown    {{ teardown_line }}
+{% endif %}
+                        {%- endset %}
+                        {{ code | highlight_robot_in_pre | safe }}
+                        </div>
+                    </div>
+                </section>
+                {% endif %}
+
                 <!-- Metadata -->
                 {% if s.metadata %}
                 <section class="section">
@@ -285,7 +341,9 @@
                     </div>
                     <div class="tests-list">
                         {% for test in s.tests %}
-                        <section id="test-{{ s.id }}-{{ loop.index0 }}" class="test-block collapsed">
+                        {%- set _test_tags = [] -%}
+                        {%- for _t in (test.tags or []) -%}{%- if _test_tags.append((_t.name if _t is mapping else _t) | string) -%}{%- endif -%}{%- endfor -%}
+                        <section id="test-{{ s.id }}-{{ loop.index0 }}" class="test-block collapsed" data-tags="{{ _test_tags | dump_json | e }}" data-has-doc="{{ '1' if test.doc else '0' }}">
                             <div class="test-header">
                                 <div class="test-name">{{ test.name }}</div>
                                 <span class="test-collapse-icon" aria-hidden="true">
@@ -412,6 +470,10 @@
         {% endfor %}
         {% endmacro %}
 
+        <!-- Statistics Dashboard (hidden by default, built by JS) -->
+        <div id="dashboardPanel" class="dashboard-panel" style="display:none" role="region" aria-label="Statistics Dashboard"></div>
+
+        <div id="suiteContent">
         {% if suites %}
             {{ render_suite_block(suites, 0) }}
         {% else %}
@@ -428,6 +490,7 @@
             <span class="content-footer-sep">·</span>
             <a href="https://github.com/MarvKler/robotframework-testdoc" target="_blank" rel="noopener noreferrer">Contribute on GitHub</a>
         </footer>
+        </div>{# /suiteContent #}
     </main>
 </div>
 

robotframework_testdoc-0.6.3a2/vscode-extension/README.md

@@ -0,0 +1,68 @@
+# testdoc – VS Code Extension
+
+Generate Robot Framework test documentation directly from the VS Code Explorer — no terminal required.
+
+## Requirements
+
+- **VS Code** `^1.85.0`
+- **Python extension** (`ms-python.python`) installed and configured
+- **robotframework-testdoc** installed in your active Python environment:
+  ```bash
+  pip install robotframework-testdoc
+  ```
+
+## Installation
+
+This extension is not published on the VS Code Marketplace.  
+Download the latest `.vsix` file from the [GitHub Releases](https://github.com/MarvKler/robotframework-testdoc/releases) page and install it locally.
+
+**Option A – VS Code UI:**
+1. Open the Extensions view (`Ctrl+Shift+X` / `Cmd+Shift+X`)
+2. Click the `...` menu → **Install from VSIX...**
+3. Select the downloaded `.vsix` file
+
+**Option B – Terminal:**
+```bash
+code --install-extension testdoc-vscode-<version>.vsix
+```
+
+## Usage
+
+Right-click any folder in the Explorer and choose one of the three commands:
+
+| Command | Description |
+|---|---|
+| **testdoc: Generate HTML Documentation** | Generates a self-contained `.html` test documentation file |
+| **testdoc: Generate JSON Documentation** | Generates a machine-readable `.json` suite tree |
+| **testdoc: Generate MkDocs Output** | Generates a full MkDocs project into a selected output directory |
+
+### HTML / JSON
+
+1. Right-click a folder containing your `.robot` files
+2. Select **testdoc: Generate HTML Documentation** or **testdoc: Generate JSON Documentation**
+3. A save dialog opens — choose the output file location and name
+4. A terminal runs `testdoc` and the file is written to the chosen location
+
+### MkDocs
+
+1. Right-click a folder containing your `.robot` files
+2. Select **testdoc: Generate MkDocs Output**
+3. A folder picker opens — select an **empty or new** output directory
+4. A terminal runs `testdoc --mkdocs` and the MkDocs project is written to the selected directory
+
+> The extension automatically uses the Python interpreter configured for the workspace via the **Python extension**.  
+> Make sure `robotframework-testdoc` is installed in that interpreter.
+
+## Troubleshooting
+
+**`python: command not found` / `testdoc: No module named testdoc`**  
+→ Select the correct Python interpreter via `Ctrl+Shift+P` → **Python: Select Interpreter** and ensure `robotframework-testdoc` is installed there.
+
+**The context menu commands do not appear**  
+→ Right-click must be on a **folder**, not a file.
+
+## Related Links
+
+- [robotframework-testdoc on PyPI](https://pypi.org/project/robotframework-testdoc)
+- [Official Documentation](https://marvkler.github.io/robotframework-testdoc/)
+- [GitHub Repository](https://github.com/MarvKler/robotframework-testdoc)