microsoft/kiota

Name mangling of acronyms

Open

#4,297 opened on Mar 6, 2024

View on GitHub
 (20 comments) (0 reactions) (0 assignees)C# (326 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (3,783 stars)
PR merge metrics
 (PR metrics pending)

Description

The current algorithm for name mangling is(incorrectly?) considering subsequent uppercase characters as separate terms, e.g.:

externalID -> external_i_d as discovered here.

This is a pretty widely adopted pattern in the presence of acronyms. I understand that its an edge case but I think that we should improve the algorithm to handle those use-cases:

externalID -> external_id

the tricky part is in the presence of suffixes(although completely deterministic) where we should make sure this conversion is applied:

IDExternal -> id_external

another possible source of issues is single-character terms:

MeADeveloper -> me_a_developer

I hope I captured all of the invariants, let me know if I'm missing something 🙏

Contributor guide

Research direction
Examine the current name mangling logic in the codebase, specifically how it handles consecutive uppercase characters. Implement a fix to treat acronyms as single terms (e.g., 'externalID' > 'external id') while preserving correct behavior for suffixed cases like 'IDExternal' > 'id external' and single character terms.
Tech stack
csharp
Domain
tooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70