forked from TypeScriptToLua/TypeScriptToLua.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
81 lines (49 loc) · 35.8 KB
/
index.html
File metadata and controls
81 lines (49 loc) · 35.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width">
<meta name="generator" content="Docusaurus v2.0.0-alpha.50">
<title data-react-helmet="true">Plugins | TypeScriptToLua</title>
<meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:title" content="Plugins | TypeScriptToLua"><meta data-react-helmet="true" name="description" content="TypeScriptToLua supports plugins - an interface that allows to customize transpilation behavior."><meta data-react-helmet="true" property="og:description" content="TypeScriptToLua supports plugins - an interface that allows to customize transpilation behavior."><meta data-react-helmet="true" property="og:url" content="https://typescripttolua.github.io/docs/api/plugins">
<link data-react-helmet="true" rel="shortcut icon" href="/images/favicon.ico">
<link rel="stylesheet" href="/styles.38eff7c3.css">
<link rel="stylesheet" href="/main.69618293.css">
<link rel="stylesheet" href="/1be78505.0edf629a.css">
<link rel="preload" href="/styles.d96b78fc.js" as="script">
<link rel="preload" href="/runtime~main.80315467.js" as="script">
<link rel="preload" href="/main.fe444d48.js" as="script">
<link rel="preload" href="/1.26a7f959.js" as="script">
<link rel="preload" href="/2.37c71318.js" as="script">
<link rel="preload" href="/3.429ea9f3.js" as="script">
<link rel="preload" href="/1be78505.22fb902e.js" as="script">
<link rel="preload" href="/20ac7829.5357fb4c.js" as="script">
<link rel="preload" href="/17896441.c4b65510.js" as="script">
<link rel="preload" href="/5db1ad52.28d3dd5e.js" as="script">
</head>
<body>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=window.matchMedia("(prefers-color-scheme: dark)"),n=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();null!==n?t(n):e.matches&&t("dark")}()</script>
<div id="__docusaurus">
<nav class="navbar navbar--light navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/images/logo.png"><strong class="navbar__title">TypeScriptToLua</strong></a><a class="navbar__item navbar__link" href="/docs/getting-started">Docs</a><a class="navbar__item navbar__link" href="/play">Playground</a></div><div class="navbar__items navbar__items--right"><a target="_blank" rel="noopener noreferrer" href="https://discord.gg/BWAq58Y" class="navbar__item navbar__link">Discord</a><a target="_blank" rel="noopener noreferrer" href="https://github.com/TypeScriptToLua/TypeScriptToLua" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_1gtM"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_keGJ moon_1gwN"></span></div><div class="react-toggle-track-x"><span class="toggle_keGJ sun_3CPA"></span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/images/logo.png"><strong class="navbar__title">TypeScriptToLua</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/getting-started">Docs</a></li><li class="menu__list-item"><a class="menu__link" href="/play">Playground</a></li><li class="menu__list-item"><a target="_blank" rel="noopener noreferrer" href="https://discord.gg/BWAq58Y" class="menu__link">Discord</a></li><li class="menu__list-item"><a target="_blank" rel="noopener noreferrer" href="https://github.com/TypeScriptToLua/TypeScriptToLua" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1kjD"><div class="docSidebarContainer_1cYp"><div class="sidebar_1kLs"><div class="menu menu--responsive menu_w2sC"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_2vk4" xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 32 32" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/getting-started">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/configuration">Configuration</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/caveats">Caveats</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/editor-support">Editor Support</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Advanced</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/advanced/writing-declarations">Writing Declarations</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/advanced/compiler-annotations">Compiler Annotations</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/advanced/functions-and-the-self-parameter">Functions and the `self` Parameter</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">API</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/api/overview">Overview</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active" href="/docs/api/plugins">Plugins</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/api/printer">Printer</a></li></ul></li></ul></div></div></div><main class="docMainContainer_FFX1"><div class="padding-vert--lg"><div class="container"><div class="row"><div class="col docItemCol_2GOA"><div class="docItemContainer_2cwg"><article><header><h1 class="docTitle_1vWb">Plugins</h1></header><div class="markdown"><p>TypeScriptToLua supports plugins - an interface that allows to customize transpilation behavior.</p><p>To add a plugin you have to add it under <code>tstl.luaPlugins</code> option in the <a href="/docs/configuration">configuration file</a>.</p><p>Example:</p><div class="mdxCodeBlock_iHAB"><div class="title_1twf">tsconfig.json</div><pre class="prism-code language-json codeBlock_222H hasTitle_1PmY"><button type="button" aria-label="Copy code to clipboard" class="copyButton_ujp3">Copy</button><code class="codeBlockLines_3zpG" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"tstl"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"luaPlugins"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Plugin is a JavaScript module exporting an object</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> </span><span class="token property" style="color:#36acaa">"name"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"./plugin1.js"</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// TypeScriptToLua can load plugins written in TypeScript using `ts-node`</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> </span><span class="token property" style="color:#36acaa">"name"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"./plugin2.ts"</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Plugins can be published to npm</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> </span><span class="token property" style="color:#36acaa">"name"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"tstl-plugin-3"</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span></div></code></pre></div><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="api"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#api" title="Direct link to heading">#</a>API</h2><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="visitors"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#visitors" title="Direct link to heading">#</a><code>visitors</code></h3><p>Internally, to process <a href="https://basarat.gitbook.io/typescript/overview/ast">Abstract Syntax Tree</a> of a TypeScript program, TypeScriptToLua implements the <a href="https://en.wikipedia.org/wiki/Visitor_pattern">visitor pattern</a>. Visitor is a function, called with a processed node and transformation context, and returning a Lua AST node. Plugins can inject their own visitors using <code>visitors</code> property, overriding standard transformation behavior.</p><p>Example:</p><div class="mdxCodeBlock_iHAB"><pre class="prism-code language-ts codeBlock_222H"><button type="button" aria-label="Copy code to clipboard" class="copyButton_ujp3">Copy</button><a class="playgroundButton_3DKR" aria-label="Open code on playground" target="_blank" href="/play/#code/JYWwDg9gTgLgBAKjgQwM5xugZlCI4BEMAnmAKaoDGUwYMBA3AFCiSyIrqYwA2cOeQiXJUadALQwI4ngFdkjJk0oQAdqnhg5Ac2CqAXBg08AdAAUdeuAF44AbyZw4AemdwABgDdgqYFKio7nA+KHBQZCpQACZwAO4AFmThcADWZMToyMkAKqRkAMrUtPCqEFFkcKjEqjDIAB6pelGojnDevv6ohg5OTq5wAGo+ftBwlMiqcABGFcj8sqqUMMBqGPHI8OEwslDqcAAy8nAAgvnZcKXlrU4A2pgm+dW1dQDSTSYASmTbu-m1MGQQGQagBdQwACgAlDYAHxGXgmahkDZkL4-VR-FFAmrgu7GRHhFEAIQgEB4yNU+z8SWQPHBMCgsjIkJBkIANK0AL4cznMJhkOpseDlLDIWQ8TSWVQMIA">Playground</a><code class="codeBlockLines_3zpG" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">as</span><span class="token plain"> ts </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"typescript"</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">as</span><span class="token plain"> tstl </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"typescript-to-lua"</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> plugin</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">Plugin</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// `visitors` is a record where keys are TypeScript node syntax kinds</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> visitors</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Visitor can be a function that returns Lua AST node</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">ts</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">SyntaxKind</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">ReturnStatement</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:#393A34">=></span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">createReturnStatement</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">createBooleanLiteral</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">default</span><span class="token plain"> plugin</span><span class="token punctuation" style="color:#393A34">;</span></div></code></pre></div><p>Example 2:</p><div class="mdxCodeBlock_iHAB"><pre class="prism-code language-ts codeBlock_222H"><button type="button" aria-label="Copy code to clipboard" class="copyButton_ujp3">Copy</button><a class="playgroundButton_3DKR" aria-label="Open code on playground" target="_blank" href="/play/#code/JYWwDg9gTgLgBAKjgQwM5xugZlCI4BEMAnmAKaoDGUwYMBA3AFCiSyIrqYwA2cOeQiXJUadALQwI4ngFdkjJk0oQAdqnhg5Ac2CqAXBg08AdAAUdeuAF44AbyZw4AN2CpgUqKkMOnTgPT+cABqbh5wGjSq2nA8HmRQyDyoADRwwFhw0MC6qkkYiepY0CAJcFBkMLJQ6igRMFExcTAJSWmUABbI0WQYHb2RejFShABGyFAE6eotyAAmjn4A2pgmAMrEqjDIAB4A0npz6w1DADLxiTwAuoYAFKoQc2Ttai07MACUNgB89ot+cECcAABiotmR3sC4BDIKgKCDULJyFAACqFVDFKAgBBQ0owDqPVJ9ZDwSjdOCjXqyOFzDAQOBknh8MgefpQPq9VzuTxwMC4VxPWmjYi8iquCDU-5+IFaWS5NLQOoabpzCa0lGkMhrai0GAoiCneQuMKeKVOMEacoUWQ8eC2MFvGAmRHItHdDElACiOz5FHcanujzIH2YZsBQTW21UqqgtK5HkVmKMx0a5xalxQPAA7shiOgKlUalxjCmzhd8g8nmGMnBbtxTG5I6nyzxbhVEbaPl9fAC-O2bU7nElZL1bARxpNmL24ABfJTTgvVVRWjswKd+GcpRabpgz0Mw6DwJ5YZAD3mWVQMIA">Playground</a><code class="codeBlockLines_3zpG" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">as</span><span class="token plain"> ts </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"typescript"</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">as</span><span class="token plain"> tstl </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"typescript-to-lua"</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> plugin</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">Plugin</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> visitors</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Visit string literals, if original transformer returns a string literal, change the string to "bar" instead</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">ts</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">SyntaxKind</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">StringLiteral</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token parameter">node</span><span class="token parameter punctuation" style="color:#393A34">,</span><span class="token parameter"> context</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:#393A34">=></span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// `context` exposes `superTransform*` methods, that can be used to call either the visitor provided by previous</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// plugin, or a standard TypeScriptToLua visitor</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> result </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> context</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">superTransformExpression</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">node</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Standard visitor for ts.StringLiteral always returns tstl.StringLiteral node</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">isStringLiteral</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">result</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> result</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">value</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"bar"</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">return</span><span class="token plain"> result</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">default</span><span class="token plain"> plugin</span><span class="token punctuation" style="color:#393A34">;</span></div></code></pre></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="printer"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#printer" title="Direct link to heading">#</a><code>printer</code></h3><p>Printer is a function that overrides standard implementation of Lua AST printer. It receives some information about the file and transformed Lua AST. See <a href="/docs/api/printer">Printer</a> page for more information.</p><p>Example:</p><div class="mdxCodeBlock_iHAB"><pre class="prism-code language-ts codeBlock_222H"><button type="button" aria-label="Copy code to clipboard" class="copyButton_ujp3">Copy</button><a class="playgroundButton_3DKR" aria-label="Open code on playground" target="_blank" href="/play/#code/JYWwDg9gTgLgBAKjgQwM5xqmAbOAzKCEOAIhgE8wBTVAYymDBgFoYJnsBXZEgbgCh+tbGnQBhTliIAZbgAUGAOxhUocKgA8VigCbpMOAHSzkC4MtVwA3gF9BtCIqxwwXAObmAXBizZDc93M4AF5rfjgXJRUobwAKMEI3KGQQABp1EGAYAAkILHS8YGwqADkUqnSAI2wIWgBrdK5kaWBKgDEqZBhOKBoAShCAPnCIuEUqAHc4CSkQEzMLKHjE5JBDNyoYMSIwItUAeSZgR1RYvvSqTJy8mAK9spAqPsME8xhY6tqGuCaW9s7ur1UOd+DYBPxNJBYHAdFQ8MhONh4K5OB5FLwgA">Playground</a><code class="codeBlockLines_3zpG" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">as</span><span class="token plain"> tstl </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"typescript-to-lua"</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> </span><span class="token class-name">CustomLuaPrinter</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> </span><span class="token class-name">tstl</span><span class="token class-name punctuation" style="color:#393A34">.</span><span class="token class-name">LuaPrinter</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> plugin</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">Plugin</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token function-variable function" style="color:#d73a49">printer</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token parameter">program</span><span class="token parameter punctuation" style="color:#393A34">,</span><span class="token parameter"> emitHost</span><span class="token parameter punctuation" style="color:#393A34">,</span><span class="token parameter"> fileName</span><span class="token parameter punctuation" style="color:#393A34">,</span><span class="token parameter"> block</span><span class="token parameter punctuation" style="color:#393A34">,</span><span class="token parameter"> luaLibFeatures</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:#393A34">=></span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> </span><span class="token class-name">CustomLuaPrinter</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">program</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">getCompilerOptions</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> emitHost</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> fileName</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">print</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">block</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> luaLibFeatures</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">default</span><span class="token plain"> plugin</span><span class="token punctuation" style="color:#393A34">;</span></div></code></pre></div></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/TypeScriptToLua/TypeScriptToLua.github.io/edit/source/docs/api/plugins.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/api/overview"><div class="pagination-nav__link--sublabel">Previous</div><div class="pagination-nav__link--label">« Overview</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/api/printer"><div class="pagination-nav__link--sublabel">Next</div><div class="pagination-nav__link--label">Printer »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_TbNY"><ul class="contents contents__left-border"><li><a href="#api" class="contents__link">API</a><ul><li><a href="#visitors" class="contents__link"><code>visitors</code></a></li><li><a href="#printer" class="contents__link"><code>printer</code></a></li></ul></li></ul></div></div></div></div></div></main></div></div>
</div>
<script src="/styles.d96b78fc.js"></script>
<script src="/runtime~main.80315467.js"></script>
<script src="/main.fe444d48.js"></script>
<script src="/1.26a7f959.js"></script>
<script src="/2.37c71318.js"></script>
<script src="/3.429ea9f3.js"></script>
<script src="/1be78505.22fb902e.js"></script>
<script src="/20ac7829.5357fb4c.js"></script>
<script src="/17896441.c4b65510.js"></script>
<script src="/5db1ad52.28d3dd5e.js"></script>
</body>
</html>