ts-simple-ast
Version:
TypeScript compiler wrapper for AST navigation and code generation.
169 lines (139 loc) • 10.3 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 - JS Docs</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">
<a class="nav-link" href="/emitting">Emitting</a>
</li>
<li class="">
<a class="nav-link" href="/details/index">Details</a>
<ul>
<li class=""><a href="/details/source-files">Source Files</a></li>
<li class=""><a href="/details/classes">Classes</a></li>
<li class=""><a href="/details/decorators">Decorators</a></li>
<li class=""><a href="/details/enums">Enums</a></li>
<li class=""><a href="/details/functions">Functions</a></li>
<li class=""><a href="/details/imports">Imports</a></li>
<li class=""><a href="/details/interfaces">Interfaces</a></li>
<li class=""><a href="/details/namespaces">Namespaces</a></li>
<li class=""><a href="/details/parameters">Parameters</a></li>
<li class=""><a href="/details/type-aliases">Type Aliases</a></li>
<li class=""><a href="/details/variables">Variables</a></li>
<li>--</li>
<li class=""><a href="/details/types">Types</a></li>
<li class=""><a href="/details/signatures">Signatures</a></li>
<li>--</li>
<li class=""><a href="/details/expressions">Expressions</a></li>
<li class=""><a href="/details/object-literal-expressions">Object Literal Expressions</a></li>
<li class=""><a href="/details/identifiers">Identifiers</a></li>
<li class=""><a href="/details/ambient">Ambient</a></li>
<li class=""><a href="/details/async">Async</a></li>
<li class=""><a href="/details/exports">Exports</a></li>
<li class=""><a href="/details/generators">Generators</a></li>
<li class=""><a href="/details/initializers">Initializers</a></li>
<li class="active"><a href="/details/documentation">JS Docs</a></li>
<li class=""><a href="/details/literals">Literals</a></li>
<li class=""><a href="/details/modifiers">Modifiers</a></li>
</ul>
</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="js-docs">JS Docs</h2>
<p>Certain nodes can have JS docs. For example:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="cm">/**
* Gets the name.
* @param person - Person to get the name from.
*/</span>
<span class="kd">function</span> <span class="nx">getName</span><span class="p">(</span><span class="nx">person</span><span class="err">:</span> <span class="nx">Person</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</code></pre>
</div>
<h3 id="get-all-js-doc-nodes">Get all JS doc nodes</h3>
<p>Get all the JS doc nodes by using <code class="highlighter-rouge">getJsDocs()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">functionDeclaration</span><span class="p">.</span><span class="nx">getJsDocs</span><span class="p">();</span> <span class="c1">// returns: JSDoc[]</span>
</code></pre>
</div>
<h3 id="addinsert-docs">Add/insert docs</h3>
<p>Add or insert JS doc comments using the <code class="highlighter-rouge">addJsDoc()</code>, <code class="highlighter-rouge">addJsDocs()</code>, <code class="highlighter-rouge">insertJsDoc()</code>, and <code class="highlighter-rouge">insertJsDocs()</code> methods.</p>
<p>For example:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">docNode</span> <span class="o">=</span> <span class="nx">classDeclaration</span><span class="p">.</span><span class="nx">addJsDoc</span><span class="p">({</span>
<span class="na">description</span><span class="p">:</span> <span class="s2">"Some description..."</span>
<span class="p">});</span>
</code></pre>
</div>
<p>Right now you can only add a description, but in the future support will be added for easily manipulating more JS doc syntax.</p>
<h3 id="jsdoc-nodes">JSDoc Nodes</h3>
<p>Get the comment:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="c1">// getting the node from the original example above</span>
<span class="kd">const</span> <span class="nx">jsDoc</span> <span class="o">=</span> <span class="nx">functionDeclaration</span><span class="p">.</span><span class="nx">getJsDocs</span><span class="p">()[</span><span class="mi">0</span><span class="p">];</span>
<span class="nx">jsDoc</span><span class="p">.</span><span class="nx">getComment</span><span class="p">();</span> <span class="c1">// returns string: "Gets the name."</span>
</code></pre>
</div>
<p>Get the tags:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">tags</span> <span class="o">=</span> <span class="nx">jsDocNode</span><span class="p">.</span><span class="nx">getTags</span><span class="p">();</span>
<span class="nx">tags</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">getText</span><span class="p">();</span> <span class="c1">// "@param person - Person to get the name from."</span>
</code></pre>
</div>
<p>Get the inner text (the text without the surrounding comment):</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">jsDocNode</span><span class="p">.</span><span class="nx">getInnerText</span><span class="p">();</span> <span class="c1">// "Gets the name.\n@param person - Person to get the name from."</span>
</code></pre>
</div>
</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>