mintyfrankie / brilliant-CV

💼 another CV template for your job application, yet powered by Typst and more
https://typst.app/universe/package/brilliant-cv
Apache License 2.0
469 stars 28 forks source link

Function names should be in kebab-case #46

Open mintyfrankie opened 4 months ago

mintyfrankie commented 4 months ago

This project was created long before when Typst starts to recommend kebab-case function and variable names. A total refactoring will mean that users will have to accept enormous breaking changes and replace everything manually in their existing project.

We have to evaluate the cost and benefit of this.

ericthomasca commented 4 months ago

I can work on a refactor in a branch and see how much change is needed for the end user. A script and/or instructions could be added for the renaming needed.

mintyfrankie commented 4 months ago

That would be great. I've been working on a branch refactor-lib to do some housekeeping on internal function logics, etc. There were some legacies to bypass/hack the Typst compiler back in the good old days.

You might want to work on that branch if you want, that can be shipped with version 2.1.0. However I believe there will be a lot to rename, for example cv-entry instead of cvEntry, cv-section instead of cvSection, etc.

ericthomasca commented 4 months ago

I'll make a fork from that branch and create a pull request with the refractors.

ericthomasca commented 4 months ago

50

mintyfrankie commented 1 month ago

An official CLI tool to check on these: https://github.com/typst/package-check