gazebosim / gazebosim/sdformat

Consider using Ignition Common's Console

Open
#351 6 comments 1 reaction 0 assignees View on GitHub
Dominant language
C++
Stars
216
Forks
125
Avg merge
1d 14h
Merged PRs (30d)
14

Description

libSDFormat's [Console](https://github.com/osrf/sdformat/blob/master/include/sdf/Console.hh) class provides a lot of the same functionality as [ignition::common::Console](https://github.com/ignitionrobotics/ign-common/blob/master/include/ignition/common/Console.hh).

The same way that SDF's custom math types were deprecated in favor of Ignition Math types (https://github.com/osrf/sdformat/issues/91), I think it could be beneficial to deprecate SDF's custom console to reduce duplication from Ignition. Ignition Common's core component shouldn't bring any new dependencies to SDFormat, I believe it's largest dependencies are `ign-math` and `tinyxml2`.

Contributor guide

Open the contributing guide

Research direction

Compare libSDFormat's Console class in include/sdf/Console.hh with ignition::common::Console in the linked Ignition Common header. Start by reviewing the existing console APIs and the dependency concerns described in the issue. Done would require a decided, scoped deprecation and migration plan, including its dependency impact.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.