microsoft / microsoft/TypeScript

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

Aperta
#62,721 11 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

🔍 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!

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando i nomi delle opzioni tsconfig di JSX/TSX e la documentazione ufficiale di JSX descritta nell’issue, quindi confronta il modo in cui sono attualmente collegati a React. Il lavoro sarà considerato completato quando sarà stato concordato un design per una configurazione JSX indipendente e per le relative modifiche alla documentazione; l’issue non indica file di implementazione o test.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, react, typescript
Ambito
compilers, developer-experience, documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.