feat: add custom editor / visualizer to vscode extension #1243

GideonKoenig · 2024-10-21T23:51:12Z

Giant Pull Request - All in one - I'm sorry

… statement node expandable

…n node

codecov · 2024-10-29T11:57:59Z

Codecov Report

Attention: Patch coverage is 31.32530% with 1026 lines in your changes missing coverage. Please review.

Project coverage is 94.86%. Comparing base (3d9d4db) to head (cafa613).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...lang/src/language/custom-editor/ast-parser/call.ts	15.18%	268 Missing ⚠️
...src/language/custom-editor/ast-parser/statement.ts	22.31%	94 Missing ⚠️
.../src/language/custom-editor/getGlobalReferences.ts	18.69%	87 Missing ⚠️
...ang/src/language/custom-editor/ast-parser/utils.ts	33.33%	86 Missing ⚠️
...-lang/src/language/custom-editor/getSyncChannel.ts	26.66%	66 Missing ⚠️
...g/src/language/custom-editor/getNodeDescription.ts	21.95%	64 Missing ⚠️
...uage/custom-editor/ast-parser/tools/debug-utils.ts	22.36%	59 Missing ⚠️
...lang/src/language/custom-editor/ast-parser/main.ts	25.45%	41 Missing ⚠️
...lang/src/language/custom-editor/ast-parser/edge.ts	42.85%	40 Missing ⚠️
...rc/language/custom-editor/ast-parser/expression.ts	35.00%	39 Missing ⚠️
... and 8 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1243      +/-   ##
==========================================
- Coverage   99.79%   94.86%   -4.94%     
==========================================
  Files         110      128      +18     
  Lines       19247    20741    +1494     
  Branches     4110     4111       +1     
==========================================
+ Hits        19207    19675     +468     
- Misses         40     1066    +1026

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

lars-reimann

First batch of comments about the stub changes.

packages/safe-ds-lang/src/resources/builtins/safeds/lang/ideIntegration.sdsstub

packages/safe-ds-lang/src/resources/builtins/safeds/data/tabular/plotting/TablePlotter.sdsstub

### Summary of Changes Modifies the language stubs in preparation for the Custom Editor/Visualization PR #1243. Defines/Adjusts the DataScienceCategories and assigns them to a sample amount of functions and classes from the Safe-Ds language. --------- Co-authored-by: Lars Reimann <mail@larsreimann.com>

...es/safe-ds-lang/src/resources/builtins/safeds/ml/classical/regression/ArimaRegressor.sdsstub

lars-reimann · 2024-11-14T11:32:31Z

packages/safe-ds-lang/.prettierrc.json

Should not be included in the repo. Code should look consistent, regardless of the sub-project.

Locally, you can of course reformat the (TypeScript) code, however you want.

lars-reimann · 2024-11-14T11:35:00Z

.eslintrc.cjs

+        {
+            files: ['packages/safe-ds-editor/src/**'],
+            rules: {
+                'import/no-default-export': 'off',
+                'no-console': 'off',
+            },
+        },


I don't see a reason to disable these rules completely for this folder.

Default exports are rarely needed, and using named exports throughout leads to more consistent code and a more consistent API. Moreover, we provide names for the exported elements, which already indicate their purpose. Default exports are unnamed, so users must always refer to documentation or the module that exports them.

