Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Function names should be in kebab-case #46

Open
yunanwg opened this issue Jul 29, 2024 · 5 comments
Open

Function names should be in kebab-case #46

yunanwg opened this issue Jul 29, 2024 · 5 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone

Comments

@yunanwg
Copy link
Owner

yunanwg commented Jul 29, 2024

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.

@yunanwg yunanwg converted this from a draft issue Jul 29, 2024
@ericthomasca
Copy link
Contributor

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.

@yunanwg
Copy link
Owner Author

yunanwg commented Jul 29, 2024

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
Copy link
Contributor

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

@yunanwg yunanwg added enhancement New feature or request help wanted Extra attention is needed labels Jul 29, 2024
@ericthomasca
Copy link
Contributor

#50

@yunanwg yunanwg moved this from Long Term to Short Term in brilliant-CV Jul 31, 2024
@yunanwg yunanwg added this to the v2.1.0 milestone Aug 5, 2024
@yunanwg yunanwg pinned this issue Aug 5, 2024
@yunanwg yunanwg moved this from Short Term to Long Term in brilliant-CV Aug 11, 2024
@yunanwg
Copy link
Owner Author

yunanwg commented Oct 9, 2024

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

@yunanwg yunanwg self-assigned this Nov 2, 2024
@yunanwg yunanwg moved this from Short Term to Long Term in brilliant-CV Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
Status: Long Term
Development

No branches or pull requests

2 participants