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
19 lines (19 loc) · 20.9 KB
/
index.html
File metadata and controls
19 lines (19 loc) · 20.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<!doctype html>
<html lang="en" dir="ltr">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="generator" content="Docusaurus v2.0.0-beta.ff31de0ff">
<link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="TypeScriptToLua Blog RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="TypeScriptToLua Blog Atom Feed">
<link rel="search" type="application/opensearchdescription+xml" title="TypeScriptToLua" href="/opensearch.xml"><title data-react-helmet="true">Configuration | TypeScriptToLua</title><meta data-react-helmet="true" property="og:url" content="https://typescripttolua.github.io/docs/configuration"><meta data-react-helmet="true" name="docsearch:language" content="en"><meta data-react-helmet="true" name="docsearch:version" content="current"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Configuration | TypeScriptToLua"><meta data-react-helmet="true" name="description" content="TypeScriptToLua uses the same configuration file as the vanilla TypeScript compiler, loading it from the tsconfig.json file using the same rules as tsc."><meta data-react-helmet="true" property="og:description" content="TypeScriptToLua uses the same configuration file as the vanilla TypeScript compiler, loading it from the tsconfig.json file using the same rules as tsc."><link data-react-helmet="true" rel="shortcut icon" href="/images/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://typescripttolua.github.io/docs/configuration"><link data-react-helmet="true" rel="alternate" href="https://typescripttolua.github.io/docs/configuration" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://typescripttolua.github.io/docs/configuration" hreflang="x-default"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/assets/css/styles.18adf632.css">
<link rel="preload" href="/assets/js/runtime~main.61a08516.js" as="script">
<link rel="preload" href="/assets/js/main.e6eb41dd.js" as="script">
</head>
<body>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div><a href="#main" class="skipToContent_1oUP">Skip to main content</a></div><nav class="navbar navbar--fixed-top navbarHideable_2qcr"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle" type="button" tabindex="0"><svg aria-label="Menu" 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></button><a class="navbar__brand" href="/"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><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 href="https://discord.gg/BWAq58Y" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-discord-link" aria-label="Discord Server"></a><a href="https://github.com/TypeScriptToLua/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="react-toggle displayOnlyInLargeViewport_GrZ2 react-toggle--disabled" role="button" tabindex="-1"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_71bT">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_71bT">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span></button></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><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 href="https://discord.gg/BWAq58Y" target="_blank" rel="noopener noreferrer" class="menu__link header-discord-link" aria-label="Discord Server"></a></li><li class="menu__list-item"><a href="https://github.com/TypeScriptToLua/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="menu__link header-github-link" aria-label="GitHub repository"></a></li></ul></div></div></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_31aa"><div class="docSidebarContainer_3Kbt" role="complementary"><div class="sidebar_15mo sidebarWithHideableNavbar_267A"><a tabindex="-1" class="sidebarLogo_3h0W" href="/"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--light_3UqQ"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--dark_hz6m"><strong>TypeScriptToLua</strong></a><div class="menu menu--responsive thin-scrollbar menu_Bmed"><button aria-label="Open menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_fgN0" width="24" height="24" 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></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 aria-current="page" class="menu__link menu__link--active active" 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/the-self-parameter">The Self Parameter</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/external-lua-code">External Lua Code</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/publishing-modules">Publishing Modules</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/editor-support">Editor Support</a></li><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/language-extensions">Language extensions</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/tsx">TSX</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">API</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/api/overview">Overview</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/api/plugins">Plugins</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/api/printer">Printer</a></li></ul></li></ul></div></div></div><main class="docMainContainer_3ufF"><div class="container padding-vert--lg docItemWrapper_3FMP"><div class="row"><div class="col docItemCol_3FnS"><div class="docItemContainer_33ec"><article><header><h1 class="docTitle_3a4h">Configuration</h1></header><div class="markdown"><p>TypeScriptToLua uses the same configuration file as the vanilla TypeScript compiler, loading it from the <code>tsconfig.json</code> file using the same rules as <code>tsc</code>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="custom-options"></a>Custom options<a class="hash-link" href="#custom-options" title="Direct link to heading">#</a></h2><p>To customize transpilation behavior we add a new group of options to the <code>tsconfig.json</code> file. All of these options should be placed in a <code>tstl</code> object.</p><div class="codeBlockContainer_K1bP"><div style="color:#393A34;background-color:#f6f8fa" class="codeBlockTitle_eoMF">tsconfig.json</div><div class="codeBlockContent_hGly json"><div tabindex="0" class="prism-code language-json codeBlock_23N8 thin-scrollbar codeBlockWithTitle_2JqI"><div class="codeBlockLines_39YC" 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 comment" style="color:#999988;font-style:italic">// custom options</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></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o">Copy</button></div></div><table><thead><tr><th>Option</th><th>Values</th><th>Description</th></tr></thead><tbody><tr><td><code>luaTarget</code></td><td><code>"JIT"</code>, <code>"5.3"</code>, <code>"5.2"</code>, <code>"5.1"</code>, <code>"universal"</code> (default: <code>"universal"</code>)</td><td>Specifies the Lua version you want to generate code for. Choosing <code>universal</code> makes TypeScriptToLua generate code compatible with all supported Lua targets.</td></tr><tr><td><code>noImplicitSelf</code></td><td><code>true</code>, <code>false</code> (default: <code>false</code>)</td><td>If true, treats all project files as if they were prefixed with<br><code>/** @noSelfInFile **/</code>.</td></tr><tr><td><code>noHeader</code></td><td><code>true</code>, <code>false</code> (default: <code>false</code>)</td><td>Set this to true if you don't want to include our header in the output.</td></tr><tr><td><code>luaLibImport</code></td><td><code>"inline"</code>, <code>"require"</code>, <code>"always"</code>, <code>"none"</code> (default: <code>"require"</code>)</td><td>We polyfill certain JavaScript features with Lua functions, this option specifies how these functions are imported into the Lua output.</td></tr><tr><td><code>sourceMapTraceback</code></td><td><code>true</code>, <code>false</code> (default: <code>false</code>)</td><td>Overrides Lua's <code>debug.traceback</code> to apply sourcemaps to Lua stacktraces. This will make error messages point to your original TypeScript code instead of the generated Lua.</td></tr><tr><td><code>luaBundle</code></td><td>File path (relative to the <code>tsconfig.json</code>)</td><td>Will bundle all output lua files into a single bundle file. Requires <strong>luaBundleEntry</strong> to be set!</td></tr><tr><td><code>luaBundleEntry</code></td><td>File path (relative to the <code>tsconfig.json</code>)</td><td>This should be the name/path of the TS file in your project that will serve as entry point to the bundled code.</td></tr><tr><td><code>luaPlugins</code></td><td><code>Array<{ name: string; import?: string }></code></td><td>List of <a href="/docs/api/plugins">TypeScriptToLua plugins</a>.</td></tr><tr><td><code>buildMode</code></td><td><code>"default"</code>, <code>"library"</code> (default: <code>"library"</code>)</td><td>Use <code>buildMode: "library"</code> to build <a href="/docs/publishing-modules">publishable library packages</a>.</td></tr><tr><td><code>tstlVerbose</code></td><td><code>true</code>, <code>false</code> (default: <code>false</code>)</td><td>Output additional logging when performing a tstl build, to help diagnose issues.</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="standard-options"></a>Standard options<a class="hash-link" href="#standard-options" title="Direct link to heading">#</a></h2><p>Most of the standard <a href="https://www.typescriptlang.org/docs/handbook/compiler-options.html" target="_blank" rel="noopener noreferrer">TypeScript options</a> work without any changes. Notable unsupported options are:</p><ul><li><code>composite</code>, <code>build</code></li><li><code>incremental</code></li><li><code>emitDecoratorMetadata</code></li><li><code>esModuleInterop</code></li></ul><p>Some options do not apply to TypeScriptToLua and are ignored:</p><ul><li><code>outFile</code> - use <code>luaBundle</code> instead.</li><li><code>importHelpers</code>, <code>noEmitHelpers</code> - use <code>luaLibImport</code> instead.</li><li><code>target</code>, <code>module</code> - it's only effect is limiting some features, so prefer to set it to <code>esnext</code>. If TypeScript requires you to specify different <code>module</code> type because you want to bundle your declarations with <code>outFile</code>, consider using <a href="https://api-extractor.com/" target="_blank" rel="noopener noreferrer">API Extractor</a> instead.</li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="transformers"></a>Transformers<a class="hash-link" href="#transformers" title="Direct link to heading">#</a></h2><p>Transformers is a powerful feature of TypeScript that allows you to modify behavior of your program during compilation. While TypeScript <a href="https://github.com/microsoft/TypeScript/issues/14419" target="_blank" rel="noopener noreferrer">currently</a> does not provide a user-facing way to use transformers, TypeScriptToLua allows you to specify them in the configuration file, following <a href="https://github.com/cevek/ttypescript#how-to-use" target="_blank" rel="noopener noreferrer">ttypescript</a> format.</p><p><strong>Example:</strong></p><div class="codeBlockContainer_K1bP"><div style="color:#393A34;background-color:#f6f8fa" class="codeBlockTitle_eoMF">tsconfig.json</div><div class="codeBlockContent_hGly json"><div tabindex="0" class="prism-code language-json codeBlock_23N8 thin-scrollbar codeBlockWithTitle_2JqI"><div class="codeBlockLines_39YC" 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">"compilerOptions"</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">"plugins"</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 punctuation" style="color:#393A34">{</span><span class="token plain"> </span><span class="token property" style="color:#36acaa">"transform"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"dota-lua-types/transformer"</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 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></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o">Copy</button></div></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/configuration.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" role="img" viewBox="0 0 40 40" class="iconEdit_2_ui" aria-label="Edit page"><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" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/getting-started"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Getting Started</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/caveats"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Caveats »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_35-E thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#custom-options" class="table-of-contents__link">Custom options</a></li><li><a href="#standard-options" class="table-of-contents__link">Standard options</a></li><li><a href="#transformers" class="table-of-contents__link">Transformers</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/getting-started">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/configuration">Configuration</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/advanced/writing-declarations">Advanced</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items"><li class="footer__item"><a href="https://discord.gg/BWAq58Y" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord</a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="footer__link-item">Github</a></li><li class="footer__item"><a class="footer__link-item" href="/play">Playground</a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://github.com/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="footerLogoLink_MyFc"><img src="/images/logo.png" alt="TypeScriptToLua Logo" class="themedImage_1VuW themedImage--light_3UqQ footer__logo"><img src="/images/logo.png" alt="TypeScriptToLua Logo" class="themedImage_1VuW themedImage--dark_hz6m footer__logo"></a></div><div class="footer__copyright">Copyright © 2021 TypeScriptToLua Contributors</div></div></div></footer></div>
<script src="/assets/js/runtime~main.61a08516.js"></script>
<script src="/assets/js/main.e6eb41dd.js"></script>
</body>
</html>