JuliaIO / JuliaIO/JSONSchema.jl

Things to clean up in v2.0

Open
#75 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
40
Forks
12
PR merge metrics
No merged PRs in 30d

Description

Formatting

I can't deal with code that isn't formatted anymore.

Tests

Get back to 100% code coverage (or as near to it as possible). There is currently a bunch of untested code.

Code style

There are many isa when we can use dispatch. Here's one example:

https://github.com/JuliaIO/JSONSchema.jl/blob/3c5bb85319b955ee24d6f0f5bf9f6b942c95eefc/src/schema.jl#L70-L73

I don't know what the point of this part is

https://github.com/JuliaIO/JSONSchema.jl/blob/3c5bb85319b955ee24d6f0f5bf9f6b942c95eefc/src/schema.jl#L302-L304

Surely it's just T <: Integer

Split schema validation and schema generation

There are really two separate things here. The current file is a bit confusing to me

The validation code

v2 has changed how we structure the validation code. I used to use dispatch to separate out each thing in the schema:

https://github.com/JuliaIO/JSONSchema.jl/blob/3e0177448fbf168018306086c851fcbf853af7ec/src/validation.jl#L138-L151

This made it easy to reason about what parts of the schema were covered and not. I think it's a shame to loose that.

Contributor guide

No contributing guide indexed for this repository

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

Read src/schema.jl and src/validation.jl, starting with the linked isa checks and the existing validation structure. Inventory the formatting, coverage, dispatch, and schema-splitting concerns before proposing scope; done requires an agreed design plus corresponding changes and tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
backend-api-design, testing-qa
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.