ts-simple-ast
Version:
TypeScript compiler wrapper for AST navigation and code generation.
130 lines (102 loc) • 7.83 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>TsSimpleAst</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=71a391c40e7283d83416a246f2c61c5fcb76068a">
<!--
<link rel="stylesheet" href="/assets/css/style.css?v=71a391c40e7283d83416a246f2c61c5fcb76068a">
<link rel="stylesheet" href="/assets/css/custom-style.css?v=71a391c40e7283d83416a246f2c61c5fcb76068a">
<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">TsSimpleAst</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 active">
<a class="nav-link" href="/navigation">Navigation</a>
<ul>
<li class=""><a href="/navigation/getting-sourcefiles">Getting SourceFiles</a></li>
<li class="active"><a href="/navigation/example">Example</a></li>
<li class=""><a href="/navigation/compiler-nodes">Compiler Nodes</a></li>
</ul>
</li>
<li class="nav-item">
<a class="nav-link" href="/manipulation">Manipulation</a>
</li>
<li class="">
<a class="nav-link" href="/details/index">Details</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="example---navigating-within-source-files">Example - Navigating Within Source Files</h2>
<h3 id="setup">Setup</h3>
<p>Given the following file:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="c1">// Person.ts</span>
<span class="kr">interface</span> <span class="nx">Person</span> <span class="p">{</span>
<span class="nl">name</span><span class="p">:</span> <span class="kr">string</span><span class="p">;</span>
<span class="nl">age</span><span class="p">:</span> <span class="kr">number</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">export</span> <span class="k">default</span> <span class="nx">Person</span><span class="p">;</span>
</code></pre>
</div>
<p>And setup:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="k">import</span> <span class="nx">Ast</span> <span class="k">from</span> <span class="s2">"ts-simple-ast"</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">ast</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Ast</span><span class="p">();</span>
<span class="nx">ast</span><span class="p">.</span><span class="nx">addSourceFiles</span><span class="p">(</span><span class="s2">"**/*.ts"</span><span class="p">);</span>
</code></pre>
</div>
<h3 id="use">Use</h3>
<p>First you need to get the source file you would like to look at:</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">getSourceFile</span><span class="p">(</span><span class="s2">"Person.ts"</span><span class="p">);</span>
</code></pre>
</div>
<p>Now inspect what’s inside… here’s a few examples:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">hasClasses</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getClasses</span><span class="p">().</span><span class="nx">length</span> <span class="o">></span> <span class="mi">0</span><span class="p">;</span>
<span class="kd">const</span> <span class="nx">interfaces</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getInterfaces</span><span class="p">();</span>
<span class="c1">// person interface</span>
<span class="kd">const</span> <span class="nx">personInterface</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getInterface</span><span class="p">(</span><span class="s2">"Person"</span><span class="p">)</span><span class="o">!</span><span class="p">;</span>
<span class="nx">personInterface</span><span class="p">.</span><span class="nx">isDefaultExport</span><span class="p">();</span> <span class="c1">// returns true</span>
<span class="nx">personInterface</span><span class="p">.</span><span class="nx">getName</span><span class="p">();</span> <span class="c1">// returns "Person"</span>
<span class="nx">personInterface</span><span class="p">.</span><span class="nx">getProperties</span><span class="p">();</span> <span class="c1">// returns the properties</span>
</code></pre>
</div>
<p><strong>Next step:</strong> <a href="compiler-nodes">Underlying Compiler Nodes</a></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>