String inline array property - more flavors?

Open
#382 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 with StringType#inlineArrayType and the inline array property type, including the InlineArrayConverter behavior described in the issue. Clarify which string-array flavors and empty-entry rules are wanted, then define the implementation and validation needed for the agreed design.

Written by the indexing model from the issue text.

Description

I've changed the inline array property type to also consider a final empty entry if the string ends with the separator. This is only (really) relevant for the string type, where the following string:

"test
test
" // <-- empty line

previously produced an array ["test", "test"]—now, it produces ["test", "test", ""].

I think this is more consistent. In the scope of this change, though, some general thoughts about the inline array type came up:

  • it would make sense to provide an inline array type implementation for string out of the box that trims entries and ignores empty entries
  • maybe it would be good to have a StringInlineArrayPropertyType extension altogether with a few different flavors
  • how to handle StringType#inlineArrayType? "useTrimAndSpaces" is hard-coded to false at the moment.

Unfortunately, searching over the entirety of GitHub for "InlineArrayConverter" (the pre-ConfigMe 2 name) does not show any usages of the inline array. I have trouble seeing use cases for this type, besides a) if you want to comma-separate a few values and not take too much space in the config file; or rather, b) some file formats don't support collections (like .properties)

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.