react/create-react-app

Allow JSON with comments in jsconfig.json

Open

#7426 opened on Jul 25, 2019

View on GitHub
 (15 comments) (0 reactions) (0 assignees)JavaScript (103,386 stars) (27,059 forks)batch import
contributions: claimeddifficulty: mediumgood first issueissue: proposal

Description

Is your proposal related to a problem?

This is a follow-on from #7248. Right now, we don't support JSONC (JSON with comments) in jsconfig.json files.

Describe the solution you'd like

After a discussion with @iansu, we see two paths:

  1. Implement the same solution as we did for TypeScript. This is easy, but would require us making TypeScript a dependency of react-scripts.
  2. The above, but instead of installing typescript as a dependency of react-scripts, we would install it to the user's project if they are using a jsconfig.json file and don't have typescript installed.

Discussion is welcome.

If you're interested in picking this up, please let us know.

Contributor guide

Tech stack
javascripttypescript
Domain
frontendtoolingbuild system
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
mostly clear
Prerequisites
Familiarity with JSONCUnderstanding of jsconfig.jsonKnowledge of React scriptsBasic understanding of TypeScript dependency
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Read the linked issue #7248 to understand previous discussions. Evaluate the two proposed solutions: implementing TypeScript support as done for TypeScript (requires making TypeScript a dependency) or installing TypeScript only for jsconfig users without it. Check if the community has expressed a preference. Look at the current codebase to see how tsconfig.json is handled for TypeScript projects. The issue lacks a final decision, so the contributor should propose a clear plan or seek maintainer input.