jskherman / imprecv

A no-frills curriculum vitae (CV) template using Typst and YAML to version control CV data.
Apache License 2.0
319 stars 38 forks source link

refactor #19

Closed mangkoran closed 2 months ago

mangkoran commented 7 months ago

WIP. I decided to do some refactor of the codebase so it looks more neat (IMO). Apparently it will solve https://github.com/jskherman/cv.typ/pull/1#issuecomment-1910896918 #9, #10 but not yet for now.

Current state/commit is on parity with master (no failed compilation).

Please let me know if you have any suggestions.

mangkoran commented 7 months ago

Alright I think it's now ready for review. No issue so far on my end. I think we need to update the JSON schema too as we made some fields optional, but I will revisit it later. Please let me know if you have any suggestions.

Friendly mention @jskherman @kyawzazaw @phamson02

mangkoran commented 7 months ago

I also have an idea to split input files/YAML for sensitive data such as phone number, email, location etc. So we could track the other input file while keeping the sensitive data locally. What do you think about it?

jskherman commented 6 months ago

I also have an idea to split input files/YAML for sensitive data such as phone number, email, location etc. So we could track the other input file while keeping the sensitive data locally. What do you think about it?

Hm, technically you could consider all of the data in a résumé or CV sensitive data. Also, it might get a bit too unwieldy to have the data scattered in different YAML files. To illustrate, my current use case involves using different YAML files slightly altered from a main YAML file (used in the CV) to create one/two-page résumés that are tailored to a specific job description or role. For me, having one YAML file per document makes it easier to diff these customized "versions".

mangkoran commented 4 months ago

Hi @jskherman I apologize for the late reply as I am busy with with IRL. Originally this PR should be opened as a draft PR as it still need some rework. And thank you for leaving suggestions.

However, I'm planning to do some additional refactor to comply with Typst's template format. I think I will still use this PR for that.

mangkoran commented 4 months ago

Suggestions committed. Could you please recheck whether it's what you requested?

Meanwhile I will continue to update the project structure to match template format.

jskherman commented 2 months ago

Hi @mangkoran, sorry for only getting back to you at this time since I had a big exam to prepare for in the past few months... I'm sorry to spring this on you only now after you have done a lot of work on this PR. But I was thinking of closing this PR and doing a double check on the code base as a whole for consistency (including reacquainting myself with the code after being away for a while) and, while at it, convert the setup to use the new system for templates in the Typst Universe. To be honest, it also feels rather daunting to review such a huge PR since I'm only coding as a hobby (skill issue, I know). I'm quite thankful though for the amount of work you put into this.