readmeio / readmeio/swagger-inline

Adding support for tabs when defining arrays using hyphen character

Open
#319 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
JavaScript
Stars
142
Forks
37
PR merge metrics
No merged PRs in 30d

Description

Related to #251. Tab characters are misinterpreted when included in arrays which are defined with a hyphen.

Works with spaces:
Screenshot_20240515_083952

With tabs results in Error: YAMLException: bad indentation of a sequence entry:
Screenshot_20240515_084217

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.

Research direction

Reproduce the YAMLException with tab-indented arrays defined using hyphens, then compare it with the space-indented example. Done means tab characters in these arrays are accepted without the bad indentation error; the issue does not name a file or test to update.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.