microsoft / microsoft/TypeScript

Separate JSX/TSX from React and present it as a general XML-in-JS solution

未关闭
#62,721 11 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Awaiting More Feedback Suggestion
主要语言
Go
星标
111k
派生
14.3k
平均合并
2 天 4 小时
30 天内合并 PR
132

描述

🔍 Search Terms

"jsx react", "jsx scope", "jsx generic"

✅ Viability Checklist
⭐ 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:

"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:

📃 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:

export const pythagoreanTheorem = (
  <Term
      title="Pythagorean Theorem"
      direction="row"
      $snippet={{
          search: { synonyms: ['Pythagoras', 'Right Triangle Theorem'] },
          description:
              'Fundamental theorem relating sides of a right triangle',
      }}
  >
      <TermMain>
          <p>
              In any right triangle, the square of the length of the
              hypotenuse <M>c</M> is equal to the sum of the squares of
              the lengths of the other two sides <M>a</M> and <M>b</M>.
          </p>
          <BlockMath>{`
              a^2 + b^2 = c^2
          `}</BlockMath>
      </TermMain>
      <TermSection title="Geometric Interpretation">
          <p>
              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.
          </p>
      </TermSection>
      <TermSection title="Common Examples">
          <p>
              The most well-known Pythagorean triple is <M>(3, 4, 5)</M>,
              where <M>3^2 + 4^2 = 9 + 16 = 25 = 5^2</M>. Other common
              triples include <M>(5, 12, 13)</M> and <M>(8, 15, 17)</M>.
          </p>
      </TermSection>
  </Term>
);

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!

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先检查 JSX/TSX tsconfig 选项名称以及 issue 中所述的官方 JSX 文档,然后比较它们目前与 React 的关联方式。完成这项工作需要就独立的 JSX 配置及相应的文档更改达成一致的设计;该 issue 未指定实现文件或测试。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript, react, typescript
领域
compilers, developer-experience, documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。