typescript-eslint · JamesHenry · Jan 15, 2019 · Jan 4, 2017 · Jan 4, 2017 · Jan 4, 2017
diff --git a/.github/ISSUE_TEMPLATE/typescript-eslint-parser.md b/.github/ISSUE_TEMPLATE/typescript-eslint-parser.md
@@ -0,0 +1,13 @@
+**What version of TypeScript are you using?**
+
+**What version of `typescript-eslint-parser` are you using?**
+
+**What code were you trying to parse?**
+
+```ts
+// Put your code here
+```
+
+**What did you expect to happen?**
+
+**What happened?**
diff --git a/.github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/typescript-estree.md b/.github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/typescript-estree.md
diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,6 @@
 **/tests/fixtures/**/*
 **/dist
-**/coverage
+**/coverage
+
+# Temp ignore typescript-eslint-parser
+**/typescript-eslint-parser
diff --git a/.travis.yml b/.travis.yml
@@ -14,10 +14,14 @@ node_js:
 install:
   - yarn --ignore-engines
 script:
+  # TODO: Reenable after migrations are complete
   # - commitlint-travis
   - yarn check-format
   - yarn test
   - yarn build
+  # TODO: Reimplement automated integration-tests from typescript-eslint-parser
+  # for the monorepo, after the migrations are complete
+  # yarn integration-tests
   - yarn global add codecov
 after_success:
   - codecov

diff --git a/package.json b/package.json
@@ -53,6 +53,7 @@
     "@types/semver": "^5.5.0",
     "@types/shelljs": "^0.8.0",
     "cz-conventional-changelog": "2.1.0",
+    "eslint": "^4.19.1",
     "glob": "7.1.2",
     "husky": "0.14.3",
     "jest": "23.6.0",

diff --git a/packages/typescript-eslint-parser/CHANGELOG.md b/packages/typescript-eslint-parser/CHANGELOG.md
diff --git a/packages/typescript-eslint-parser/LICENSE b/packages/typescript-eslint-parser/LICENSE
@@ -0,0 +1,22 @@
+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-eslint-parser/README.md b/packages/typescript-eslint-parser/README.md
@@ -0,0 +1,108 @@
+# TypeScript ESLint Parser
+
+An ESLint custom parser which leverages [TypeScript ESTree](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/typescript-estree) to allow for ESLint to lint TypeScript source code.
+
+
+## Installation:
+
+```sh
+npm install --save-dev typescript-eslint-parser
+```
+
+## Usage
+
+In your ESLint configuration file, set the `parser` property:
+
+```json
+{
+    "parser": "typescript-eslint-parser"
+}
+```
+
+There is sometimes an incorrect assumption that the parser itself is what does everything necessary to facilitate the use of ESLint with TypeScript. In actuality, it is the combination of the parser _and_ one or more plugins which allow you to maximize your usage of ESLint with TypeScript.
+
+For example, once this parser successfully produces an AST for the TypeScript source code, it might well contain some information which simply does not exist in a standard JavaScript context, such as the data for a TypeScript-specific construct, like an `interface`.
+
+The core rules built into ESLint, such as `indent` have no knowledge of such constructs, so it is impossible to expect them to work out of the box with them.
+
+Instead, you also need to make use of one more plugins which will add or extend rules with TypeScript-specific features.
+
+By far the most common case will be installing the [eslint-plugin-typescript](https://github.com/nzakas/eslint-plugin-typescript) plugin, but there are also other relevant options available such a [eslint-plugin-tslint](https://github.com/JamesHenry/eslint-plugin-tslint).
+
+## Configuration
+
+The following additional configuration options are available by specifying them in [`parserOptions`](https://eslint.org/docs/user-guide/configuring#specifying-parser-options) in your ESLint configuration file.
+
+- **`jsx`** - default `false`. Enable parsing JSX when `true`. More details can be found [here](https://www.typescriptlang.org/docs/handbook/jsx.html).
+    - It's `false` on `*.ts` files regardless of this option.
+    - It's `true` on `*.tsx` files regardless of this option.
+    - Otherwise, it respects this option.
+
+- **`useJSXTextNode`** - default `true`. Please set `false` if you use this parser on ESLint v4. If this is `false`, the parser creates the AST of JSX texts as the legacy style.
+
+### .eslintrc.json
+
+```json
+{
+    "parser": "typescript-eslint-parser",
+    "parserOptions": {
+        "jsx": true,
+        "useJSXTextNode": true
+    }
+}
+```
+
+## 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:
+
+- ESLint Version
+- TypeScript version
+- The `typescript-eslint-parser` version
+- ESLint config or rules and plugins currently enabled
+
+## Integration Tests
+
+We have a very flexible way of running integration tests which connects all of the moving parts of the usage of this parser in the ESLint ecosystem.
+
+We run each test within its own docker container, and so each one has complete autonomy over what dependencies/plugins are installed and what versions are used. This also has the benefit of not bloating the `package.json` and `node_modules` of the parser project itself.
+
+> If you are going to submit an issue related to the usage of this parser with ESLint, please consider creating a failing integration test which clearly demonstrates the behavior. It's honestly super quick!
+
+You just need to duplicate one of the existing test sub-directories found in `tests/integration/`, tweak the dependencies and ESLint config to match what you need, and add a new entry to the docker-compose.yml file which matches the format of the existing ones.
+
+Then run:
+
+```sh
+npm run integration-tests
+```
+
+If you ever need to change what gets installed when the docker images are built by docker-compose, you will first need to kill the existing containers by running:
+
+```sh
+npm run kill-integration-test-containers
+```
+
+## Contributing
+
+Issues and pull requests will be triaged and responded to as quickly as possible. We operate under the [ESLint Contributor Guidelines](http://eslint.org/docs/developer-guide/contributing), so please be sure to read them before contributing. If you're not sure where to dig in, check out the [issues](https://github.com/eslint/typescript-eslint-parser/issues).
+
+## Build Commands
+
+- `npm test` - run all linting and tests
+- `npm run lint` - run all linting
+- `npm run integration-tests` - run only integration tests
+
+## License
+
+TypeScript ESLint Parser is licensed under a permissive BSD 2-clause license.