bcherny/json-schema-to-typescript

Support for boolean `required` property at attribute level

Open

#440 opened on Feb 21, 2022

View on GitHub
 (2 comments) (4 reactions) (0 assignees)TypeScript (449 forks)github user discovery
buggood first issuehelp wanted

Repository metrics

Stars
 (3,302 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Currently, only the required array at the top of the object definition will result in non optional attributes. However, json-schema draft does support for required as a boolean at the property level

// test.json

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "required": true
        }
    }
}

CURRENT

interface Test {
  name?: string
}

EXPECTED

interface Test {
  name: string
}

Contributor guide

Research direction
Modify the code that handles required properties to support boolean required at the property level, and ensure it integrates with existing required array logic.
Tech stack
typescript
Domain
toolingdeveloper experience
Issue type
Feature
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptJSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75