Skip to content

Conversation

@Lab3ss
Copy link
Collaborator

@Lab3ss Lab3ss commented Jul 21, 2025

Summary by CodeRabbit

  • New Features

    • Added validation support for resume fields, including interests, languages, references, and skills.
    • Enhanced the Resume structure to support field validation and made the "basics" section optional.
  • Documentation

    • Expanded the README with detailed usage instructions and examples for validating JSON Resume data in Rust.
  • Tests

    • Introduced tests to verify correct validation behavior for valid and invalid resume data.
  • Chores

    • Updated the package name to "json-resume-serde" for improved clarity.

@coderabbitai
Copy link

coderabbitai bot commented Jul 21, 2025

## Walkthrough

The changes update the crate name in Cargo.toml, expand the README with usage and validation instructions, and enhance the `Resume` struct and its related types to support validation using the `serde_valid` crate. The `Resume` struct's `basics` field is now optional, and validation attributes are added throughout. New validation tests are introduced.

## Changes

| File(s)                                      | Change Summary                                                                                      |
|----------------------------------------------|-----------------------------------------------------------------------------------------------------|
| Cargo.toml                                   | Package name changed from `json-resume` to `json-resume-serde`.                                     |
| README.md                                    | Expanded with usage instructions and validation examples using `serde_valid`.                       |
| src/resume.rs                                | `basics` field made optional; `#[validate]` added to all fields; new tests for validation added.    |
| src/resume/interest.rs<br>src/resume/language.rs<br>src/resume/reference.rs<br>src/resume/skill.rs | Added `Validate` trait derive to `Interest`, `Language`, `Reference`, and `Skill` structs.          |

## Sequence Diagram(s)

