bcherny/json-schema-to-typescript

cli: support --bannerComment as file input

Open

#255 opened on Sep 4, 2019

View on GitHub
 (1 comment) (1 reaction) (0 assignees)TypeScript (449 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

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

Description

Currently there is no way how to pass to CLI file with banner ( banners tends to be longer than one line comment )

Current solution:

json2ts -i events.json -o src/Events.ts --bannerComment "$(cat ./banner.txt)"

Proposed feature:

# Will use inline string for banner
json2ts -i events.json -o src/Events.ts --bannerComment '//Hello darnkess my old friend'

# Will use content of file
json2ts -i events.json -o src/Events.ts --bannerComment ./banner.txt

If you're ok with that I can send PR.

Contributor guide

Research direction
Examine CLI argument parsing in src/cli.ts to add a flag that checks if the bannerComment argument starts with './' or '/' and reads the file content with fs.readFileSync; otherwise treat it as inline string.
Tech stack
typescript
Domain
clideveloper 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
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65