Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix TS import elision for JSX fragments and custom pragmas #403

Merged
merged 1 commit into from
Jan 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/CJSImportProcessor.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import {Options} from "./index";
import NameManager from "./NameManager";
import {isDeclaration} from "./parser/tokenizer";
import {ContextualKeyword} from "./parser/tokenizer/keywords";
Expand Down Expand Up @@ -40,6 +41,7 @@ export default class CJSImportProcessor {
readonly nameManager: NameManager,
readonly tokens: TokenProcessor,
readonly enableLegacyTypeScriptModuleInterop: boolean,
readonly options: Options,
) {}

getPrefixCode(): string {
Expand Down Expand Up @@ -97,7 +99,7 @@ export default class CJSImportProcessor {
* bare imports.
*/
pruneTypeOnlyImports(): void {
const nonTypeIdentifiers = getNonTypeIdentifiers(this.tokens);
const nonTypeIdentifiers = getNonTypeIdentifiers(this.tokens, this.options);
for (const [path, importInfo] of this.importInfoByPath.entries()) {
if (
importInfo.hasBareImport ||
Expand Down
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ function getSucraseContext(code: string, options: Options): SucraseContext {
nameManager,
tokenProcessor,
enableLegacyTypeScriptModuleInterop,
options,
);
importProcessor.preprocessTokens();
// We need to mark shadowed globals after processing imports so we know that the globals are,
Expand Down
4 changes: 3 additions & 1 deletion src/transformers/ESMImportTransformer.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import {Options} from "../index";
import NameManager from "../NameManager";
import {ContextualKeyword} from "../parser/tokenizer/keywords";
import {TokenType as tt} from "../parser/tokenizer/types";
Expand All @@ -18,10 +19,11 @@ export default class ESMImportTransformer extends Transformer {
readonly nameManager: NameManager,
readonly reactHotLoaderTransformer: ReactHotLoaderTransformer | null,
readonly isTypeScriptTransformEnabled: boolean,
options: Options,
) {
super();
this.nonTypeIdentifiers = isTypeScriptTransformEnabled
? getNonTypeIdentifiers(tokens)
? getNonTypeIdentifiers(tokens, options)
: new Set();
}

Expand Down
39 changes: 13 additions & 26 deletions src/transformers/JSXTransformer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import NameManager from "../NameManager";
import XHTMLEntities from "../parser/plugins/jsx/xhtml";
import {TokenType as tt} from "../parser/tokenizer/types";
import TokenProcessor from "../TokenProcessor";
import getJSXPragmaInfo, {JSXPragmaInfo} from "../util/getJSXPragmaInfo";
import RootTransformer from "./RootTransformer";
import Transformer from "./Transformer";

Expand All @@ -14,10 +15,7 @@ export default class JSXTransformer extends Transformer {
lastLineNumber: number = 1;
lastIndex: number = 0;
filenameVarName: string | null = null;
readonly jsxPragmaBase: string;
readonly jsxPragmaSuffix: string;
readonly jsxFragmentPragmaBase: string;
readonly jsxFragmentPragmaSuffix: string;
readonly jsxPragmaInfo: JSXPragmaInfo;

constructor(
readonly rootTransformer: RootTransformer,
Expand All @@ -27,20 +25,7 @@ export default class JSXTransformer extends Transformer {
readonly options: Options,
) {
super();
[this.jsxPragmaBase, this.jsxPragmaSuffix] = this.splitPragma(
options.jsxPragma || "React.createElement",
);
[this.jsxFragmentPragmaBase, this.jsxFragmentPragmaSuffix] = this.splitPragma(
options.jsxFragmentPragma || "React.Fragment",
);
}

private splitPragma(pragma: string): [string, string] {
let dotIndex = pragma.indexOf(".");
if (dotIndex === -1) {
dotIndex = pragma.length;
}
return [pragma.slice(0, dotIndex), pragma.slice(dotIndex)];
this.jsxPragmaInfo = getJSXPragmaInfo(options);
}

process(): boolean {
Expand Down Expand Up @@ -219,21 +204,23 @@ export default class JSXTransformer extends Transformer {
}

processJSXTag(): void {
const {jsxPragmaBase, jsxPragmaSuffix, jsxFragmentPragmaBase, jsxFragmentPragmaSuffix} = this;
const {jsxPragmaInfo} = this;
const resolvedPragmaBaseName = this.importProcessor
? this.importProcessor.getIdentifierReplacement(jsxPragmaBase) || jsxPragmaBase
: jsxPragmaBase;
? this.importProcessor.getIdentifierReplacement(jsxPragmaInfo.base) || jsxPragmaInfo.base
: jsxPragmaInfo.base;
const firstTokenStart = this.tokens.currentToken().start;
// First tag is always jsxTagStart.
this.tokens.replaceToken(`${resolvedPragmaBaseName}${jsxPragmaSuffix}(`);
this.tokens.replaceToken(`${resolvedPragmaBaseName}${jsxPragmaInfo.suffix}(`);

if (this.tokens.matches1(tt.jsxTagEnd)) {
// Fragment syntax.
const resolvedFragmentPragmaBaseName = this.importProcessor
? this.importProcessor.getIdentifierReplacement(jsxFragmentPragmaBase) ||
jsxFragmentPragmaBase
: jsxFragmentPragmaBase;
this.tokens.replaceToken(`${resolvedFragmentPragmaBaseName}${jsxFragmentPragmaSuffix}, null`);
? this.importProcessor.getIdentifierReplacement(jsxPragmaInfo.fragmentBase) ||
jsxPragmaInfo.fragmentBase
: jsxPragmaInfo.fragmentBase;
this.tokens.replaceToken(
`${resolvedFragmentPragmaBaseName}${jsxPragmaInfo.fragmentSuffix}, null`,
);
// Tag with children.
this.processChildren();
while (!this.tokens.matches1(tt.jsxTagEnd)) {
Expand Down
1 change: 1 addition & 0 deletions src/transformers/RootTransformer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ export default class RootTransformer {
this.nameManager,
reactHotLoaderTransformer,
transforms.includes("typescript"),
options,
),
);
}
Expand Down
22 changes: 22 additions & 0 deletions src/util/getJSXPragmaInfo.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import {Options} from "../index";

export interface JSXPragmaInfo {
base: string;
suffix: string;
fragmentBase: string;
fragmentSuffix: string;
}

export default function getJSXPragmaInfo(options: Options): JSXPragmaInfo {
const [base, suffix] = splitPragma(options.jsxPragma || "React.createElement");
const [fragmentBase, fragmentSuffix] = splitPragma(options.jsxFragmentPragma || "React.Fragment");
return {base, suffix, fragmentBase, fragmentSuffix};
}

function splitPragma(pragma: string): [string, string] {
let dotIndex = pragma.indexOf(".");
if (dotIndex === -1) {
dotIndex = pragma.length;
}
return [pragma.slice(0, dotIndex), pragma.slice(dotIndex)];
}
17 changes: 15 additions & 2 deletions src/util/getNonTypeIdentifiers.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
import {Options} from "../index";
import {IdentifierRole} from "../parser/tokenizer";
import {TokenType, TokenType as tt} from "../parser/tokenizer/types";
import TokenProcessor from "../TokenProcessor";
import {startsWithLowerCase} from "../transformers/JSXTransformer";
import getJSXPragmaInfo from "./getJSXPragmaInfo";

export function getNonTypeIdentifiers(tokens: TokenProcessor): Set<string> {
export function getNonTypeIdentifiers(tokens: TokenProcessor, options: Options): Set<string> {
const jsxPragmaInfo = getJSXPragmaInfo(options);
const nonTypeIdentifiers: Set<string> = new Set();
for (let i = 0; i < tokens.tokens.length; i++) {
const token = tokens.tokens[i];
Expand All @@ -17,8 +20,18 @@ export function getNonTypeIdentifiers(tokens: TokenProcessor): Set<string> {
) {
nonTypeIdentifiers.add(tokens.identifierNameForToken(token));
}
if (token.type === tt.jsxTagStart) {
nonTypeIdentifiers.add(jsxPragmaInfo.base);
}
if (
token.type === tt.jsxTagStart &&
i + 1 < tokens.tokens.length &&
tokens.tokens[i + 1].type === tt.jsxTagEnd
) {
nonTypeIdentifiers.add(jsxPragmaInfo.base);
nonTypeIdentifiers.add(jsxPragmaInfo.fragmentBase);
}
if (token.type === tt.jsxName && token.identifierRole === IdentifierRole.Access) {
nonTypeIdentifiers.add("React");
const identifierName = tokens.identifierNameForToken(token);
// Lower-case single-component tag names like "div" don't count.
if (!startsWithLowerCase(identifierName) || tokens.tokens[i + 1].type === TokenType.dot) {
Expand Down
4 changes: 3 additions & 1 deletion test/identifyShadowedGlobals-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ function assertHasShadowedGlobals(code: string, expected: boolean): void {
const tokenProcessor = new TokenProcessor(code, file.tokens, false);
const nameManager = new NameManager(tokenProcessor);
nameManager.preprocessNames();
const importProcessor = new CJSImportProcessor(nameManager, tokenProcessor, false);
const importProcessor = new CJSImportProcessor(nameManager, tokenProcessor, false, {
transforms: [],
});
importProcessor.preprocessTokens();
assert.strictEqual(
hasShadowedGlobals(tokenProcessor, importProcessor.getGlobalNames()),
Expand Down
55 changes: 54 additions & 1 deletion test/typescript-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
IMPORT_WILDCARD_PREFIX,
JSX_PREFIX,
} from "./prefixes";
import {assertResult} from "./util";
import {assertResult, devProps} from "./util";

function assertTypeScriptResult(code: string, expectedResult: string): void {
assertResult(code, expectedResult, {transforms: ["jsx", "imports", "typescript"]});
Expand Down Expand Up @@ -1048,6 +1048,59 @@ describe("typescript transform", () => {
);
});

it("does not elide a React import when the file contains a JSX fragment", () => {
assertTypeScriptResult(
`
import React from 'react';
function render(): JSX.Element {
return <>Hello</>;
}
`,
`"use strict";${IMPORT_DEFAULT_PREFIX}
var _react = require('react'); var _react2 = _interopRequireDefault(_react);
function render() {
return _react2.default.createElement(_react2.default.Fragment, null, "Hello");
}
`,
);
});

it("correctly takes JSX pragmas into account avoiding JSX import elision", () => {
assertResult(
`
import {A, B, C, D} from 'foo';
function render(): JSX.Element {
return <>Hello</>;
}
`,
`
import {A, C,} from 'foo';
function render() {
return A.B(C.D, null, "Hello");
}
`,
{transforms: ["typescript", "jsx"], jsxPragma: "A.B", jsxFragmentPragma: "C.D"},
);
});

it("correctly takes JSX pragmas into account avoiding JSX import elision with fragments unused", () => {
assertResult(
`
import {A, B, C, D} from 'foo';
function render(): JSX.Element {
return <span />;
}
`,
`const _jsxFileName = "";
import {A,} from 'foo';
function render() {
return A.B('span', {${devProps(4)}} );
}
`,
{transforms: ["typescript", "jsx"], jsxPragma: "A.B", jsxFragmentPragma: "C.D"},
);
});

it("handles TypeScript exported enums in ESM mode", () => {
assertTypeScriptESMResult(
`
Expand Down