chef / chef/mixlib-config

Remove `tomlrb` as a project dependency?

Open Beginner friendly
#116 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Status: Untriaged
Dominant language
Ruby
Stars
54
Forks
36
PR merge metrics
No merged PRs in 30d

Description

Motivation

As a project-author,
I want to skip Tomlrb as a dependency,
so that the number of dependencies of my gem are minimal.

Rationale:

  • My in-house project is fine using YAML or JSON config files.
  • My project already uses an a toml parser other than tomlrb.

Specification

  • remove s.add_dependency "tomlrb" from mixlib-config.gemspec

Downstream Impact

  • Projects that want to use use Toml configs via the build-in from_toml or from_file need to add a dependency on tomlrb by themself.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with mixlib-config.gemspec and inspect the s.add_dependency "tomlrb" declaration. Remove that dependency while keeping the from_toml and from_file functionality available for projects that provide tomlrb themselves; done means the gemspec no longer declares tomlrb.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
build-system
Issue type
Refactor
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.