appc/spec

actool: provide more useful error messages when linting manifest

Open

#263 opened on Mar 25, 2015

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Go (143 forks)github user discovery
help wantedkind/enhancement

Repository metrics

Stars
 (1,253 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

When linting a manifest with a stray comma the following error message was displayed:

build: Layout failed validation: image manifest validation failed: invalid character '}' looking for beginning of object key string

For someone attempting to debug this there isn't really usable information like:

Line numbers Potential solutions Human language

In the end I just ended up going to http://jsonlint.com where i got the following feedback:

Parse error on line 25:
...1000",            },    "annotations"
---------------------^
Expecting 'STRING'

While even their error message was incorrect, this identified the issue and allowed for a quick resolution.

Contributor guide

Research direction
Investigate the manifest linting code to identify where JSON parsing errors occur and enhance error messages with line numbers and human readable suggestions.
Tech stack
go
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoJSON
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75