typstfmt icon indicating copy to clipboard operation
typstfmt copied to clipboard

Refactoring starts now

Open astrale-sharp opened this issue 1 year ago • 5 comments

Hey dear followers,

I've started working on the long waited refactor to keep raw blocks and //typstfmt::off to drift right as well as other problems.

This is a complex task and it might take a while but I've started.

In the meantime, I'll post my progress on a branch and will try to keep you all updated!

astrale-sharp avatar Jan 10 '24 17:01 astrale-sharp

This is where I work : https://github.com/astrale-sharp/typstfmt/tree/refactor

It should give you an idea of what the new design will look like. I think it's pretty elegant and not too complex, it should also address the long time issue we've had with raw blocks and typstfmt::off drifting right.

It's likely that existing implementation will be able to be reused in some places.

I started with the documentation to give a global overview of what I have in mind!

astrale-sharp avatar Jan 11 '24 17:01 astrale-sharp

Most of the groundwork is over and I have some decent docs as well, now I would like to have some help for the rest of the details. There are and will be things to do that are accessible to rust beginners and there's many things to be talked about. I'll update contributing to reflect this soon.

I encourage everyone to have a look at the code, and if somethings is not clear, questions you, interests you, you want to fix a todo or indication on how to start helping start a discussion or open an issue or contact me via discord. It would be very helpful I swear, there's so many things to be done and I am but a simple woman.

astrale-sharp avatar Jan 17 '24 13:01 astrale-sharp

Contributors feedback: the refactored code is still very terse and hard to contribute too

I changed my priority due to my professional life taking more of my time lately, so the development is paused for now, I still merge PRs etc

EDIT: should resume working on this in March

astrale-sharp avatar Feb 16 '24 18:02 astrale-sharp

Hey! Just noticed this issue. Are contributions for open issues meant to go into the refactor branch or main branch?

mainrs avatar Apr 21 '24 14:04 mainrs

The main branch, the refactor branch is too raw and honestly, I'm not sure I will be continuing work on this, I'll help maintain the current state but I haven't had motivation to work on this for months now, I'm not really using typst as a regular basis anymore so...

I would encourage yall to take a good look at https://github.com/Enter-tainer/typstyle since it seems quite promising to me

Maybe my typst mania/ formatting mania will come back, but I pretty much moved on from it I think.

astrale-sharp avatar May 08 '24 09:05 astrale-sharp