Skip to content

Add tag name transformer support to defineCustomElement #6215

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+50 −7
Draft

Add tag name transformer support to defineCustomElement #6215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion src/compiler/output-targets/dist-custom-elements/custom-elements-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,10 +195,11 @@ const generateCustomElementType = (componentsDtsRelPath: string, cmp: d.Componen
` prototype: ${tagNameAsPascal};`,
` new (): ${tagNameAsPascal};`,
`};`,
`type TagNameTransformer = (tagName: string) => string;`,
`/**`,
` * Used to define this component and all nested components recursively.`,
` */`,
`export const defineCustomElement: () => void;`,
`export const defineCustomElement: (tagNameTransformer?: TagNameTransformer) => void;`,
``,
];

Expand Down
54 changes: 48 additions & 6 deletions src/compiler/transformers/component-native/add-define-custom-element-function.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,9 @@ const setupComponentDependencies = (
newStatements.push(createImportStatement([`defineCustomElement as ${importAs}`], foundDep.sourceFilePath));

// define a dependent component by recursively calling their own `defineCustomElement()`
const callExpression = ts.factory.createCallExpression(ts.factory.createIdentifier(importAs), undefined, []);
const callExpression = ts.factory.createCallExpression(ts.factory.createIdentifier(importAs), undefined, [
ts.factory.createIdentifier('tagNameTransformer'),
]);
// `case` blocks that define the dependent components. We'll add them to our switch statement later.
caseStatements.push(createCustomElementsDefineCase(foundDep.tagName, callExpression));
});
Expand All @@ -107,7 +109,7 @@ const setupComponentDependencies = (
* @returns ts AST CaseClause
*/
const createCustomElementsDefineCase = (tagName: string, actionExpression: ts.Expression): ts.CaseClause => {
return ts.factory.createCaseClause(ts.factory.createStringLiteral(tagName), [
return ts.factory.createCaseClause(wrapTagNameWithTransformer(tagName), [
ts.factory.createIfStatement(
ts.factory.createPrefixUnaryExpression(
ts.SyntaxKind.ExclamationToken,
Expand Down Expand Up @@ -158,7 +160,43 @@ const addDefineCustomElementFunction = (
undefined,
ts.factory.createIdentifier('defineCustomElement'),
undefined,
[],
[
ts.factory.createParameterDeclaration(
undefined,
undefined,
ts.factory.createIdentifier('tagNameTransformer'),
undefined,
ts.factory.createFunctionTypeNode(
undefined,
[
ts.factory.createParameterDeclaration(
undefined,
undefined,
ts.factory.createIdentifier('tagName'),
undefined,
ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
),
],
ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
),
ts.factory.createArrowFunction(
undefined,
undefined,
[
ts.factory.createParameterDeclaration(
undefined,
undefined,
ts.factory.createIdentifier('tagName'),
undefined,
undefined,
),
],
undefined,
ts.factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken),
ts.factory.createBlock([ts.factory.createReturnStatement(ts.factory.createIdentifier('tagName'))], true),
),
),
],
undefined,
ts.factory.createBlock(
[
Expand All @@ -177,9 +215,7 @@ const addDefineCustomElementFunction = (
'components',
undefined,
undefined,
ts.factory.createArrayLiteralExpression(
tagNames.map((tagName) => ts.factory.createStringLiteral(tagName)),
),
ts.factory.createArrayLiteralExpression(tagNames.map((tagName) => wrapTagNameWithTransformer(tagName))),
),
],
ts.NodeFlags.Const,
Expand Down Expand Up @@ -236,3 +272,9 @@ function createAutoDefinitionExpression(componentName: string): ts.ExpressionSta
]),
);
}

function wrapTagNameWithTransformer(tagName: string) {
return ts.factory.createCallExpression(ts.factory.createIdentifier('tagNameTransformer'), undefined, [
ts.factory.createStringLiteral(tagName),
]);
}