From 8b0d53fc1ab16c69241a06696788c8cb34c61af0 Mon Sep 17 00:00:00 2001 From: James Henry Date: Sun, 20 Jan 2019 10:44:07 -0500 Subject: [PATCH 1/2] docs(parser): some fixes and consistency --- packages/parser/README.md | 43 +++------------------------------------ 1 file changed, 3 insertions(+), 40 deletions(-) diff --git a/packages/parser/README.md b/packages/parser/README.md index 3a18f79735e6..77359a790f34 100644 --- a/packages/parser/README.md +++ b/packages/parser/README.md @@ -34,7 +34,7 @@ The core rules built into ESLint, such as `indent` have no knowledge of such con 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 [@typescript-eslint/eslint-plugin](https://github.com/nzakas/@typescript-eslint/eslint-plugin) plugin, but there are also other relevant options available such a [@typescript-eslint/eslint-plugin-tslint](https://github.com/JamesHenry/@typescript-eslint/eslint-plugin-tslint). +By far the most common case will be installing the [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin) plugin, but there are also other relevant options available such a [@typescript-eslint/eslint-plugin-tslint](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin-tslint). ## Configuration @@ -64,50 +64,13 @@ The following additional configuration options are available by specifying them ## 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 see https://github.com/typescript-eslint/typescript-eslint for the supported TypeScript version. **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 -``` - -## Build Commands - -- `npm test` - run all linting and tests -- `npm run lint` - run all linting -- `npm run integration-tests` - run only integration tests +Please use the @typescript-eslint/parser issue template when creating your issue and fill out the information requested as best you can. This will really help us when looking into your issue. ## License From f57733983eaf9e7662fc6266c9552090ba4a80ce Mon Sep 17 00:00:00 2001 From: James Henry Date: Sun, 20 Jan 2019 10:47:05 -0500 Subject: [PATCH 2/2] docs(plugin-tslint): fixes --- packages/eslint-plugin-tslint/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/eslint-plugin-tslint/README.md b/packages/eslint-plugin-tslint/README.md index 8ecccbd1001a..7a1cdf297aa4 100644 --- a/packages/eslint-plugin-tslint/README.md +++ b/packages/eslint-plugin-tslint/README.md @@ -23,10 +23,10 @@ Configure in your eslint config file: ```js { "plugins": [ - "tslint" + "@typescript-eslint/tslint" ], "rules": { - "tslint/config": ["warn", { + "@typescript-eslint/tslint/config": ["warn", { "lintFile": '', // path to tslint.json of your project "rules": { // tslint rules (will be used if `lintFile` is not specified) @@ -41,7 +41,7 @@ Configure in your eslint config file: ## Rules -Plugin contains only single rule `tslint/config`. +Plugin contains only single rule `@typescript-eslint/tslint/config`. ## Examples