# typescript-estree

> A parser that converts TypeScript source code into an ESTree compatible form

Latest version **18.1.0** (published 2019-01-13) · BSD-2-Clause license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install typescript-estree
pnpm add typescript-estree
yarn add typescript-estree
bun add typescript-estree
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 18.1.0 |
| Published | 2019-01-13 |
| First published | 2018-09-22 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.14.0 |
| Dependencies | 2 |
| Unpacked size | 215.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 85 |
| Maintainers | jameshenry |
| Keywords | ast, estree, ecmascript, javascript, typescript, parser, syntax |

## Links

- npm: https://www.npmjs.com/package/typescript-estree
- Repository: https://github.com/JamesHenry/typescript-estree
- Issues: https://github.com/JamesHenry/typescript-estree/issues
- npm.io page: https://npm.io/package/typescript-estree

## Dependencies (2)

- [semver](https://npm.io/package/semver.md) 5.5.0
- [lodash.unescape](https://npm.io/package/lodash.unescape.md) 4.0.1

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 18.1.0 (latest) — 2019-01-13
- 6.0.0-rc.1 (next) — 2018-11-26
- 18.0.0 — 2019-01-12
- 17.0.0 — 2019-01-12
- 16.0.0 — 2019-01-12
- 15.0.0 — 2019-01-10
- 14.0.0 — 2019-01-10
- 13.6.0 — 2019-01-10
- 13.5.3 — 2019-01-10
- 13.5.2 — 2019-01-06
- 13.5.1 — 2019-01-06
- 13.5.0 — 2019-01-06
- 13.4.1 — 2019-01-06
- 13.4.0 — 2019-01-06
- 13.3.0 — 2019-01-06
- … 32 more at https://npm.io/package/typescript-estree/versions

## README

<h1 align="center">TypeScript ESTree</h1>

<p align="center">A parser that converts TypeScript source code into an <a href="https://github.com/estree/estree">ESTree</a>-compatible form</p>

<p align="center">
    <a href="https://travis-ci.org/JamesHenry/typescript-estree"><img src="https://img.shields.io/travis/JamesHenry/typescript-estree.svg?style=flat-square" alt="Travis"/></a>
    <a href="https://github.com/JamesHenry/typescript-estree/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/typescript-estree.svg?style=flat-square" alt="GitHub license" /></a>
    <a href="https://www.npmjs.com/package/typescript-estree"><img src="https://img.shields.io/npm/v/typescript-estree.svg?style=flat-square" alt="NPM Version" /></a>
    <a href="https://www.npmjs.com/package/typescript-estree"><img src="https://img.shields.io/npm/dt/typescript-estree.svg?style=flat-square" alt="NPM Downloads" /></a>
    <a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" /></a>
    <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square" alt="semantic-release" /></a>
</p>

<br>

## About

This parser is somewhat generic and robust, and could be used to power any use-case which requires taking TypeScript source code and producing an ESTree-compatible AST.

In fact, it is already used within these hyper-popular open-source projects to power their TypeScript support:

- [ESLint](https://eslint.org), the pluggable linting utility for JavaScript and JSX
  - See [typescript-eslint-parser](https://github.com/eslint/typescript-eslint-parser) for more details
- [Prettier](https://prettier.io), an opinionated code formatter

## Installation

```
npm install --save typescript-estree
```

## API

### parse(code, options)

Parses the given string of code with the options provided and returns an ESTree-compatible AST. The options object has the following properties:

```javascript
{
    // attach range information to each node
    range: false,

    // attach line/column location information to each node
    loc: false,

    // create a top-level tokens array containing all tokens
    tokens: false,

    // create a top-level comments array containing all comments
    comment: false,

    // enable parsing JSX. For more details, see https://www.typescriptlang.org/docs/handbook/jsx.html
    jsx: false,

    /*
     * The JSX AST changed the node type for string literals
     * inside a JSX Element from `Literal` to `JSXText`.
     * When value is `true`, these nodes will be parsed as type `JSXText`.
     * When value is `false`, these nodes will be parsed as type `Literal`.
     */
    useJSXTextNode: false,

    // Cause the parser to error if it encounters an unknown AST node type (useful for testing)
    errorOnUnknownASTType: false,

    /*
     * Allows overriding of function used for logging.
     * When value is `false`, no logging will occur.
     * When value is not provided, `console.log()` will be used.
     */
    loggerFn: undefined
}
```

Example usage:

```javascript
const parser = require('typescript-estree');
const code = `const hello: string = 'world';`;
const ast = parser.parse(code, {
  range: true,
  loc: true
});
```

### version

Exposes the current version of typescript-estree as specified in package.json.

Example usage:

```javascript
const parser = require('typescript-estree');
const version = parser.version;
```

### AST_NODE_TYPES

Exposes an object that contains the AST node types produced by the parser.

Example usage:

```javascript
const parser = require('typescript-estree');
const astNodeTypes = parser.AST_NODE_TYPES;
```

## Supported TypeScript Version

We will always endeavor to support the latest stable version of TypeScript.

The version of TypeScript currently supported by this parser is `~3.2.1`. This is reflected in the `devDependency` requirement within the package.json file, and it is what the tests will be run against. We have an open `peerDependency` requirement in order to allow for experimentation on newer/beta versions of TypeScript.

If you use a non-supported version of TypeScript, the parser will log a warning to the console.

**Please ensure that you are using a supported version before submitting any issues/bug reports.**

## Reporting Issues

Please check the current list of open and known issues and ensure the issue has not been reported before. When creating a new issue provide as much information about your environment as possible. This includes:

- TypeScript version
- The `typescript-estree` version

## AST Alignment Tests

A couple of years after work on this parser began, the TypeScript Team at Microsoft began [officially supporting TypeScript parsing via Babel](https://blogs.msdn.microsoft.com/typescript/2018/08/27/typescript-and-babel-7/).

I work closely with TypeScript Team and we are gradually aliging the AST of this project with the one produced by Babel's parser. To that end, I have created a full test harness to compare the ASTs of the two projects which runs on every PR, please see the code for more details.

## Build/Test Commands

- `npm test` - run all tests
- `npm run unit-tests` - run only unit tests
- `npm run ast-alignment-tests` - run only Babylon AST alignment tests

## License

TypeScript ESTree inherits from the the original TypeScript ESLint Parser license, as the majority of the work began there. It is licensed under a permissive BSD 2-clause license.

---
_Source: https://npm.io/package/typescript-estree · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._