Miss any of our Open RFC calls?Watch the recordings here! »

ts-morph

7.1.2 • Public • Published

ts-morph

npm version Build Status Coverage Status stable

TypeScript Compiler API wrapper. Provides an easier way to programmatically navigate and manipulate TypeScript and JavaScript code.

Formerly ts-simple-ast.

Overview

Main Features

  1. Wraps the compiler API objects to provide helper methods for getting information and programmatically changing files.
  2. Allows falling back to the compiler API objects if necessary (ex. classDeclaration.compilerNode or typeChecker.compilerObject).
  3. All changes are kept in memory (including file and directory moves) until specifying to save to the underlying file system.
  4. Changes are made to the text and wrapped nodes can be held onto between manipulations.

Getting Started

  1. Installing
  2. Instantiating
  3. Adding source files
  4. Getting source files
  5. Navigating
  6. Manipulating

Library Progress

This library is still under active development. Most common code manipulation/generation use cases are implemented, but there's still a lot of work to do. Please open an issue if you find a feature missing, bug, or question that isn't in the issue tracker.

Example

import { Project, StructureKind } from "ts-morph";
 
// initialize
const project = new Project({
    // Optionally specify compiler options, tsconfig.json, in-memory file system, and more here.
    // If you initialize with a tsconfig.json, then it will automatically populate the project
    // with the associated source files.
    // Read more: https://ts-morph.com/setup/
});
 
// add source files
project.addSourceFilesAtPaths("src/**/*.ts");
const myClassFile = project.createSourceFile("src/MyClass.ts", "export class MyClass {}");
const myEnumFile = project.createSourceFile("src/MyEnum.ts", {
    statements: [{
        kind: StructureKind.Enum,
        name: "MyEnum",
        isExported: true,
        members: [{ name: "member" }]
    }]
});
 
// get information
const myClass = myClassFile.getClassOrThrow("MyClass");
myClass.getName();          // returns: "MyClass"
myClass.hasExportKeyword(); // returns: true
myClass.isDefaultExport();  // returns: false
 
// manipulate
const myInterface = myClassFile.addInterface({
    name: "IMyInterface",
    isExported: true,
    properties: [{
        name: "myProp",
        type: "number"
    }]
});
 
myClass.rename("NewName");
myClass.addImplements(myInterface.getName());
myClass.addProperty({
    name: "myProp",
    initializer: "5"
});
 
project.getSourceFileOrThrow("src/ExistingFile.ts").delete();
 
// asynchronously save all the changes above
await project.save();
 
// get underlying compiler node from the typescript AST from any node
const compilerNode = myClassFile.compilerNode;

Or navigate existing compiler nodes created with the TypeScript compiler (the ts named export is the TypeScript compiler):

import { createWrappedNode, ClassDeclaration, ts } from "ts-morph";
 
// some code that creates a class declaration using the ts object
const classNode: ts.ClassDeclaration = ...;
 
// create and use a wrapped node
const classDec = createWrappedNode(classNode) as ClassDeclaration;
const firstProperty = classDec.getProperties()[0];
 
// ... do more stuff here ...

Install

npm i ts-morph

DownloadsWeekly Downloads

154,008

Version

7.1.2

License

MIT

Unpacked Size

1.51 MB

Total Files

6

Last publish

Collaborators

  • avatar