```mermaid
sequenceDiagram
    participant User
    participant Resume
    participant serde_valid

    User->>Resume: Construct or deserialize Resume instance
    User->>Resume: Call .validate()
    Resume->>serde_valid: Perform validation on all fields
    serde_valid-->>Resume: Return validation result
    Resume-->>User: Success or validation errors

Estimated code review effort

3 (30–60 minutes)

Possibly related PRs

  • jsonresume/rust-json-resume#2: Also introduces validation traits and custom validators for resume components, closely related as both PRs enhance validation capabilities.

Poem

In the meadow of code, the resume grows,
With validation now, each field clearly shows.
Skills, interests, languages, all checked anew,
Serde and tests join the bunny crew!
🐇 Hopping along, our crate gets a name,
Rusty and robust, never the same!


<!-- walkthrough_end -->


---

<details>
<summary>📜 Recent review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
**Plan: Pro**


<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between d76f6fbc06236ba9abdf5504c38091bc62c15a9c and da1249554530c037881c94245191f8e2032e8d02.

</details>

<details>
<summary>⛔ Files ignored due to path filters (1)</summary>

* `Cargo.lock` is excluded by `!**/*.lock`

</details>

<details>
<summary>📒 Files selected for processing (7)</summary>

* `Cargo.toml` (1 hunks)
* `README.md` (1 hunks)
* `src/resume.rs` (1 hunks)
* `src/resume/interest.rs` (1 hunks)
* `src/resume/language.rs` (1 hunks)
* `src/resume/reference.rs` (1 hunks)
* `src/resume/skill.rs` (1 hunks)

</details>

<details>
<summary>✅ Files skipped from review due to trivial changes (1)</summary>

* src/resume/skill.rs

</details>

<details>
<summary>🚧 Files skipped from review as they are similar to previous changes (6)</summary>

* Cargo.toml
* README.md
* src/resume/reference.rs
* src/resume/language.rs
* src/resume/interest.rs
* src/resume.rs

</details>

</details>
<!-- internal state start -->


<!-- DwQgtGAEAqAWCWBnSTIEMB26CuAXA9mAOYCmGJATmriQCaQDG+Ats2bgFyQAOFk+AIwBWJBrngA3EsgEBPRvlqU0AgfFwA6NPEgQAfACgjoCEejqANiS5pa9GolzJ8WCtOxtIEtBfi1q8C4GAHIeApRcACwGAKqIEZAAMioAzIiIRvrG4FBk9PgAZjgExGTKNPRMrOxcvPzCouJSMvJMSlSq6lo6WSZQcKiomMWEpORUFQrVGJyQVADukIgezGgU8nIK7Spqmtq6YIbZpgYAwmtE+BoEzBYcBgBETwYAxC+QAIIAkqXj1HRLFZreSFRiwTCkDIGOAkHhoBgAazQpEgGDQnngWFwsFh5wol2uLAskAK8CskHmaGQDHBGFI9AKFBYkAeQkQLjAbmWbAekAILLZHK5HhIYHiFCUDw0kGC+H42MokGYingpIYARcyH5UgoiECGAANJA6Op9Ub8HwlNw8mQGPBpBTKLDVkoNEY3p8LDQJvqtXKFZAlAwLGsNRhnEUSAAPbgWyYWnjYAS+BjGmam6SZSAABXhSJRaM8NIhAMZzIABoKMJz3Gxy3y5ZX2dXhWwxZQlPXMZBy3iCTcLOXHs8DBAwEYAEoAUQ+ABEALJTjTMWj3J4PV7vb6/coA7mrdb8IrFumZ6E4yDTueLilU40xzBKexyzHB7BKSDYRDI2GYxwUbAxF9QMSGVcNcB9OlIFgfBFm1Hw/H+SAACkAGUAHlgkvWtYX8XA0E/PUoIDctxSUAB9bxfFoesGAmEhpS+XBUVg+9uBTSx5Ecf4tXBZiAwnL9mPgZh2NA9gw0BbhYwoJxIAEfBsUgVCO1hcV4AQgAvMMAHolHUrTJMfLwELw/VpWgeY5S/H973RMTkHmJ10DsOguBcNSYPmTEiBM6jJNBAj9MoDTfE0gFywnHD60EEQxApdQECwYYqVkDAaSZDB8C/T4ow8aDHysCgjWMzBFJxPgyQsITIN81YMGwHwFHAgCgJcI90B7KLuRIet/0A5iCnwCwLFggFNioxDxBcCyL2jeyrGQUDuHBPVwsYHxfCg8sNEmvCSAACgAShirEL0i6KUHAzAGFhflrQoIaKGYJYaVAgi9rDaVZTBEtHOcl07rlaMkHEKD9Lo+BuGm8N+D4FMyHiK6ntWGG3SMTdPW9MM/T5C8gxDH1NQ66MZPjPhuCTFM03EcQz1lch0anRwRP+SpFFhNwJHtRYSAKJ7ZkSWDhw3UcTkQCgGB01sGN1Ndng9bcxl3eh92BDqT0hMxzu6kU+oggaAHJkHLAQqXgBhEHrUkSAsehKWpWl6RJJkXoI+q8IteRywAIXNy361wWRrQbdAsHwaH9Sa8t0MjlxgD9vVLb0QPg5IEqMHsc6XgAbU+mgAF162oCD4AEPBYQdlyn1DzaSXtO3ECNV9qtoHyezNpOrbD+g66kMQLQjeUKrmHCpljcgZibtMVC23z8/1fhw7jtFiWMpgRsaRebcb6UPlREg4OkZjlVobBySr2wa+8pTcCsvlj8QdzyC8EKClkdvsWoTq9q6y6/3wulSuiVOq8AjpQCw8gUYRUThbbu3AqTxGQAvFwGde5ZQVHwHUqoP7ET4p1C6PV6w31gGHK6v93pkiuj2WBAcSTaAsMg0yX0YAXgcHJUmHFcCQOav1eKhC9ZXW4kAxyIDvAUECDlHe9AqLYAdKVdIlB+IXiYBQNwYhyDpA6gGFBrh3BekQOjd0W4vTlGAvyAMBNQwwyHqTOMAIEyU2TBbGmGYoRQAAGIN3sGnX6p5Vwd39t3bsfDmICLrC7CstDu78hjivBOQSU7UNIpLaWOENC6iHFAcsud84kCLugXApdy40GrgCfkddpFD1CX/IhySJZSxlhkq2o4ZSHwfo4JUihz6wnLOw7uV8ATdhSY09JmTmr4UxD5e4kBdAwGPiSbA6UYY9nYeRGWlFmEw2OkOWZ/QFkFCWW1LAfTj7rJwps/yMNyKYj2jsowzNxCowBG0TmJBubtL5gLLg84TQeBFpkcWqSZY6UxN6Y+zT5YbkVj8ZW9FVZAkPKCTWZ4YQ9i+DMJ0jh9atWEichpaSeqgsxVyTQ4zVryRIGQT83B9rPium+D8JEABqWzep8ioOoSJL0SJkRIJcvwtF6KzVQCi6uvFemsquey9okhnTwiZKHAMoSjRkFnu3XRG0EFqF8HTZAPgXBED1B+EGLMoIGTCkZTOIELXwG0isw5yyo66tkOjRWpiiawwsfjUQhMcYkxjPY/IFMqYuPYG4rMaLywYvBdipYBt4rDIJSCsFWKyXdwpcMbAtK2YgQkVIQpxSK5cDLC9HJOdZVSAOrOEg5ciBGhUhIrS6dIA1tteFI6BTYm50rYdGtdaG0hWbUaNtQ6wotqlVNEgnadoPJZs89mH4uY82NPzOMPy/nMABWLccBhk04R0iGOkjVSCQoBTCnc8LASsHVsip2qLzrJGPT+HFA16nAoPUeogJ7ZYZrvOEal2a6Whxbu+O651J37UDpywars8a9L5QKmijBhWsNFfe8VfkpqL3VNqskbilUXhqZsStn8INsug9oZiBq6TGvA7CU1YNfLln7dgIg5YjTlkbaFO1vU0E9lHU28dlH1CGJlHKcqipT6qgtv671akE2DW8c4eG+AiAuKcm4JUtgGLGKxmY4m8mQLBmscBUEdjZIOJDc41M4a9WRsfRCH9r7E34o/USr9P7mnELvEB3N/Je3wZ7JB/4Im8XV1NO1WJrH2Oce482jjPcBPSDHbx2d65AW7v3UStwBQnRALPRli9cLc1qyRcee9UIo1RTy24IBLnmJZUWL2iVwWKMcqo9yoLpFVJIaFUhbsV9ItYn9HNKMoN24sdrWxxLXHUvhUS8ZKb7b2UQSo2JgYjsSwz2TA6TVuGVD4b1UvIRgDbpDwurV207KSHZWox69uon6621oCp+D8A+BB2tIYvTHwPVydG7hX1pnibmcDZZ4NiYbOuPs606rfN8u3Qa++0ZOWEd1dut5gq+qsB+cmIFkuEiSnWBQI11iLW2vSq7MlOww3Q5TbrbN+Lwn+PLfm71N0GWd1GGyyKHSiAERVUKwrLcsKyhXrKyCCrf1ta9NQoLkayOk3ub5wLoX5L/1UtxzmyYAWQoFpZe1tbXLS3dcQ3tfrNARWOTvLQDy8l5BDe2l+NSvW9ocA4CFmgABuYu1rQNt22l79l3ZLH6/lXROUT0guhO+hJzBfjISEYU7i57jc4aQFGup1Mmn5WugxpjP72MbHJ+M36kvYOyZWah9TOz9p3GsLlwrwc8bU/K9R6r5vWOmt5rla18swewvUKGys6L03Ys9mZ2l1ngmeMLaZvO3NrzR4fN5mu2SXAhbzG3VkAwfQ0z5CKGgPAoxxdL5YGwGYXAFjXoPBsVoHMOi7G6AcQw++qjMHUDc175zV90HItxLJK/scFALQAAOwABsBQUBAgDAAADBAQAEwpAQFmwACcKgtABQAArNgXAZEAwCkAABxwFoEACMsBSBDAZB2BaAaBqYvQOQgYaAZBiBkQaBuBkQ2BKQcB8BKQYBRBRBZBDAaBkQbB2BZB5BBQRBJAiBcBKQiBJARBtAcBiBwBe+TBH+X+fgiAv+PM/+eQr+QAA -->

<!-- internal state end -->
<!-- finishing_touch_checkbox_start -->

<details>
<summary>✨ Finishing Touches</summary>

- [ ] <!-- {"checkboxId": "7962f53c-55bc-4827-bfbf-6a18da830691"} --> 📝 Generate Docstrings
<details>
<summary>🧪 Generate unit tests</summary>

- [ ] <!-- {"checkboxId": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "radioGroupId": "utg-output-choice-group-unknown_comment_id"} -->   Create PR with unit tests
- [ ] <!-- {"checkboxId": "07f1e7d6-8a8e-4e23-9900-8731c2c87f58", "radioGroupId": "utg-output-choice-group-unknown_comment_id"} -->   Post copyable unit tests in a comment
- [ ] <!-- {"checkboxId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "radioGroupId": "utg-output-choice-group-unknown_comment_id"} -->   Commit unit tests in branch `test_resume_validation`

</details>

</details>

<!-- finishing_touch_checkbox_end -->
<!-- tips_start -->

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

<details>
<summary>❤️ Share</summary>

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai)
- [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai)
- [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai)
- [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

</details>

<details>
<summary>🪧 Tips</summary>

### Chat

There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=jsonresume/rust-json-resume&utm_content=4):

- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  - `I pushed a fix in commit <commit_id>, please review it.`
  - `Explain this complex logic.`
  - `Open a follow-up GitHub issue for this discussion.`
- Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples:
  - `@coderabbitai explain this code block.`
  -	`@coderabbitai modularize this function.`
- PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.`
  - `@coderabbitai read src/utils.ts and explain its main purpose.`
  - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.`
  - `@coderabbitai help me debug CodeRabbit configuration file.`

### Support

Need help? Create a ticket on our [support page](https://www.coderabbit.ai/contact-us/support) for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

### CodeRabbit Commands (Invoked using PR comments)

- `@coderabbitai pause` to pause the reviews on a PR.
- `@coderabbitai resume` to resume the paused reviews.
- `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
- `@coderabbitai full review` to do a full review from scratch and review all the files again.
- `@coderabbitai summary` to regenerate the summary of the PR.
- `@coderabbitai generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR.
- `@coderabbitai generate sequence diagram` to generate a sequence diagram of the changes in this PR.
- `@coderabbitai generate unit tests` to generate unit tests for this PR.
- `@coderabbitai resolve` resolve all the CodeRabbit review comments.
- `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository.
- `@coderabbitai help` to get help.

### Other keywords and placeholders

- Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed.
- Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description.
- Add `@coderabbitai` anywhere in the PR title to generate the title automatically.

### CodeRabbit Configuration File (`.coderabbit.yaml`)

- You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository.
- Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json`

### Documentation and Community

- Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

</details>

<!-- tips_end -->

@Lab3ss Lab3ss force-pushed the test_resume_validation branch from d76f6fb to da12495 Compare July 21, 2025 07:47
@Lab3ss Lab3ss merged commit 24f7da2 into main Jul 21, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants