andretrump / puredit Goto Github PK

View Code? Open in Web Editor NEW

This project forked from niklaskorz/puredit

0.0 0.0 0.0 6.66 MB

A projectional editor that uses textual code as its source of truth.

Home Page: https://puredit.atrump.de

License: MIT License

Shell 0.01% JavaScript 1.86% Python 1.99% TypeScript 85.08% HTML 0.25% Dockerfile 0.03% Svelte 10.78%

puredit's Introduction

Project Overview

This repository extends the projectional code editor Puredit by Niklas Korz and Artur Andrzejak. The editor matches parametrized patterns against a GPL program and displays the matched parts as dynamically rendered widgets.

Detailed documentation of the project can be found in our wiki.

Installing the Visual Studio Code Extension

The preferred way to use the projectional editor is through our VS Code extension. To install and test the extension, proceed as follows:

Go to the latest release and download the asset test-project.zip.
Unpack the zip archive and open the unpacked folder in VS Code.
In the file explorer, right-click the .vsix file and select "Install Extension VSIX" from the context menu.
If you already had installed an older version of the extension, reload the VS Code window.
Right-click one of the .py files in the folder and select "Open with"
Select the "Projectional Python Editor" from the list.

The selected file should then open in the projectional editor. You can customize the projectional editor with your own projections as described in the section YAML- or JSON-based Projections of the documentation.

Testing the Projectional Editor in the Browser

To test the editor without any installation, please refer to puredit.atrump.de. There, we host an editor for TypeScript and Python with two test files to try out the projectional editing.

NOTE: Some features of the editor are only available in VS Code, e.g. customizing the editor your own projections.

Development

For instructions on developing projections and the editor itself, please refer to our wiki, especially the sections "For DSL Developers" and "For Framework Developers".

puredit's People

Contributors

puredit's Issues

Detect blocks reliable and generate templates accordingly

Code blocks are currently not detected reliably in pattern generation.

Detect context variables and generate templates accordingly

Extend projections for PyTorch with context from comments

Extend projections for tensor transformations of PyTorch such that the projections show a preview of the tensors dimension after the transformation

Create projections for PyTorch

Reimplement projection drafts

The feature to generate a draft from a projection was removed during the refactoring of the parser package. It must be reimplemented and extended such that also drafts for the sub-patterns of aggregations and chains can be generated.

Implement matching of chaining

Extend the pattern matching algorithm such that chained function calls can be matched.
Example: obj.my_func("foo").my_other_func(bar)

Implement rendering of aggregation parts

Extend projections for Polars with context from comments

Extend projections for dataframe transformations of Polars such that the projections show a preview of the dataframe's columns after the transformation

Read context from comments

Add an additional optional phase to the pattern matching where context information is read from a comment that is the previous sibling of the actually matching node.

Two forms of context shall be supported:

Lists: CONTEXT: [ value1, value2, ... ]
Key-Value-Pairs: CONTEXT: { key1: value1, key2: value2 }

Implement rendering of chains

Implement matching of aggregations

Currently, every combination of parameters of a function needs to be modelled as a separate projection
Example: df.select(pl.col("foo"), pl.col("bar") + 1, moo="boo", "zoo", ...)
Introduce a new kind of template argument that works similarly to the block node but inside statements.

Refactor the parser package

Refactor the parser package to increase readability and extensibility.

Move projections to separate package

To increase reusability, move the projections to a separate package

Cursor jumps to next line at end of aggregation

If a comma is inserted at the end of an aggregation, the cursor jumps to the next line.

Create projections for Polars

Integrate projectional editors in VS Code

Refactor transformation of matches to decorations

Resolving of template parameters independent of IDs

Currently, template parameters are resolved in the transformation to the pattern tree by their ID and a certain form of identifier which limits strongly restricts the possibilities how to represent template parameters in the code string and also might lead to bugs when a pattern accidentally contains an identifier matching the pattern of the code string representation of parameters.

The template parameters should be resolved by their position (start index, end index) in the code string. This allows free representation of template parameters in the code string.