Console statements are very easy to forget in the code. You are better off disabling the error for the few lines where you need them by adding a comment directly above the affected lines (https://eslint.org/docs/latest/use/configure/rules#disabling-rules).

lars-reimann · 2024-11-14T11:41:27Z

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "files.associations": {
+        "*.css": "tailwindcss"


Does this require any extension to be installed?

lars-reimann · 2024-11-14T11:42:06Z

packages/safe-ds-editor/.prettierrc.json

See other comment about updating prettierrc. Should not be included in the repo.

lars-reimann · 2024-11-14T11:42:49Z

packages/safe-ds-editor/components.json

What does this do?

This is the configuration file for shadcn.
Here is the documentation for it.

lars-reimann · 2024-11-14T11:45:49Z

packages/safe-ds-editor/migrationTools/copyToExtension.js

I'd greatly prefer this to be included in ESBuild script in the safe-ds-vscode project (packages\safe-ds-vscode\esbuild.mjs). It's always better if a project manages its dependencies rather than its dependents.

lars-reimann · 2024-11-14T11:46:35Z

packages/safe-ds-editor/postcss.config.js

If default exports are unavoidable here, add a comment to disable the error for the next line.

lars-reimann · 2024-11-14T11:51:37Z

packages/safe-ds-lang/src/language/custom-editor/ast-parser/argument.ts

The next step would be to extract the custom-editor service into its own PR. It also requires unit tests. Finally, "custom-editor" is a very general name, maybe something like "graphical-editor" is better (or currently "graphical-view", though then we'd have to rename it eventually). I'm open for suggestions here.

lars-reimann · 2024-11-14T11:59:53Z

packages/safe-ds-lang/src/language/custom-editor/ast-parser/utils.ts

+    static callList: Call[];
+    static genericExpressionList: GenericExpression[];
+    static edgeList: Edge[];
+    static safeDsServices: SafeDsServices;


Anything that needs services should be made a service, so everything gets wired up properly. Here, Utils is in an invalid state before initialize is called.

Likewise, it should not have static state/methods but instance state/methods, since multiple instances of SafeDsServices might be in use at the same time, e.g. when running tests. Using static state here, can quickly lead to subtle bugs.

lars-reimann · 2024-11-14T12:02:52Z

packages/safe-ds-lang/src/language/custom-editor/ast-parser/utils.ts

+export const zip = <A, B>(arrayA: A[], arrayB: B[]): [A, B][] => {
+    const minLength = Math.min(arrayA.length, arrayB.length);
+    const result: [A, B][] = [];
+
+    for (let i = 0; i < minLength; i++) {
+        result.push([arrayA[i]!, arrayB[i]!]);
+    }
+
+    return result;
+};


Would be a useful addition to packages\safe-ds-lang\src\helpers\collections.ts.

## [0.22.0](v0.21.1...v0.22.0) (2024-11-24) ### Features * categorize API elements ([#1263](#1263)) ([d0d971e](d0d971e)), closes [#1243](#1243) * disable inlay hints for assignee types by default ([#1260](#1260)) ([a651ade](a651ade)) * improve error messages from linker ([#1272](#1272)) ([eddd868](eddd868)), closes [#1268](#1268) * output statement ([#1262](#1262)) ([011ba31](011ba31)), closes [#1259](#1259) * remove schema concept from grammar ([#1273](#1273)) ([1a3bf80](1a3bf80)), closes [#1133](#1133)

lars-reimann · 2024-12-17T12:37:30Z

Bug 1: The following code causes an error:

package demo

pipeline whoSurvived {
    val titanic = Table.fromCsvFile("titanic.csv");
    val _histogram = titanic.plot.histograms();
}

c:\Users\Lars\Desktop\safe-ds-examples\demo.sds:5:22 - Invalid Call receiver: MemberAccess: Receiver is not a Reference or Call but - SdsMemberAccess```

lars-reimann · 2024-12-17T12:40:45Z

Bug 2: Closing the graphical view, changing the code, and opening the graphical view shows the old graph without changes. Even changing pipelines and opening the graphical view shows the old graph for the other pipeline.

lars-reimann · 2024-12-17T13:31:15Z

Bug 3 (low priority): Examples in the documentation are barely visible:

Why do we actually show the textual examples at all in the graphical view?

Also: the headers of the sections in the sidebar should be in English (e.g. Documentation instead of Dokumentation).

### Summary of Changes Modifies the language stubs in preparation for the Custom Editor/Visualization PR #1243.

GideonKoenigJukabo and others added 30 commits January 27, 2024 14:08

add custom editor to package.json

261b87c

feat: Add CustomEditorProvider

29f6501

feat: hide menu item command when in custom editor

f701ce0

initialize svelte webview

cb9b61b

create svelte project with tailwind

0c2f360

add settings for custom-editor submodule

39be0b5

add dynamic css file import

fac0bdf

improve dx - setup watch command

36c606e

ignore custom editor devtools in eslint

1a2a10f

change custom-editor bundle migration target fild

f5c2e5e

add tailwind and shadcn to svelte project

6fa703d

create base message structure

cca3c79

create test message from webview to extension

1e31930

add MessageHandler to Extension and Webview components

11cc564

establish communication with language server

8ecdfa5

refine language server message definition

c7b38f9

refine language server message definition

c8ea001

use shared types for language server communication

974fd58

change device

6b3388d

priamry sidebar cleanup, initialize grid

38f592f

feat: tooltip trait

5aba7d3

refine tooltip (add pointer) | add Parameter to statement node | make…

bc8c8aa

… statement node expandable

add placeholder node

df1f7de

refactor assets | modify placeholder name placement | start expressio…

9877413

…n node

add extension node

e6fce0e

add expression node | rework port structure

419fa72

Merge branch 'main' into custom-editor

1980c70

move message registration in safe-ds-lang

151b6ce

eod | primary sidebar

3ff8ad5

exchange expression icon

16841cd

feat: vertical processing animation and filtered global references

13f104c

GideonKoenig changed the title ~~Custom editor / Visualization~~ feat: add custom editor / visualization to vscode extension Oct 29, 2024

GideonKoenig added 2 commits October 29, 2024 12:46

fix: missing linux build dependency

fc8866b

fix: spelling mistake, and missing test adjustment

40ab1f4

GideonKoenig and others added 4 commits October 29, 2024 13:06

fix: ignore lint rules for tailwind.css

85a7ee5

fix: a bunch of linter issues

14dfda4

fix: more lint issues

707bcb3

style: apply automated linter fixes

cafa613

GideonKoenig changed the title ~~feat: add custom editor / visualization to vscode extension~~ feat: add custom editor / visualizer to vscode extension Oct 29, 2024

GideonKoenig marked this pull request as ready for review October 29, 2024 14:28

GideonKoenig requested a review from lars-reimann as a code owner October 29, 2024 14:28

lars-reimann reviewed Oct 31, 2024

View reviewed changes

GideonKoenig mentioned this pull request Nov 12, 2024

feat: categorize API elements #1263

Merged

GideonKoenig added 3 commits November 14, 2024 11:57

Merge branch 'main' into custom-editor

62fa1e4

fix: formatting issue

034fa77

fix: formatting issue

aa6d5b9

GideonKoenig commented Nov 14, 2024

View reviewed changes

...es/safe-ds-lang/src/resources/builtins/safeds/ml/classical/regression/ArimaRegressor.sdsstub Outdated Show resolved Hide resolved

fix: more formatting issues

9382a64

lars-reimann requested changes Nov 14, 2024

View reviewed changes

lars-reimann reviewed Nov 14, 2024

View reviewed changes

GideonKoenig added 2 commits December 17, 2024 15:33

meta: swap device

f85738b

Merge branch 'main' into custom-editor

ea2a468

GideonKoenig mentioned this pull request Dec 17, 2024

feat: categorize API elements #1285

Merged

lars-reimann pushed a commit that referenced this pull request Dec 20, 2024

feat: categorize API elements (#1285)

3275900

### Summary of Changes Modifies the language stubs in preparation for the Custom Editor/Visualization PR #1243.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add custom editor / visualizer to vscode extension #1243

feat: add custom editor / visualizer to vscode extension #1243

GideonKoenig commented Oct 21, 2024

codecov bot commented Oct 29, 2024 •

edited

Loading

lars-reimann left a comment

lars-reimann Nov 14, 2024

lars-reimann Nov 14, 2024

lars-reimann Nov 14, 2024

lars-reimann Nov 14, 2024

lars-reimann Nov 14, 2024

GideonKoenig Dec 17, 2024

lars-reimann Nov 14, 2024 •

edited

Loading

lars-reimann Nov 14, 2024

lars-reimann Nov 14, 2024

lars-reimann Nov 14, 2024 •

edited

Loading

lars-reimann Nov 14, 2024

lars-reimann commented Dec 17, 2024 •

edited

Loading

lars-reimann commented Dec 17, 2024 •

edited

Loading

lars-reimann commented Dec 17, 2024 •

edited

Loading

feat: add custom editor / visualizer to vscode extension #1243

Are you sure you want to change the base?

feat: add custom editor / visualizer to vscode extension #1243

Conversation

GideonKoenig commented Oct 21, 2024

codecov bot commented Oct 29, 2024 • edited Loading

Codecov Report

lars-reimann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lars-reimann Nov 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lars-reimann Nov 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lars-reimann commented Dec 17, 2024 • edited Loading

lars-reimann commented Dec 17, 2024 • edited Loading

lars-reimann commented Dec 17, 2024 • edited Loading

codecov bot commented Oct 29, 2024 •

edited

Loading

lars-reimann Nov 14, 2024 •

edited

Loading

lars-reimann Nov 14, 2024 •

edited

Loading

lars-reimann commented Dec 17, 2024 •

edited

Loading

lars-reimann commented Dec 17, 2024 •

edited

Loading

lars-reimann commented Dec 17, 2024 •

edited

Loading