typescript-eslint · JamesHenry · Sep 22, 2018 · Sep 22, 2018 · Sep 26, 2018 · Sep 26, 2018
diff --git a/packages/typescript-estree/.codecov.yml b/packages/typescript-estree/.codecov.yml
@@ -0,0 +1,8 @@
+coverage:
+  status:
+    patch:
+      default:
+        target: 90%
+    project:
+      default:
+        target: auto
diff --git a/packages/typescript-estree/.editorconfig b/packages/typescript-estree/.editorconfig
@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+quote_type = single
diff --git a/packages/typescript-estree/.gitattributes b/packages/typescript-estree/.gitattributes
@@ -0,0 +1,5 @@
+* text=auto
+*.js eol=lf
+*.ts eol=lf
+*.tsx eol=lf
+*.yml eol=lf
diff --git a/packages/typescript-estree/.github/ISSUE_TEMPLATE.md b/packages/typescript-estree/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,13 @@
+**What version of TypeScript are you using?**
+
+**What version of `typescript-estree` are you using?**
+
+**What code were you trying to parse?**
+
+```ts
+// Put your code here
+```
+
+**What did you expect to happen?**
+
+**What actually happened?**
diff --git a/packages/typescript-estree/.gitignore b/packages/typescript-estree/.gitignore
@@ -0,0 +1,9 @@
+build
+coverage
+node_modules
+npm-debug.log
+_test.js
+.DS_Store
+.vscode
+.idea
+dist
diff --git a/packages/typescript-estree/.npmrc b/packages/typescript-estree/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/packages/typescript-estree/.prettierignore b/packages/typescript-estree/.prettierignore
@@ -0,0 +1 @@
+tests/fixtures/**/*
diff --git a/packages/typescript-estree/.travis.yml b/packages/typescript-estree/.travis.yml
@@ -0,0 +1,27 @@
+language: node_js
+cache:
+  yarn: true
+  directories:
+    - node_modules
+notifications:
+  email: false
+node_js:
+  - '11'
+  - '10'
+  - '9'
+  - '8'
+  - '6'
+install:
+  - yarn --ignore-engines
+script:
+  - commitlint-travis
+  - yarn check-format
+  - yarn test
+  - yarn build
+  - yarn global add codecov
+after_success:
+  - codecov
+  - yarn travis-deploy-once "yarn semantic-release"
+branches:
+  only:
+    - master
diff --git a/packages/typescript-estree/LICENSE b/packages/typescript-estree/LICENSE
@@ -0,0 +1,26 @@
+TypeScript ESTree
+
+Originally extracted from:
+
+TypeScript ESLint Parser
+Copyright JS Foundation and other contributors, https://js.foundation
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/packages/typescript-estree/README.md b/packages/typescript-estree/README.md
@@ -0,0 +1,139 @@
+<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.
diff --git a/packages/typescript-estree/jest.config.js b/packages/typescript-estree/jest.config.js
@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = {
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest'
+  },
+  testRegex: './tests/(lib/.*\\.(jsx?|tsx?)|ast-alignment/spec\\.ts)$',
+  collectCoverage: false,
+  collectCoverageFrom: ['src/**/*.{js,jsx,ts,tsx}'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  coverageReporters: ['text-summary', 'lcov']
+};
diff --git a/packages/typescript-estree/package.json b/packages/typescript-estree/package.json
@@ -0,0 +1,90 @@
+{
+  "name": "typescript-estree",
+  "description": "A parser that converts TypeScript source code into an ESTree compatible form",
+  "homepage": "https://github.com/JamesHenry/typescript-estree",
+  "main": "dist/parser.js",
+  "version": "0.0.0-development",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=6.14.0"
+  },
+  "repository": "JamesHenry/typescript-estree",
+  "bugs": {
+    "url": "https://github.com/JamesHenry/typescript-estree/issues"
+  },
+  "license": "BSD-2-Clause",
+  "devDependencies": {
+    "@babel/code-frame": "7.0.0",
+    "@babel/parser": "7.2.3",
+    "@commitlint/cli": "^7.1.2",
+    "@commitlint/config-conventional": "^7.1.2",
+    "@commitlint/travis-cli": "^7.1.2",
+    "@types/babel-code-frame": "^6.20.1",
+    "@types/jest": "^23.3.9",
+    "@types/lodash.isplainobject": "^4.0.4",
+    "@types/lodash.unescape": "^4.0.4",
+    "@types/node": "^10.12.2",
+    "@types/semver": "^5.5.0",
+    "@types/shelljs": "^0.8.0",
+    "cz-conventional-changelog": "2.1.0",
+    "glob": "7.1.2",
+    "husky": "0.14.3",
+    "jest": "23.6.0",
+    "lint-staged": "7.3.0",
+    "lodash.isplainobject": "4.0.6",
+    "prettier": "^1.14.3",
+    "semantic-release": "^15.9.16",
+    "shelljs": "0.8.2",
+    "travis-deploy-once": "^5.0.8",
+    "ts-jest": "^23.10.4",
+    "typescript": "~3.2.1"
+  },
+  "keywords": [
+    "ast",
+    "estree",
+    "ecmascript",
+    "javascript",
+    "typescript",
+    "parser",
+    "syntax"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "jest --coverage",
+    "unit-tests": "jest \"./tests/lib/.*\"",
+    "ast-alignment-tests": "jest spec.ts",
+    "precommit": "npm test && lint-staged",
+    "cz": "git-cz",
+    "commitmsg": "commitlint -E GIT_PARAMS",
+    "check-format": "prettier --list-different \"./**/*.{ts,js,json,md}\"",
+    "semantic-release": "semantic-release",
+    "travis-deploy-once": "travis-deploy-once"
+  },
+  "dependencies": {
+    "lodash.unescape": "4.0.1",
+    "semver": "5.5.0"
+  },
+  "peerDependencies": {
+    "typescript": "*"
+  },
+  "lint-staged": {
+    "*.{ts,js,json,md}": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  }
+}