lean4monaco 1.0.29 → 1.0.31

package/README.md

@@ -1,3 +1,7 @@
+[![GitHub license](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/hhu-adam/lean4monaco/blob/main/LICENSE)
+[![npm version](https://img.shields.io/npm/v/lean4monaco.svg)](https://www.npmjs.com/package/lean4monaco)
+[![(Runtime) Build and Test](https://github.com/hhu-adam/lean4monaco/actions/workflows/test.yml/badge.svg)](https://github.com/hhu-adam/lean4monaco/actions/workflows/test.yml)
+
 # Lean 4 Monaco
 
 Provides browser support for running Lean in a Monaco editor.
@@ -21,25 +25,51 @@ one or more editors can be created using `LeanMonacoEditor`. Here is an example
 how to use the classes using React:
 
 ```ts
-import { LeanMonaco, LeanMonacoEditor } from 'lean4monaco'
+import { LeanMonaco, LeanMonacoEditor, LeanMonacoOptions } from 'lean4monaco'
 
 [...]
 
-useEffect(() => {
-    const leanMonaco = new LeanMonaco()
-    const leanMonacoEditor = new LeanMonacoEditor()
-
-    ;(async () => {
-        await leanMonaco.start({websocket: {url: 'ws://localhost:8080/'}})
-        leanMonaco.setInfoviewElement(infoviewRef.current)
-        await leanMonacoEditor.start(codeviewRef.current!, '/project/test.lean', '#check Nat')
-    })()
-
-    return () => {
-        leanMonacoEditor.dispose()
-        leanMonaco.dispose()
-    }
+// Refs for the editor and infoview
+const editorRef = useRef<HTMLDivElement>(null)
+const infoviewRef = useRef<HTMLDivElement>(null)
+
+// Lean4monaco options
+const [options, setOptions] = useState<LeanMonacoOptions>({
+  websocket: {
+    url: 'ws://localhost:8080/'
+  },
+  htmlElement: undefined, // The wrapper div for monaco
+  vscode: {
+    "editor.wordWrap": true,
+  }
 })
+
+// Optional: restrict monaco's extend (e.g. context menu) to the editor itself
+useEffect(() => {
+  setOptions({...options, htmlElement: editorRef.current ?? undefined})
+}, [editorRef])
+
+// Start infoview and editor(s)
+useEffect(() => {
+  // You must create a single `LeanMonaco` instance (infoview), but you can create multiple
+  // `LeanMonacoEditor` instances (editor)
+  // You must await `leanMonaco.start` or use `await leanMonaco.whenReady` before
+  // starting the editors!
+  const leanMonaco = new LeanMonaco()
+  const leanMonacoEditor = new LeanMonacoEditor()
+
+  leanMonaco.setInfoviewElement(infoviewRef.current!)
+
+  ;(async () => {
+    await leanMonaco.start(options)
+    await leanMonacoEditor.start(editorRef.current!, '/project/test.lean', '#check Nat')
+  })()
+
+  return () => {
+    leanMonaco.dispose()
+    leanMonacoEditor.dispose()
+  }
+}, [options, infoviewRef, editorRef])
 ```
 
 ### Configure vite
@@ -144,10 +174,11 @@ Afterwards, you can run the demo with
 ```
 cd lean4monaco
 npm install
+npm setup_demo # this builds lean4monaco and calls `npm install` in `demo/`
 npm start
 ```
 
-and open [http://localhost:5173](http://localhost:5173). This should open a rudimentary webpage
+and open [localhost:5173](http://localhost:5173). This should open a rudimentary webpage
 with 1 (or more) monaco editors and an infoview, showing the Lean infos at the cursor.
 
 ## Troubleshooting
@@ -164,3 +195,36 @@ Some random errors we encountered. If you have more, please share them.
 
 * Warnings about `glob` and `inflight` come from `copyfiles`: see [copyfiles#132](https://github.com/calvinmetcalf/copyfiles/pull/132)
 * Warning about ` @types/cypress` comes from `cypress-iframe`
+
+## Development
+
+You can run
+
+```
+npm install
+npm run test
+```
+
+for the automated cypress tests.
+
+### Docker image
+
+The Dockerfile defines an image where the server is run in a Linux container.
+You can look at the github workflow to see how it is used; in particular the image can
+be built with
+
+```
+docker build  -t lean4monaco .
+```
+
+and then started with
+
+```
+docker run -it -p 5173:5173 -p 8080:8080 lean4monaco
+```
+
+Now the demo should be accessible at [localhost:5173](http://localhost:5173).
+
+This is an alternative to calling `npm start`, but it
+does not have some feature such as auto-reload
+on edit.

package/dist/leanmonaco.js

@@ -32,23 +32,18 @@ export class LeanMonaco {
     infoviewEl;
     disposed = false;
     async start(options) {
-        if (!options.htmlElement) {
-            console.debug('[LeanMonaco]: not starting because container is null');
-            return;
-        }
-        else {
-            console.debug('[LeanMonaco]: starting');
-        }
+        console.debug('[LeanMonaco]: starting');
         if (LeanMonaco.activeInstance == this) {
-            console.warn('A LeanMonaco instance cannot be started twice.');
+            console.warn('[LeanMonaco]: A LeanMonaco instance cannot be started twice.');
             return;
         }
         if (LeanMonaco.activeInstance) {
-            console.warn('There can only be one active LeanMonaco instance at a time. Disposing previous instance.');
+            console.warn('[LeanMonaco]: There can only be one active LeanMonaco instance at a time. Disposing previous instance.');
             LeanMonaco.activeInstance?.dispose();
         }
         LeanMonaco.activeInstance = this;
         if (!window.MonacoEnvironment) {
+            console.debug('[LeanMonaco]: setting monaco environment');
             const workerLoaders = {
                 editorWorkerService: () => new Worker(new URL('monaco-editor/esm/vs/editor/editor.worker.js', import.meta.url), { type: 'module' }),
                 textMateWorker: () => new Worker(new URL('@codingame/monaco-vscode-textmate-service-override/worker', import.meta.url), { type: 'module' }),
@@ -68,7 +63,10 @@ export class LeanMonaco {
                 ...getConfigurationServiceOverride(),
                 ...getLanguagesServiceOverride(),
                 ...getModelServiceOverride()
-            }, options.htmlElement, {
+            }, 
+            // The wrapper HTML element determines the extend of certain monaco features
+            // such as the right-click context menu.
+            options.htmlElement ?? undefined, {
                 workspaceProvider: {
                     trusted: true,
                     workspace: {
@@ -79,22 +77,29 @@ export class LeanMonaco {
                     }
                 }
             });
+            console.debug('[LeanMonaco]: done initializing');
         }
         await (await import('@codingame/monaco-vscode-theme-defaults-default-extension')).whenReady;
-        if (this.disposed)
+        if (this.disposed) {
+            console.debug('[LeanMonaco]: is disposed (A)');
             return;
+        }
         this.extensionRegisterResult = registerExtension(this.getExtensionManifest(), 1 /* ExtensionHostKind.LocalProcess */);
         for (const entry of this.getExtensionFiles()) {
             const registerFileUrlResult = this.extensionRegisterResult.registerFileUrl(entry[0], entry[1].href);
             this.registerFileUrlResults.add(registerFileUrlResult);
         }
         await this.extensionRegisterResult.whenReady();
-        if (this.disposed)
+        if (this.disposed) {
+            console.debug('[LeanMonaco]: is disposed (B)');
             return;
+        }
         const themeService = await getService(IThemeService);
         const configurationService = await getService(IConfigurationService);
-        if (this.disposed)
+        if (this.disposed) {
+            console.debug('[LeanMonaco]: is disposed (C)');
             return;
+        }
         this.updateVSCodeOptions(options.vscode ?? {});
         this.abbreviationFeature = new AbbreviationFeature({}, { kind: 'MoveAllSelections' });
         this.clientProvider = new LeanClientProvider({
@@ -151,8 +156,11 @@ export class LeanMonaco {
             "workbench.colorTheme": "Visual Studio Light",
             ...options.vscode
         });
-        if (this.disposed)
+        if (this.disposed) {
+            console.debug('[LeanMonaco]: is disposed (D)');
             return;
+        }
+        console.info('[LeanMonaco]: is ready!');
         this.ready();
     }
     /** Update options of the editor */

package/dist/vscode-lean4/lean4-infoview/node_modules/@vscode/codicons/_iconCloud/keywords.transforms.json

@@ -0,0 +1,83 @@
+[
+  {
+    "method": "LoadTable",
+    "params": {
+      "relativePath": "_DataFilePath_",
+      "rootPath": "_RootPath_"
+    },
+    "variable": "iconKeywordsInputTable"
+  },
+  {
+    "transforms": [
+      {
+        "method": "Copy",
+        "params": {
+          "from": "_LibraryKey_"
+        },
+        "variable": "_IconData_LibraryKey_"
+      },
+      {
+        "method": "Copy",
+        "params": {
+          "from": "_IconTypeKey_"
+        },
+        "variable": "_IconData_TypeKey_"
+      },
+      {
+        "method": "GetColumnValue",
+        "params": {
+          "columnName": "iconColumnIconKeyValueName",
+          "iterator": "iconKeywordsTableIterator"
+        },
+        "variable": "iconKeyValue"
+      },
+      {
+        "method": "GetHashKey",
+        "notes": "The icon Key is derived from the uppercase unicode value.",
+        "params": {
+          "from": "iconKeyValue"
+        },
+        "variable": "_IconData_Key_"
+      },
+      {
+        "method": "UpdateVariablesTable",
+        "params": {
+          "variables": "_IconDataVariables_"
+        },
+        "variable": "_IconData_"
+      },
+      {
+        "method": "Clear",
+        "variable": "iconArtifacts"
+      },
+      {
+        "method": "GetColumnValue",
+        "params": {
+          "columnName": "iconColumnKeywordsName",
+          "iterator": "iconKeywordsTableIterator"
+        },
+        "variable": "iconKeywords"
+      },
+      {
+        "method": "AddToVariableBag",
+        "params": {
+          "value": "iconKeywords"
+        },
+        "variable": "iconArtifacts"
+      },
+      {
+        "method": "AddNameValuePairsToAssociationTable",
+        "params": {
+          "key": "_IconData_Key_",
+          "values": "iconArtifacts",
+          "keyColumn": "_IconArtifactData_IconKey_",
+          "namesColumn": "_IconArtifactData_Name_",
+          "valuesColumn": "_IconArtifactData_Value_"
+        },
+        "variable": "_IconArtifactData_"
+      }
+    ],
+    "method": "ForEachRow",
+    "variable": "iconKeywordsTableIterator"
+  }
+]

package/dist/vscode-lean4/lean4-infoview/node_modules/@vscode/codicons/_iconCloud/keywords.variables.json

@@ -0,0 +1,47 @@
+[
+  {
+    "tableSpecifier": {
+      "dataColumnIndex": 0,
+      "dataRowIndex": 1,
+      "headerRowIndex": 0
+    },
+    "type": "Table",
+    "valueType": "None",
+    "name": "iconKeywordsInputTable"
+  },
+  {
+    "type": "Value",
+    "value": "IconKeyValue",
+    "valueType": "Text",
+    "referenceOnly": true,
+    "name": "iconColumnIconKeyValueName"
+  },
+  {
+    "type": "Value",
+    "value": "Keywords",
+    "valueType": "Text",
+    "referenceOnly": true,
+    "name": "iconColumnKeywordsName"
+  },
+  {
+    "type": "TableIterator",
+    "TargetName": "iconKeywordsInputTable",
+    "name": "iconKeywordsTableIterator"
+  },
+  {
+    "type": "Value",
+    "valueType": "Text",
+    "name": "iconKeyValue"
+  },
+  {
+    "type": "Value",
+    "valueType": "Text",
+    "name": "iconKeywords"
+  },
+  {
+    "type": "VariableBag",
+    "valueType": "None",
+    "values": [],
+    "name": "iconArtifacts"
+  }
+]

package/dist/vscode-lean4/lean4-infoview/node_modules/@vscode/codicons/_iconCloud/manifest.json

@@ -0,0 +1,36 @@
+{
+  "_type": "Library",
+  "_version": "XCHRDK",
+  "dataPaths": [
+    {
+      "dataPath": "~/dist/codicon.csv",
+      "transformPaths": ["~/_iconCloud/manifest.transforms.json"],
+      "variablePaths": ["~/_iconCloud/manifest.variables.json"]
+    },
+    {
+      "dataPath": "~/_iconCloud/keywords.csv",
+      "transformPaths": ["~/_iconCloud/keywords.transforms.json"],
+      "variablePaths": ["~/_iconCloud/keywords.variables.json"]
+    }
+  ],
+  "iconType": "Glyph",
+  "lastUpdated": "2020-10-23T12:00Z",
+  "libraryInfoKey": "8df73c1d1",
+  "libraryName": "VS Code Icons",
+  "libraryProperties":
+  {
+    "copyPreviewTypes": "Glyph",
+    "copySize": "32",
+    "copyTypes": "Glyph,Svg",
+    "downloadDefaultSize": "32",
+    "downloadTypes": "Svg",
+    "libraryFileNameBase": "VsCodeIcons",
+    "libraryIconSizes": "16,24,32,40,48,56,64",
+    "metadata-1-dataMapping": "Icon:iconKeywords",
+    "metadata-1-dataStyle": "ClickablePill",
+    "metadata-1-dataType": "Keywords",
+    "metadata-1-label": "Keywords",
+    "metadata-1-sorting": "ByWeight"
+  },
+  "libraryVersion": "2.43"
+}