Escapable list delimiters

Open
#332 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
java
Domain
tooling

Research direction

Start by locating the inline array property parsing and serialization entry points, then inspect how separators are currently stored and read. Compare the proposed doubled-separator behavior with the ambiguity described in the issue, and define unambiguous escaping rules and cases that tests should cover before implementation.

Written by the indexing model from the issue text.

Description

The inline array properties have a separator so that multiple elements can be stored as a simple text, but what if one of those elements needs to have the separator as text? There should be an escaping mechanism. I think the easiest would be to escape separators by doubling them (à la Excel "").
I don't want to use backslashes because the resource's format (like YAML) might already require it to be escaped, and we then have to decide what happens if a backslashes is not followed by the separator.

Edit: Downside to "double-escaping" is if the character appears three times, it's ambiguous which one acts as escaped and which one is a delimiter, respectively under this system, it's impossible to start a string with the delimiter char.

Dominant language
Java
Stars
44
Forks
21
Avg merge
2d 2h
Merged PRs (30d)
3

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.

More from AuthMe/ConfigMe

All issues in AuthMe/ConfigMe

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.