microsoft / microsoft/TypeScript
Separate JSX/TSX from React and present it as a general XML-in-JS solution
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
### 🔍 Search Terms
"jsx react", "jsx scope", "jsx generic"
### ✅ Viability Checklist
- [ ] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [ ] This wouldn't change the runtime behavior of existing JavaScript code
- [x] This could be implemented without emitting different JS based on the types of the expressions
- [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
### ⭐ Suggestion
Right now TypeScript's JSX/TSX options are tied to React:
1. This includes `jsx` tsconfig option names (`react`, `react-jsx`, `react-native` and etc.)
2. And TypeScript docs (official docs describe JSX/TSX usage only giving examples for React).
All this creates great confusion and makes new people think that JSX/TSX stuff is ONLY used for React which damages the whole idea of jsx. Yes, it used to be like that from historical point of view, but I think it is time to separate one from another.
The problem is that current option names (and tsconfig docs) are not self-explanatory for someone who never worked with React or front end in general.
I think that jsx has grown enought to have it's own independent standart.
Something like this:
```json
"jsx": {
"mode": "scope" | "import" | "preserve",
"elementTypeStrictness": "strict" | "relaxed",
"elementSpec": "two-argument" | "three-argument",
"elementFactory": "jsx",
"fragmentFactory": "Fragment",
"importSource": "...",
}
```
From that perspective, React will be just one example of how this general feature can be used, **not the only one**!
Of course it also worth mentioning that there is a awaited by many feature request to provide full generic support for jsx nodes instead of widening to `JSX.Element`:
* https://github.com/microsoft/TypeScript/issues/14729
* https://github.com/microsoft/TypeScript/issues/21699
### 📃 Motivating Example
Separating JSX/TSX from React especially on docs level would attract more people to writing their own XML-in-JS languages, instead of using external tools.
### 💻 Use Cases
This is mainly useful for writing content with strict typings and full JS/TS environment support (variables, conditions, functions, comments and etc) — no need to use external Markdown/XML/... parsers.
Consider the following prose example:
```tsx
export const pythagoreanTheorem = (
In any right triangle, the square of the length of the
hypotenuse c is equal to the sum of the squares of
the lengths of the other two sides a and b.
{`
a^2 + b^2 = c^2
`}
The theorem can be visualized as the area of the square
constructed on the hypotenuse being equal to the sum of the
areas of the squares constructed on the other two sides.
This relationship holds true for all right triangles,
regardless of their size or orientation.
The most well-known Pythagorean triple is (3, 4, 5),
where 3^2 + 4^2 = 9 + 16 = 25 = 5^2. Other common
triples include (5, 12, 13) and (8, 15, 17).
);
```
This is not a React code. All these tags are custom functions so we can parse it, detect writing errors on both compile and runtime levels, extract search snippets and do so much stuff! And all this within TypeScript — no external tools needed.
Of course XML-in-JS can be used not only for prose content, but for other structured data, that is easier to express with XML structures other than JS code.
Not to mention how flexible it is — we can save such XML structures to variables, export and import them in different files!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the JSX/TSX tsconfig option names and the official JSX documentation described in the issue, then compare how they are currently tied to React. Done would require an agreed design for independent JSX configuration and corresponding documentation changes; the issue does not name implementation files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react, typescript
- Domain
- compilers, developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100