feat(resume): support JSON comments

[bennycode]

To make resumed the most convenient resume builder for developers, I implemented support for comments in JSON! 💫

Use-Case:

There are certain properties in my CV that I prefer not to render, so I occasionally comment out less important details. For example:

        {
            "highlights": [
                "Millions of sites use the CDN in production",
                "Larger market share than Yahoo's, Microsoft's and Google's javascript content distribution networks",
                "We serve hundreds of billions request a month",
                "Contains over 3000 popular Javascript libraries",
                "Millions of developers visit the site per year"
            ],
            "description": "Following Google's CDN for jQuery, we decided to start a CDN for the less popular Javascript frameworks. The CDN is community moderated and open source on GitHub. We secured a partnership with Cloudflare who now supports the infrastructure.",
            "website": "http://www.cdnjs.com",
            "name": "Cdnjs",
            "startDate": "2011-01-08"
        }
    ],
    // "languages": [
    //     {
    //         "language": "English",
    //         "fluency": "Native speaker"
    //     }
    // ],

Without my PR, this would break the rendering process:

SyntaxError: Expected double-quoted property name in JSON
at JSON.parse

Using JSON5, we can support JSON that has comments inside. It may also be useful for people who just want to add comments to specific sections.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@9e3e0db). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff            @@
##             main       #18   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?         5           
  Lines           ?        99           
  Branches        ?        15           
========================================
  Hits            ?        99           
  Misses          ?         0           
  Partials        ?         0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rbardini]

I like this! What do you think of using strip-json-comments instead? It simply replaces comments with whitespaces, rather than implementing all JSON5 features, so it's a lot smaller.

[bennycode]

@rbardini I exchanged the JSON5 library and added a test for parsing out a comment :)

[rbardini]

Awesome, thank you!

[github-actions]

🎉 This PR is included in version 4.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