bcherny/json-schema-to-typescript

Escape `/*` `*/` in comments

Open

#171 opened on Aug 14, 2018

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

Repository metrics

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

Description

This is sometimes used in comments to refer to some Paths and make Prettier fail, resulting in a log message and an empty file. It would be very handy to be able to escape those.

ex: */foo becoming *\/foo

Contributor guide

Research direction
Find where comment output is generated in the codebase and add escaping for `/*` and `*/` sequences to prevent Prettier from failing. Check the comments generation logic, likely in a renderer or template. Then add a simple string replacement before writing the output.
Tech stack
typescript
Domain
clitooling
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.
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.
70