ts-simple-ast
Version:
TypeScript compiler wrapper for AST navigation and code generation.
142 lines (113 loc) • 9.22 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>ts-simple-ast - Emitting</title>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/css/bootstrap.min.css" integrity="sha384-rwoIResjU2yc3z8GV/NPeZWAv56rSmLldC3R/AZzGRnGxQQKnKkoFVhFQhNUwEyJ" crossorigin="anonymous">
<link rel="stylesheet" href="/assets/css/style.css?v=502728dc7b09041e36b06c50f79a13adbfb6f1b2">
<!--
<link rel="stylesheet" href="/assets/css/style.css?v=502728dc7b09041e36b06c50f79a13adbfb6f1b2">
<link rel="stylesheet" href="/assets/css/custom-style.css?v=502728dc7b09041e36b06c50f79a13adbfb6f1b2">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script src="/assets/js/main.js"></script>-->
</head>
<body>
<div class="main">
<header class="container">
<div class="row">
<h1 onclick="document.location.href = '/'" class="headerLink">ts-simple-ast</h1>
<!--<p class="subText">Simple way to navigate and manipulate the TypeScript AST.</p>-->
</div>
</header>
<div class="container">
<div class="row">
<div class="col-md-3">
<button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<nav class="sidebar-nav" id="navbarSupportedContent">
<ul class="navbar-nav navbar-default">
<li class="nav-item">
<a class="nav-link" href="/">Overview</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/setup">Setup</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/navigation">Navigation</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/manipulation">Manipulation</a>
</li>
<li class="nav-item active">
<a class="nav-link" href="/emitting">Emitting</a>
</li>
<li class="">
<a class="nav-link" href="/details/index">Details</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/utilities">Utilities</a>
</li>
<li class="nav-item">
<a class="nav-link" href="http://github.com/dsherret/ts-simple-ast">View on GitHub</a>
</li>
</ul>
</nav>
</div>
<section class="container-fluid col-md-9">
<h2 id="emitting">Emitting</h2>
<p>Emitting is easy. Here’s an example:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">ast</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">TsSimpleAst</span><span class="p">({</span> <span class="na">compilerOptions</span><span class="p">:</span> <span class="p">{</span> <span class="na">outDir</span><span class="p">:</span> <span class="s2">"dist"</span><span class="p">,</span> <span class="na">declaration</span><span class="p">:</span> <span class="kc">true</span> <span class="p">}</span> <span class="p">});</span>
<span class="nx">ast</span><span class="p">.</span><span class="nx">addSourceFile</span><span class="p">(</span><span class="s2">"MyFile.ts"</span><span class="p">,</span> <span class="s2">"const num = 1;"</span><span class="p">);</span>
<span class="nx">ast</span><span class="p">.</span><span class="nx">emit</span><span class="p">();</span>
</code></pre>
</div>
<p>Outputs two files in the <code class="highlighter-rouge">dist</code> folder:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="c1">// MyFile.js</span>
<span class="kd">var</span> <span class="nx">num</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span>
<span class="c1">// MyFile.d.ts</span>
<span class="kr">declare</span> <span class="kd">const</span> <span class="nx">num</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span>
</code></pre>
</div>
<h3 id="emitting-a-single-file">Emitting a single file</h3>
<p>Call <code class="highlighter-rouge">.emit()</code> on the source file:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">sourceFile</span> <span class="o">=</span> <span class="nx">ast</span><span class="p">.</span><span class="nx">getSourceFileOrThrow</span><span class="p">(</span><span class="s2">"MyFile.ts"</span><span class="p">);</span>
<span class="nx">sourceFile</span><span class="p">.</span><span class="nx">emit</span><span class="p">();</span>
</code></pre>
</div>
<p>Or get its emit output:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">emitOutput</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getEmitOutput</span><span class="p">();</span>
<span class="nx">emitOutput</span><span class="p">.</span><span class="nx">getEmitSkipped</span><span class="p">();</span> <span class="c1">// returns: boolean</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">const</span> <span class="nx">outputFile</span> <span class="nx">of</span> <span class="nx">emitOutput</span><span class="p">.</span><span class="nx">getOutputFiles</span><span class="p">())</span> <span class="p">{</span>
<span class="nx">outputFile</span><span class="p">.</span><span class="nx">getFilePath</span><span class="p">();</span>
<span class="nx">outputFile</span><span class="p">.</span><span class="nx">getWriteByteOrderMark</span><span class="p">();</span>
<span class="nx">outputFile</span><span class="p">.</span><span class="nx">getText</span><span class="p">();</span>
<span class="p">}</span>
</code></pre>
</div>
<h3 id="emitting-only-declaration-files-dts">Emitting only declaration files (.d.ts)</h3>
<p>Specify the <code class="highlighter-rouge">emitOnlyDtsFiles</code> flag:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">ast</span><span class="p">.</span><span class="nx">emit</span><span class="p">({</span> <span class="na">emitOnlyDtsFiles</span><span class="p">:</span> <span class="kc">true</span> <span class="p">});</span>
</code></pre>
</div>
<h3 id="emit-diagnostics">Emit Diagnostics</h3>
<p>Diagnostics about the emit can be found on the result:</p>
<div class="language-ts highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">emitResult</span> <span class="o">=</span> <span class="nx">ast</span><span class="p">.</span><span class="nx">emit</span><span class="p">();</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">const</span> <span class="nx">diagnostic</span> <span class="nx">of</span> <span class="nx">emitResult</span><span class="p">.</span><span class="nx">getDiagnostics</span><span class="p">())</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">diagnostic</span><span class="p">.</span><span class="nx">getMessageText</span><span class="p">());</span>
</code></pre>
</div>
<p>These are good to always check when emitting to ensure everything went smoothly. They will explain why files aren’t being emitted.</p>
</section>
</div>
</div>
<footer>
</footer>
</div>
<script src="https://code.jquery.com/jquery-3.1.1.slim.min.js" integrity="sha384-A7FZj7v+d/sdmMqp/nOQwliLvUsJfDHW+k9Omg/a/EheAdgtzNs3hpfag6Ed950n" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js" integrity="sha384-DztdAPBWPRXSA/3eYEEUWrWCy7G5KFbe8fFjk5JAIxUYHKkDx6Qin1DkWx51bBrb" crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script>
<!--[if !IE]><script>fixScale(document);</script><![endif]-->
</body>
</html>