Consider using more normal casing rules

Open
#56 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
api

Research direction

Search the JavaScript source for the public methods fromBase32hex and windows1252fromString, then identify other method names that apply the same casing pattern. Done means consistently applying the proposed casing rules across the affected API and updating any references or tests that cover those names.

Written by the indexing model from the issue text.

Description

Since I'm filing issues with suggested breaking changes anyway (#55), I thought I'd file this one as well...

It's very confusing for me that this library doesn't follow the usual camelcasing rules of uppercasing every word after the first. (Seen e.g. in standard APIs like Uint16Array.) Instead, it seems to lowercase words if they follow a number. This has led to a number of runtime failures for me and my LLMs as we try to write code against the library.

It would be nice if this library updated its method names, e.g. fromBase32hex -> fromBase32Hex, windows1252fromString -> windows1252FromString, etc.

Dominant language
JavaScript
Stars
18
Forks
7
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from ExodusOSS/bytes

All issues in ExodusOSS/bytes

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.