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

Change toml parsing library to use tomlkit #231

Closed
tarkatronic opened this issue Oct 19, 2021 · 2 comments · Fixed by #234
Closed

Change toml parsing library to use tomlkit #231

tarkatronic opened this issue Oct 19, 2021 · 2 comments · Fixed by #234
Labels
enhancement New feature or request good first issue Good for newcomers Hacktoberfest
Milestone

Comments

@tarkatronic
Copy link
Contributor

Currently tartufo uses the toml library for our parsing. This has worked great until now, but we are starting to reach the limits of the library. And unfortunately, it seems to be unmaintained currently. The last commit to the library was in October 2020, and I have encountered a bug (uiri/toml#270) which could impede our progress on future features.

tomlkit, on the other hand, is actively maintained by sdispater, the primary author/maintainer of the Poetry project. In fact, it is the TOML parser used for Poetry itself. So we can be assured that it will remain stable. In addition, we will be able to use this library in the future for writing back to the configuration file while preserving all pre-existing style, structure, etc!

@tarkatronic tarkatronic added enhancement New feature or request good first issue Good for newcomers Hacktoberfest labels Oct 19, 2021
@tarkatronic tarkatronic added this to the Version 3.0 milestone Oct 19, 2021
@ErikOwen
Copy link
Contributor

Hi @tarkatronic, can I take this issue?

@tarkatronic
Copy link
Contributor Author

Hi @ErikOwen! That would be great, thank you for volunteering!

I will warn you up front, this is a pretty high priority change for us, so I may have to yank it back if you're unable to make progress in the next couple of weeks. But, as long as you have the time and bandwidth, I would absolutely welcome the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers Hacktoberfest
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants