Project: sort serialized keys
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 23
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 17
Description
When writing new project.yaml file, I want to ensure that all keys are nicely sorted:
- Always put the
idkey first - Always put the
namekey second - Always put the
openfnkey last - Sort all
openfnandoptionskeys alphabetically - arrays always sorted by id
Should all other keys be alphabetical or arbitrary? I care less about the top object, but its easier to write unit tests if the serialized order is consistent
Also note that no undefined or null values should be written (empty arrays are fine).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named in the issue. Start by locating the code that serializes project.yaml and its existing unit tests; define the key-ordering and omission behavior there, including the unresolved ordering of other top-level keys. Done means serialization is deterministic and excludes undefined or null values while preserving empty arrays.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100