Skip to content

experiment: rascal formatter based on Box and layoutDiff#2346

Draft
jurgenvinju wants to merge 127 commits intomainfrom
rascal-formatter
Draft

experiment: rascal formatter based on Box and layoutDiff#2346
jurgenvinju wants to merge 127 commits intomainfrom
rascal-formatter

Conversation

@jurgenvinju
Copy link
Member

@jurgenvinju jurgenvinju commented Aug 14, 2025 •
edited
Loading

Rascal is a pretty big language so this pushes the new toBox and format and layoutDiff functions to the max.

  • For now the goal is to formulate toBox rules such that the formatter produces beautiful layout, and
  • We identify bugs and efficiency issues in toBox, format and layoutDiff and fix them immediately.
  • We add box operators with variable argument lists to eliminate a level of superfluous brackets
  • We test for exceptions, parse errors and comment preservation, on all files of the standard library and the larger files in the Compiler and checker.

@codecov
Copy link

codecov bot commented Aug 14, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47%. Comparing base (7cef90d) to head (cca1c89).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##              main   #2346   +/-   ##
=======================================
  Coverage       47%     47%           
- Complexity    6633    6637    +4     
=======================================
  Files          783     783           
  Lines        64759   64754    -5     
  Branches      9695    9690    -5     
=======================================
+ Hits         30737   30757   +20     
+ Misses       31621   31597   -24     
+ Partials      2401    2400    -1

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jurgenvinju jurgenvinju changed the base branch from main to hifi-tree-diff August 14, 2025 10:53
@jurgenvinju jurgenvinju self-assigned this Aug 14, 2025
@jurgenvinju jurgenvinju changed the title experiment: rascal formatted based on Box and layoutDiff experiment: rascal formatter based on Box and layoutDiff Aug 14, 2025
Base automatically changed from hifi-tree-diff to main August 14, 2025 11:37
@toinehartman
Copy link
Member

toinehartman commented Aug 14, 2025

In the spirit of eat your own dog food, I gave it a spin

rascal>formatRascalFile(|file:///c:/Users/toine/swat/projects/Rascal/rascal/src/org/rascalmpl/library/lang/rascal/format/Rascal.rsc|);
|TODO:///|: ParseError(|file:///c:/Users/toine/swat/projects/Rascal/rascal/src/org/rascalmpl/library/lang/rascal/format/Rascal.rsc|(2734,1,<67,73>,<67,74>))

The error is not in the original file:

rascal>parse(#start[Module], |file:///c:/Users/toine/swat/projects/Rascal/rascal/src/org/rascalmpl/library/lang/rascal/format/Rascal.rsc|);
start[Module]: (start[Module]) `@license{
Copyright (c) 2022, NWO-I Centrum Wiskunde & Informatica (CWI)
All rights reserved.
...

I did not investigate further, but it might very well be introduced by our toBox rules.

toinehartman
toinehartman requested changes Aug 15, 2025
View reviewed changes
Copy link
Member

@toinehartman toinehartman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Really cool to test declarative formatting on a mature languge.

I think finding a formatting for Rascal that's commonly agreed on might be controversial...

@toinehartman toinehartman mentioned this pull request Aug 18, 2025
Open
@jurgenvinju
incremental improvements
c648a6a
@jurgenvinju
while and do-while in templates forgotten
6d1060f
@jurgenvinju
formatted two files from the standard library
a3af4f0
@jurgenvinju
Merge remote-tracking branch 'origin/main' into rascal-formatter
e8893e7
@jurgenvinju
spacing in signatures fixed
ca2995f
@jurgenvinju
optimized executeTextEdits from quadratic to linear algorithm
2c215b1
@jurgenvinju
fixed issues with reals that start with a dot
727a604
@jurgenvinju
Merge branch 'main' into rascal-formatter
c9f5175
@jurgenvinju
fixed if-then-else formatter
6ee64b6
@jurgenvinju
fixed rewrite-rule semi-colon attachment
4f979f0
@jurgenvinju
fixed common keyword param spacing
ead9233
@jurgenvinju
fixed default bracket syntax
0af35cd
@jurgenvinju
not flatten the non-associative comparison operators
d37693f
@jurgenvinju
fixing details
b5cf64e
@jurgenvinju
improved lists and sets of tuples
bf0bb8d
@jurgenvinju
improved lists and sets of tuples also for patterns
e474a60
@jurgenvinju
added pattern-replacement-with-when case
2dc71de
@jurgenvinju
rewrote core box constructors from _X to X_ to avoid issue with type …
cca1c89 
…checker #2493
@jurgenvinju
made intercalate and intersperse faster
f320d0e
@jurgenvinju
fixed typo in docs
e0c8a3e
@jurgenvinju
fixed function parameter layout
dcc531d
@jurgenvinju
radical optimization for large table layouts
1510755
@jurgenvinju
fixed #2512
0fc3f9c
@jurgenvinju
debugging
64e93b9
@jurgenvinju
variable becomes formatted
a8399cb
@jurgenvinju
added missing import
2f1bbaa
@jurgenvinju
Merge branch 'main' into rascal-formatter
d4ddf43
@jurgenvinju
Merge branch 'main' into rascal-formatter
06f3ded
@jurgenvinju
Merge branch 'main' into rascal-formatter
6aa8a5d
@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 6, 2026

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@toinehartman toinehartman toinehartman requested changes

Assignees

@jurgenvinju jurgenvinju

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jurgenvinju @toinehartman