ts-simple-ast

<!doctype 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 - Directories</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">  </head> <body> <div class="main"> <header class="container"> <div class="row"> <h1 onclick="document.location.href = '/'" class="headerLink">ts-simple-ast</h1>  </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"> </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-source-files">Getting Source Files</a></li> <li class="active"><a href="/navigation/directories">Directories</a></li> <li class=""><a href="/navigation/example">Example</a></li> <li class=""><a href="/navigation/compiler-nodes">Compiler Nodes</a></li> <li class=""><a href="/navigation/existing-nodes">Existing Nodes</a></li> <li class=""><a href="/navigation/finding-references">Finding References</a></li> <li class=""><a href="/navigation/language-service">Language Service</a></li> <li class=""><a href="/navigation/program">Program</a></li> <li class=""><a href="/navigation/type-checker">Type Checker</a></li> </ul> </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> </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="directories">Directories</h2> Based on the source files created, appropriate directory objects will be created. These objects hold source files and directories that have been added. Note that it’s completely fine to ignore the concept of directories and only deal with source files. This is an advanced feature that only needs to be used if it will help make solving your problem easier. <h3 id="retrieving">Retrieving</h3> Directories can be retrieved from a source file: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>const directory = sourceFile.getDirectory(); </code></pre> </div> From other directories: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>directory.getDirectory("childDir"); directory.getDirectoryOrThrow("childDir"); // child directories directory.getDirectories(); // parent directory, if it exists directory.getParent(); </code></pre> </div> Or from the main ast object: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>ast.getRootDirectories(); // gets directories without a parent ast.getDirectories(); // gets all the directories ast.getDirectory("path/to/directory"); ast.getDirectoryOrThrow("path/to/directory"); </code></pre> </div> <h3 id="adding">Adding</h3> On a directory: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>const childDirectory = directory.addExistingDirectory("childDir"); // or addDirectoryIfExists </code></pre> </div> Or main ast object: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>const directory = ast.addExistingDirectory("path/to/dir"); // or addDirectoryIfExists </code></pre> </div> <h3 id="creating">Creating</h3> On a directory <div class="language-ts highlighter-rouge"><pre class="highlight"><code>const childDir = directory.createDirectory("childDir"); </code></pre> </div> Or main ast object: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>const directory = ast.createDirectory("path/to/dir"); </code></pre> </div> <h2 id="directory">Directory</h2> <h3 id="path-and-name">Path and name</h3> <div class="language-ts highlighter-rouge"><pre class="highlight"><code>// returns the full path (ex. /home/david/project/) const path = directory.getPath(); // returns only the directory name (ex. project) const baseName = directory.getBaseName(); </code></pre> </div> <h3 id="parent-directory">Parent directory</h3> <div class="language-ts highlighter-rouge"><pre class="highlight"><code>const parentDir = directory.getParent(); // or getParentOrThrow() </code></pre> </div> <h3 id="child-directories">Child directories</h3> <div class="language-ts highlighter-rouge"><pre class="highlight"><code>const childDirs = directory.getDirectories(); </code></pre> </div> <h3 id="ancestor--descendant">Ancestor / Descendant</h3> Check if a directory is an ancestor or descendant of another directory: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>grandParentDir.isAncestorOf(childDir); // true childDir.isDescendantOf(grandParentDir); // true </code></pre> </div> Or if a directory is an ancestor of a source file: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>grandParentDir.isAncestorOf(childSourceFile); // true parentDir.isAncestorOf(childSourceFile); // true </code></pre> </div> <h3 id="source-files">Source files</h3> <div class="language-ts highlighter-rouge"><pre class="highlight"><code>const sourceFiles = directory.getSourceFiles(); const sourceFile = directory.getSourceFile("someFile.ts"); // or getSourceFileOrThrow const indexFile = directory.addExistingSourceFile("index.ts"); // or addSourceFileIfExists const descendantSourceFiles = directory.getDescendantSourceFiles(); </code></pre> </div> <h3 id="saving">Saving</h3> Save all the unsaved source files: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>directory.saveUnsavedSourceFiles(); directory.saveUnsavedSourceFilesSync(); // slow </code></pre> </div> <h3 id="emitting">Emitting</h3> It’s possible to only specific directories: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>// always check result.getEmitSkipped() to make sure the emit was successful const result = await directory.emit(); directory.emitSync(); // slow </code></pre> </div> Or specify the output directories (specify a path relative from the directory or an absolute paths): <div class="language-ts highlighter-rouge"><pre class="highlight"><code>directory.emit({ outDir: "out", declarationDir: "declarations" }); </code></pre> </div> And of course, specify to only emit declaration files: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>directory.emit({ emitOnlyDtsFiles: true }); </code></pre> </div> <h3 id="copying">Copying</h3> Copy the directory to a new directory: <div class="highlighter-rouge"><pre class="highlight"><code>// ex. copies C:\MyProject\dir to C:\MyProject\newDir directory.copy("../newDir"); directory.copy("../newDir", { overwrite: true }); // don't throw if it will overwrite a file directory.copy("C:\\test"); // or absolute </code></pre> </div> Note that the directory and source files, in all these cases, won’t be created until calling save on them. <h3 id="deleting">Deleting</h3> Deletes the directory and all its descendants from the file system: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>directory.delete(); // or directory.deleteSync(); </code></pre> </div> Note that after doing this, the directory object and all its descendant source files and directories will not be available. <h3 id="removing">Removing</h3> Removes from main ast object: <div class="language-ts highlighter-rouge"><pre class="highlight"><code>directory.remove(); </code></pre> </div> Note that after doing this, the directory object and all its descendant source files and directories will not be available. If you want to use them again, then you will need to re-add them. </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>  </body> </html>