Merge branch dev into published

Author: PEZ

CHANGELOG.md

@@ -4,6 +4,10 @@ Changes to Calva.
 
 ## [Unreleased]
 
+## [2.0.520] - 2025-06-28
+
+- [Add option for opening flares in side panel view](https://github.com/BetterThanTomorrow/calva/issues/2873)
+
 ## [2.0.519] - 2025-06-09
 
 - [Support `before` and `after` functions for refresh namespaces commands](https://github.com/BetterThanTomorrow/calva/issues/2862)

README.md

@@ -248,9 +248,11 @@ Calva is an open source project with surprisingly many code contributors. We tak
 
 ## Telemetry
 
-If the setting `telemetry.telemetryLevel` is set to `"all"`, Calva will collect some telemetry. It is basically some key events, like that Calva is started, a repl connected, something is evaluated. Currently it is 10 events.
+By default Calva collects some usage info. There are no cookies or anything like that involved. It is a randomly generated identifier per Calva install that is sent along some key events, like that Calva is started, a repl connected, something is evaluated. Currently it is 10 events.
 For an up-to-date, and full, list of events, see: https://github.com/BetterThanTomorrow/calva/blob/published/src/analytics.ts and the calls to that module.
 
+To opt out of this, disable `calva.telemetryEnabled` in settings. For Calva telemetry to be logged, aLso the VS Code setting `telemetry.telemetryLevel` need to be set to `"all"`. 
+
 ## Happy Coding
 
 We hope you will find good use for Calva. Please let us know what you think. PRs welcome, file an issue or chat us up in the [#calva](https://clojurians.slack.com/messages/calva/) channel in the Clojurians Slack.

docs/site/flares.md

@@ -41,6 +41,24 @@ To show a webpage, pass a `:url` instead of `:html` in the request:
 The `:key` parameter is optional and can be used to reuse the same WebView panel.
 If omitted, a new WebView panel will be created per request.
 
+## Sidebar vs Panel Display
+
+By default, flares open in a separate WebView panel alongside your code.
+You can also display flares in the Calva sidebar using the `:sidebar-panel?` option:
+
+```clojure
+;; Display in a separate panel (default)
+(tagged-literal 'flare/html {:html "<h1>Hello, Panel!</h1>",
+                             :title "Panel Display"})
+
+;; Display in the Calva sidebar
+(tagged-literal 'flare/html {:html "<h1>Hello, Sidebar!</h1>",
+                             :title "Sidebar Display"
+                             :sidebar-panel? true})
+```
+
+The sidebar Flare view is located in the Calva activity bar section.
+
 ## Try a more interesting example
 
 Let's create an SVG containing circles of varying radii and colors:
@@ -102,6 +120,7 @@ so you can do anything you can do in a browser, there's really no limit.
 | `:reveal` | boolean | true | If true, reveals the panel if it is not visible. |
 | `:column` | integer | vscode.ViewColumn.Beside | See [ViewColumn](https://code.visualstudio.com/api/references/vscode-api#ViewColumn) |
 | `:opts` | map | {:enableScripts true} | See [WebviewOptions](https://code.visualstudio.com/api/references/vscode-api#WebviewOptions) |
+| `:sidebar-panel` | boolean | false | If true, displays the content in the sidebar Flare view instead of a separate panel. |
 
 ### Suggestions welcome
 

package-lock.json

@@ -3,7 +3,7 @@
   "displayName": "Calva: Clojure & ClojureScript Interactive Programming",
   "description": "Integrated REPL, formatter, Paredit, and more. Powered by cider-nrepl and clojure-lsp.",
   "icon": "assets/calva.png",
-  "version": "2.0.519",
+  "version": "2.0.520",
   "publisher": "betterthantomorrow",
   "author": {
     "name": "Better Than Tomorrow",
@@ -890,6 +890,11 @@
             "markdownDescription": "Show the Calva Says output panel on start?",
             "default": false
           },
+          "calva.telemetryEnabled": {
+            "type": "boolean",
+            "default": true,
+            "description": "Enable or disable Calva usage telemetry. No user data is sent."
+          },
           "calva.definitionProviderPriority": {
             "markdownDescription": "Calva can provide definitions using both the REPL connection and via clojure-lsp. Which provider should Calva prioritize when both are available?",
             "enum": [
@@ -3312,7 +3317,14 @@
       "calva": [
         {
           "id": "calva.inspector",
-          "name": "Inspector"
+          "name": "Inspector",
+          "icon": "assets/images/calva-symbol-white.svg"
+        },
+        {
+          "id": "calva.flare",
+          "name": "Flare",
+          "type": "webview",
+          "icon": "assets/images/calva-symbol-white.svg"
         }
       ]
     },

package.json

@@ -4,8 +4,14 @@ import * as uuid from 'uuidv4';
 import { isUndefined } from 'lodash';
 
 function userAllowsTelemetry(): boolean {
+  const calvaConfig = vscode.workspace.getConfiguration('calva');
+  const calvaTelemetryEnabled = calvaConfig.get<boolean>('telemetryEnabled', true);
   const config = vscode.workspace.getConfiguration('telemetry');
-  return config.get<string>('telemetryLevel', 'off') === 'all';
+  const level = config.get<string>('telemetryLevel');
+  if (level !== undefined) {
+    return level === 'all' && calvaTelemetryEnabled;
+  }
+  return calvaTelemetryEnabled;
 }
 
 export default class Analytics {

src/analytics.ts

@@ -48,6 +48,7 @@ import { capitalize } from './utilities';
 import * as overrides from './overrides';
 import * as lsp from './lsp';
 import * as fiddleFiles from './fiddle-files';
+import * as flareHandler from './flare-handler';
 import * as output from './results-output/output';
 import * as inspector from './providers/inspector';
 
@@ -100,6 +101,9 @@ async function activate(context: vscode.ExtensionContext) {
   inspectorDataProvider.treeView = inspectorTreeView;
   vscode.window.registerFileDecorationProvider(new inspector.InspectorItemDecorationProvider());
 
+  // Initialize flare webview provider for sidebar
+  flareHandler.registerFlareWebviewProvider(context);
+
   overrides.activate();
 
   if (isDramStart) {

src/extension.ts

@@ -11,6 +11,7 @@ type WebviewRequest = {
   column?: vscode.ViewColumn;
   opts?: any;
   then?: string;
+  'sidebar-panel?'?: boolean;
 };
 
 type ActRequest = WebviewRequest;
@@ -57,9 +58,113 @@ interface CalvaWebPanel extends vscode.WebviewPanel {
   url?: string;
 }
 
+interface CalvaWebView extends vscode.WebviewView {
+  url?: string;
+}
+
 // keep track of open webviews that have a key
 // so that they can be updated in the future
 const calvaWebPanels: Record<string, CalvaWebPanel> = {};
+const calvaSidebarWebViews: Record<string, CalvaWebView> = {};
+
+// WebView provider for sidebar
+class CalvaFlareWebviewProvider implements vscode.WebviewViewProvider {
+  public static readonly viewType = 'calva.flare';
+  private _view?: vscode.WebviewView;
+  private _context: vscode.ExtensionContext;
+  private _lastContent?: {
+    html: string;
+    title?: string;
+    key?: string;
+  };
+
+  constructor(private readonly context: vscode.ExtensionContext) {
+    this._context = context;
+  }
+
+  public resolveWebviewView(
+    webviewView: vscode.WebviewView,
+    context: vscode.WebviewViewResolveContext,
+    _token: vscode.CancellationToken
+  ) {
+    this._view = webviewView;
+
+    webviewView.webview.options = {
+      enableScripts: true,
+      localResourceRoots: [this._context.extensionUri],
+    };
+
+    if (this._lastContent) {
+      webviewView.webview.html = this._lastContent.html;
+      if (this._lastContent.title) {
+        webviewView.title = this._lastContent.title;
+      }
+      if (this._lastContent.key) {
+        (webviewView as CalvaWebView).url = this._lastContent.key;
+        calvaSidebarWebViews[this._lastContent.key] = webviewView as CalvaWebView;
+      }
+    } else {
+      webviewView.webview.html = this._getHtmlForWebview(webviewView.webview);
+    }
+  }
+
+  public updateContent(html: string, title?: string, key?: string) {
+    this._lastContent = { html, title, key };
+
+    if (this._view) {
+      this._view.webview.html = html;
+      if (title) {
+        this._view.title = title;
+      }
+      if (key) {
+        (this._view as CalvaWebView).url = key; // Store key in url field for tracking
+        calvaSidebarWebViews[key] = this._view as CalvaWebView;
+      }
+    }
+  }
+
+  public updateUrl(url: string, title?: string, key?: string) {
+    const iframeHtml = urlInIframe(url);
+    this._lastContent = { html: iframeHtml, title, key };
+
+    if (this._view) {
+      this._view.webview.html = iframeHtml;
+      if (title) {
+        this._view.title = title;
+      }
+      if (key) {
+        (this._view as CalvaWebView).url = url;
+        calvaSidebarWebViews[key] = this._view as CalvaWebView;
+      }
+    }
+  }
+
+  private _getHtmlForWebview(webview: vscode.Webview) {
+    return `<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Calva Flare</title>
+</head>
+<body>
+    <p>Flare content will appear here</p>
+</body>
+</html>`;
+  }
+}
+
+let flareWebviewProvider: CalvaFlareWebviewProvider | null = null;
+
+export function registerFlareWebviewProvider(context: vscode.ExtensionContext) {
+  flareWebviewProvider = new CalvaFlareWebviewProvider(context);
+  context.subscriptions.push(
+    vscode.window.registerWebviewViewProvider(
+      CalvaFlareWebviewProvider.viewType,
+      flareWebviewProvider
+    )
+  );
+}
 
 function showWebView({
   title = 'WebView',
@@ -70,6 +175,7 @@ function showWebView({
   reveal = true,
   column = vscode.ViewColumn.Beside,
   opts = defaultWebviewOptions,
+  'sidebar-panel?': sidebarPanel = false,
 }: {
   title?: string;
   key?: string;
@@ -79,7 +185,28 @@ function showWebView({
   reveal?: boolean;
   column?: vscode.ViewColumn;
   opts?: typeof defaultWebviewOptions;
+  'sidebar-panel?'?: boolean;
 }): void {
+  if (sidebarPanel) {
+    if (flareWebviewProvider) {
+      if (html) {
+        flareWebviewProvider.updateContent(html, title, key);
+      } else if (url) {
+        flareWebviewProvider.updateUrl(url, title, key);
+      }
+
+      if (reveal) {
+        // Focus the Calva view container to show the sidebar
+        void vscode.commands.executeCommand('calva.flare.focus');
+      }
+    } else {
+      void vscode.window.showErrorMessage(
+        'Sidebar flare webview not available. Please restart VS Code.'
+      );
+    }
+    return;
+  }
+
   let panel: CalvaWebPanel;
   if (key) {
     panel = calvaWebPanels[key];