microsoft / TypeScript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
https://www.typescriptlang.org
Apache License 2.0
99.15k stars 12.3k forks source link

Allow non-identifiers to be used for JSXFragmentFactory #41400

Open brainkim opened 3 years ago

brainkim commented 3 years ago

Search Terms

JSX factory expression identifier string JSXFragmentFactory

Related Issues

https://github.com/Microsoft/TypeScript/issues/20469 https://github.com/microsoft/TypeScript/pull/38720

Suggestion

Allow non-identifiers to be used as the JSXFragmentFactory. Currently, attempting to use a non-identifier like the empty string results in the following error:

  tsconfig.json(9,27): error TS18035: Invalid value for 'jsxFragmentFactory'. '''' is not a valid identifier or qualified-name.

My config:

{
  "include": ["src", "types"],
  "compilerOptions": {
    "module": "esnext",
    "target": "esnext",
    "moduleResolution": "node",
    "jsx": "preserve",
    "jsxFactory": "createElement",
    "jsxFragmentFactory": "''",
    "lib": ["esnext", "dom"],
    "baseUrl": "./",
    /* paths - If you configure Snowpack import aliases, add them here. */
    "paths": {},
    /* noEmit - Snowpack builds (emits) files, not tsc. */
    "noEmit": true,
    /* Additional Options */
    "strict": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "resolveJsonModule": true,
    "allowSyntheticDefaultImports": true,
    "importsNotUsedAsValues": "error"
  }
}

Use Cases

My JSX framework defines the Fragment tag as the empty string. Babel’s JSX support allows non-identifiers to be used as the JSXFragmentFactory so I wonder why we can’t do the same in TypeScript.

Using an identifier is a little more awkward.

Examples

With the jsxFactory set to createElement and the jsxFragmentFactory set to the empty string, emitted code might look like the following.

createElement(
  "",
  null,
  createElement("div", null),
  createElement("div", null),
);

Checklist

My suggestion meets these guidelines:

nojvek commented 3 years ago

@brainkim I'm one of the authors that landed non-react custom jsxFactory compiler option. I'm not sure what effort it would take to get "", but null totally works and has a test case in the repo.,

you can do jsxFragmentFactory: "null", and use that in your custom createElement to decide between a fragment and an actual tag.

It's used by snabbdom-jsx-lite https://github.com/nojvek/snabbdom-jsx-lite/blob/master/tsconfig.json#L8

brainkim commented 3 years ago

@nojvek Ah I should have figured that null would have been supported; I just assumed it would be generalized to any literal value, and went ahead and made the Fragment tag the empty string.

The relevant PR is pretty informative about how this works, I’ll try to look through it soon.