@kusto/monaco-kusto 10.0.21 → 11.0.0

package/README.md

@@ -28,7 +28,8 @@ Example at [/samples/amd](https://github.com/Azure/monaco-kusto/tree/master/samp
 1. Run `npm run copyMonacoFilesAMD <path>` or `yarn copyMonacoFilesAMD <path>`
    where <path> is where you want the monaco and kusto amd modules to be. These
    files will need to be served as-in.
-2. Using a amd module loader, import `vs/language/kusto/monaco.contribution` 1. The monaco editors included loader can be made available via a global
+2. Using a amd module loader, import `vs/language/kusto/monaco.contribution` 1. The monaco editors included loader can
+   be made available via a global
    require `require` by adding the script tag: `<script src="<path>/vs/loader.js"></script>`
 3. You should now be able to create monaco editors with `language: 'kusto'`. The
    kusto worker can be reached via the monaco global:
@@ -58,6 +59,8 @@ There are 2 APIs to set a Kusto schema:
 
 ## Contributing
 
+Every PR should come with a test that checks it.
+
 ### Setting up a dev environment
 
 1. Install Node.js 20 https://nodejs.org/
@@ -70,11 +73,23 @@ There are 2 APIs to set a Kusto schema:
 1. Set CI environment variable to "tru"
 2. Run `yarn build`
 
+## Running integration tests
+
+1. Run `yarn test:install` from the root of the project
+2. Run `yarn test` from the package folder to run the tests in headless mode
+3. Run `yarn test:watch` from the package folder to run the tests in a browser and rebuild after each change
+
 ## Changelog
 
+### 11.0.0
+
+-   BREAKING CHANGE: Removed the useIntellisenseV2 option; it now defaults to true.
+-   feat: upgrade language service next to 11.5.5
+
 ### 10.0.0
 
--   BREAKING CHANGE: addClusterToSchema know excepts databases as an object with name and alternative name instead of just a string name.
+-   BREAKING CHANGE: addClusterToSchema know excepts databases as an object with name and alternative name instead of just
+    a string name.
 
 ### 9.0.0
 
@@ -101,7 +116,8 @@ There are 2 APIs to set a Kusto schema:
 
 ### 7.2.0
 
--   Added "themeNames" object to exports which contains the theme we register with monaco: kusto-light, kusto-dark, and kusto-dark2
+-   Added "themeNames" object to exports which contains the theme we register with monaco: kusto-light, kusto-dark, and
+    kusto-dark2
 
 ### 7.0.1
 
@@ -110,7 +126,8 @@ There are 2 APIs to set a Kusto schema:
 ### 7.0.0
 
 -   BREAKING CHANGE: Bumped monaco-editor peer dependency to ~0.37.0
-    -   This version of monaco-editor no longer requires a patch to work with Parcel. Details here: https://github.com/microsoft/monaco-editor/issues/2966
+    -   This version of monaco-editor no longer requires a patch to work with Parcel. Details
+        here: https://github.com/microsoft/monaco-editor/issues/2966
 -   fix: "monaco is not defined" errors when consuming esm files
 -   Moved types from global interface (`monaco.languages.kusto.*`) to esm index
     file `import { SomeType } from '@kusto/monaco-kusto`. With this, esm
@@ -216,8 +233,10 @@ There are 2 APIs to set a Kusto schema:
 
 ### 3.2.0
 
--   A function validation fails (shows squiggly red lines), if the function is defined with a parameter that has a default value, but it is used without passing a value for that parameter.
--   Fix bug: Scalars function parameters are always showing "Table expected" error with squiggly error red line when using setSchemaFromShowSchema.
+-   A function validation fails (shows squiggly red lines), if the function is defined with a parameter that has a default
+    value, but it is used without passing a value for that parameter.
+-   Fix bug: Scalars function parameters are always showing "Table expected" error with squiggly error red line when using
+    setSchemaFromShowSchema.
 
 ### 3.1.0-beta.3
 
@@ -225,7 +244,8 @@ There are 2 APIs to set a Kusto schema:
 
 ### 3.0.1
 
--   Fix exception "Cannot read property 'getText' of null TypeError: Cannot read property 'getText' of null at e.parseDocumentV2"
+-   Fix exception "Cannot read property 'getText' of null TypeError: Cannot read property 'getText' of null at
+    e.parseDocumentV2"
 -   Added a sample react project
 
 ### 3.0.0
@@ -333,7 +353,8 @@ There are 2 APIs to set a Kusto schema:
 
 #### Added
 
--   Added `getReferencedGlobalParams` that returns the global (ambient) parameters that are actually being referenced in the query.
+-   Added `getReferencedGlobalParams` that returns the global (ambient) parameters that are actually being referenced in
+    the query.
 
 ### 2.0.3
 
@@ -388,7 +409,8 @@ There are 2 APIs to set a Kusto schema:
 
 #### Added
 
--   Introduce a new function in language service called `getQueryParams`. it will return an array of all delcared query parameters for the query on cursor.
+-   Introduce a new function in language service called `getQueryParams`. it will return an array of all delcared query
+    parameters for the query on cursor.
 
 ### 1.1.14 (9/16/2019)
 
@@ -431,7 +453,8 @@ There are 2 APIs to set a Kusto schema:
 
 #### Bug fix
 
--   don't kill web worker after 2 minutes of inactivity by default. Reason: In exterme cases where schema is very large, trying to stringify the schema in web worker causes an OOM. This is configurable though.
+-   don't kill web worker after 2 minutes of inactivity by default. Reason: In exterme cases where schema is very large,
+    trying to stringify the schema in web worker causes an OOM. This is configurable though.
 
 ### 1.0.6 (6/6/2019)
 
@@ -566,7 +589,8 @@ There are 2 APIs to set a Kusto schema:
 
 #### Bug Fix
 
--   fix quirks in interactions between non-semantic and semantic colorization by not using semantic coloring to color plain text.
+-   fix quirks in interactions between non-semantic and semantic colorization by not using semantic coloring to color
+    plain text.
 
 ### 0.1.11
 
@@ -579,16 +603,19 @@ There are 2 APIs to set a Kusto schema:
 ### Bug Fixes
 
 -   Intellisense didn't work properly when editing in the middle of a block that is not the 1st block on the page.
--   Monarch colorization now colorizes sub-opeators the same as semantic colorization (which makes the changes less jarring when completing semantic colorization).
+-   Monarch colorization now colorizes sub-opeators the same as semantic colorization (which makes the changes less
+    jarring when completing semantic colorization).
 -   When switching context, colorization didn't recolorize.
 -   (perf) Only colorize the currently edited block(s) - this supports multi-cursor editing
--   (perf) don't deeply parse the entire doc when doing completion. just get the list of commands and then parse the relevant command's all tokns.
+-   (perf) don't deeply parse the entire doc when doing completion. just get the list of commands and then parse the
+    relevant command's all tokns.
 
 ### 0.1.1
 
 ### Added
 
--   removed semantic colorization from main thread. From now on basic colorization (schema-unaware) will happen on main thread, and semantic colorization will happen in background thread. This should improve typing performance
+-   removed semantic colorization from main thread. From now on basic colorization (schema-unaware) will happen on main
+    thread, and semantic colorization will happen in background thread. This should improve typing performance
     on long rows, or on large databases.
 
 ### 0.1.0
@@ -631,7 +658,8 @@ There are 2 APIs to set a Kusto schema:
 
 #### Bug Fixes
 
--   **[breaking]** Cache clutsser schema in memory. This breaks backward compatibility since it now requries schema to include minor and major version of databases.
+-   **[breaking]** Cache clutsser schema in memory. This breaks backward compatibility since it now requries schema to
+    include minor and major version of databases.
 
 ### 0.89
 
@@ -682,7 +710,8 @@ There are 2 APIs to set a Kusto schema:
 -   update version of @kusto/language-service-next to 0.0.10, integrated following functionality:
 
 1. library orders items on its own, so no need to order in monaco-kusto
-2. add support for the cursor not ending in the end of the completion text (like in the 1st parmaeter7 of a function for example)
+2. add support for the cursor not ending in the end of the completion text (like in the 1st parmaeter7 of a function for
+   example)
 3. add '|' after table name
 
 -   Make sure to never parse the same text more than once.
@@ -714,7 +743,8 @@ There are 2 APIs to set a Kusto schema:
 
 #### Bug Fixes
 
--   **[breaking]** - Update monaco-editor peer dependency to "^0.12.0" because of bug fixes performed there. Also making the
+-   **[breaking]** - Update monaco-editor peer dependency to "^0.12.0" because of bug fixes performed there. Also making
+    the
     dependency more permissive (allow later minor versions).
 
 ### 0.67
@@ -727,19 +757,22 @@ There are 2 APIs to set a Kusto schema:
 
 #### Functionality
 
--   updated @kusto/lagnuage-service to latest version. this contains the latest operators, documentation, and charting logic.
+-   updated @kusto/lagnuage-service to latest version. this contains the latest operators, documentation, and charting
+    logic.
 
 ### 0.64
 
 #### Bug Fixes
 
--   Added peer dependency for `monaco-editor@0.11` so that consumers of the package get a warning if their version of monaco is too old.
+-   Added peer dependency for `monaco-editor@0.11` so that consumers of the package get a warning if their version of
+    monaco is too old.
 
 ### 0.63
 
 #### Functionality
 
--   **[breaking]** - The package now requires `monaco-editor@0.11.1` to function correctly. adds support for markdown in intellisense documentation.
+-   **[breaking]** - The package now requires `monaco-editor@0.11.1` to function correctly. adds support for markdown in
+    intellisense documentation.
 
 ### 0.62
 
@@ -751,7 +784,8 @@ There are 2 APIs to set a Kusto schema:
 
 #### Functionality
 
--   **[breaking]**: make setSchema async so that big schemas do not block the ui thread (specifically - tokenization code is running in ui thread so it can block rendering).
+-   **[breaking]**: make setSchema async so that big schemas do not block the ui thread (specifically - tokenization code
+    is running in ui thread so it can block rendering).
 
 ### 0.60
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kusto/monaco-kusto",
-    "version": "10.0.21",
+    "version": "11.0.0",
     "description": "CSL, KQL plugin for the Monaco Editor",
     "author": {
         "name": "Microsoft"
@@ -21,7 +21,11 @@
         "watch": "ts-node ./scripts/watch.ts",
         "typecheck": "tsc",
         "test_release": "echo release > test/mode.txt && http-server -c-1 -p 8080 ./ -o index.html",
-        "clean": "rimraf ./release"
+        "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:watch": "ts-node ./scripts/test.ts"
     },
     "types": "./release/esm/monaco.contribution.d.ts",
     "module": "./release/esm/monaco.contribution.js",
@@ -38,6 +42,7 @@
         "@babel/core": "^7.22.20",
         "@babel/preset-env": "^7.22.20",
         "@babel/preset-typescript": "^7.22.15",
+        "@playwright/test": "^1.44.0",
         "@rollup/plugin-alias": "^5.0.0",
         "@rollup/plugin-babel": "^6.0.3",
         "@rollup/plugin-commonjs": "^25.0.4",
@@ -52,22 +57,26 @@
         "browser-sync": "^3.0.2",
         "concurrently": "^8.2.1",
         "http-server": "^14.1.1",
-        "monaco-editor": "^0.46.0",
+        "jest": "^29.7.0",
+        "monaco-editor": "^0.49.0",
         "rimraf": "^5.0.1",
         "rollup": "^3.29.2",
         "terser": "^5.19.4",
+        "ts-jest": "^29.1.4",
         "ts-node": "^10.9.1",
         "typescript": "^5.2.2",
+        "vite": "^5.2.11",
+        "vite-plugin-node-polyfills": "^0.21.0",
         "vscode-languageserver-textdocument": "1.0.8"
     },
     "dependencies": {
         "@kusto/language-service": "0.0.278",
-        "@kusto/language-service-next": "11.5.3",
+        "@kusto/language-service-next": "11.5.5",
         "lodash-es": "^4.17.21",
         "vscode-languageserver-types": "^3.17.4",
         "xregexp": "^5.1.1"
     },
     "peerDependencies": {
-        "monaco-editor": "^0.46.0"
+        "monaco-editor": "0.49.0"
     }
 }