fix: Scalar parameter docstring and example arguments unused

.github/workflows/pr.yml

@@ -41,3 +41,11 @@ jobs:
       - name: integration tests
         working-directory: package
         run: yarn test:integration
+
+      # https://playwright.dev/docs/ci-intro#html-report
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: playwright-report
+          path: package/playwright-report/
+          retention-days: 30

README.md

@@ -85,6 +85,10 @@ Every PR should come with a test that checks it.
 
 ## Changelog
 
+### 12.0.10
+
+-   fix: Parameter docstrings not shown
+
 ### 12.0.9
 
 -   fix: decrease bundle size.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kusto/monaco-kusto",
-    "version": "12.0.9",
+    "version": "12.0.10",
     "description": "CSL, KQL plugin for the Monaco Editor",
     "author": {
         "name": "Microsoft"
@@ -24,7 +24,7 @@
         "clean": "rimraf ./release",
         "start": "ts-node ./scripts/dev.ts",
         "test": "jest",
-        "test:integration": "playwright test --trace=retain-on-failure -c tests/integration/playwright.config.ts",
+        "test:integration": "playwright test -c tests/integration/playwright.config.ts",
         "test:integration:watch": "ts-node ./scripts/test.ts"
     },
     "types": "./release/esm/monaco.contribution.d.ts",

package/src/languageServiceManager/kustoLanguageService.ts

@@ -1695,7 +1695,7 @@ class KustoLanguageService implements LanguageService {
         const paramSymbol: sym.ScalarSymbol = Kusto.Language.Symbols.ScalarTypes.GetSymbol(
             getCslTypeNameFromClrType(param.type)
         );
-        return new sym.ParameterSymbol(param.name, paramSymbol, null);
+        return new sym.ParameterSymbol(param.name, paramSymbol, param.docstring ?? null);
     }
 
     private static createTabularParameterSymbol(param: s.TabularParameter): sym.ParameterSymbol {
@@ -1720,13 +1720,13 @@ class KustoLanguageService implements LanguageService {
                 paramSymbol,
                 null,
                 null,
-                null,
+                param.examples ? KustoLanguageService.toBridgeList(param.examples) : null,
                 false,
                 null,
                 1,
                 1,
                 expression,
-                null
+                param.docstring ?? null
             );
         }
 

package/tests/integration/completion-items.spec.ts

@@ -56,6 +56,7 @@ test.describe('completion items', () => {
         expect(options).toEqual([
             'EndTime',
             'StartTime',
+            '_time_zone',
             'datetime()',
             'datetime_add(part, value, datetime)',
             'datetime_diff(part, datetime1, datetime2)',
@@ -66,7 +67,6 @@ test.describe('completion items', () => {
             'format_datetime(date, format)',
             'format_timespan(timespan, format)',
             'ingestion_time()',
-            'make_datetime(year, month, day, [hour], [minute], [second])',
         ]);
     });
 

package/tests/integration/doc-comments.spec.ts

@@ -0,0 +1,32 @@
+import { test, expect } from '@playwright/test';
+import { createMonaKustoModel, MonaKustoModel, loadPageAndWait } from './testkit';
+
+test('scalar', async ({ page }) => {
+    await loadPageAndWait(page);
+    const model = createMonaKustoModel(page);
+
+    const editor = model.editor().locator;
+    await editor.focus();
+    await editor.fill('print _time_zone');
+
+    await page.getByRole('code').getByText('_time_zone').hover();
+    const tooltip = await page.getByRole('tooltip').locator('.rendered-markdown').innerText();
+    expect(tooltip).toEqual(
+        `_time_zone: string\n\nIANA time zone. For example: "America/Los_Angeles", UTC, or "Europe/Stockholm"`
+    );
+});
+
+test('tabular', async ({ page }) => {
+    await loadPageAndWait(page);
+    const model = createMonaKustoModel(page);
+
+    const editor = model.editor().locator;
+    await editor.focus();
+    await editor.fill('print _base_query');
+
+    await page.getByRole('code').getByText('_base_query').hover();
+    const tooltip = await page.getByRole('tooltip').locator('.rendered-markdown').innerText();
+    expect(tooltip).toEqual(
+        `_base_query: table(StartTime)\n\nBase query\nAvailability: Inline\n\nBase query will be inlined into this query`
+    );
+});

package/tests/integration/env/main.ts

@@ -10,6 +10,7 @@ import debounce from 'lodash/debounce';
 import kustoWorkerUrl from './kustoWorker?url';
 // @ts-ignore
 import editorWorker from './editorWorker?url';
+import type { ScalarParameter, TabularParameter } from '../../../src/monaco.contribution';
 
 window.MonacoEnvironment = {
     getWorker(_moduleId, label) {
@@ -100,11 +101,34 @@ window.addEventListener('resize', () => {
     editor.layout();
 });
 
+const scalarParameter: ScalarParameter = {
+    name: '_time_zone',
+    type: 'string',
+    docstring: 'IANA time zone. For example: "America/Los_Angeles", UTC, or "Europe/Stockholm"',
+};
+
+const tabularParameter: TabularParameter = {
+    columns: [
+        {
+            name: 'StartTime',
+            type: 'datetime',
+        },
+    ],
+    name: '_base_query',
+    docstring: '# Base query\n\n## Availability: Inline\n\nBase query will be inlined into this query\n',
+};
+
 getKustoWorker().then((workerAccessor) => {
     const model = editor.getModel();
     if (model) {
         workerAccessor(model.uri).then((worker) => {
-            worker.setSchemaFromShowSchema(schema, 'https://help.kusto.windows.net', 'Samples');
+            worker.setSchemaFromShowSchema(
+                schema,
+                'https://help.kusto.windows.net',
+                'Samples',
+                [scalarParameter],
+                [tabularParameter]
+            );
         });
     }
 });

package/tests/integration/playwright.config.ts

@@ -1,16 +1,16 @@
-import { defineConfig, devices } from '@playwright/test';
+import { defineConfig } from '@playwright/test';
 
 export default defineConfig({
     outputDir: './.test-results',
     preserveOutput: 'failures-only',
     forbidOnly: !!process.env.CI,
-    retries: process.env.CI ? 2 : 0,
     workers: process.env.CI ? 1 : undefined,
-    timeout: 5_000,
-    expect: { timeout: 5_000 },
-    reporter: 'line',
+    // https://playwright.dev/docs/test-reporters#github-actions-annotations
+    // 'github' for GitHub Actions CI to generate annotations, plus a concise 'dot'
+    // default 'list' when running locally
+    reporter: process.env.CI ? [['github'], ['html']] : undefined,
     use: {
-        trace: 'on-first-retry',
+        trace: 'retain-on-failure',
         defaultBrowserType: 'chromium',
     },
     webServer: {