From d7163e1663518366e8400bdea8ac0e2c13f6d1a0 Mon Sep 17 00:00:00 2001 From: John Wiseheart Date: Sun, 16 Jun 2019 01:58:44 +0100 Subject: [PATCH] Add tslint-playground to README and bug report template. (#4150) * Add tslint-playground to docs * Review typos: caps, extra s * Removed release creation section * Comment-ified bug report template * Undid a few more master changes * Just a bit more fixing of the bug report... --- .github/ISSUE_TEMPLATE/bug_report.md | 6 ++++++ README.md | 9 ++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 35d96c2937d..6f67eaf423b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,6 +10,12 @@ about: Report a bug in TSLint - __TypeScript version__: - __Running TSLint via__: (pick one) CLI / Node.js API / VSCode / grunt-tslint / Atom / Visual Studio / etc +#### Reproduction using [TSLint Playground](https://palantir.github.io/tslint-playground) + + + #### TypeScript code being linted ```ts diff --git a/README.md b/README.md index aa9ca12aa14..634a0d2f3ae 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,11 @@ Please refer to the full installation & usage documentation on the [TSLint websi - [customization of TSLint](https://palantir.github.io/tslint/develop/custom-rules/). - [inline disabling and enabling of rules with comment flags](https://palantir.github.io/tslint/usage/rule-flags/) -## Custom rules & plugins +## TSLint Playground + +There is a sandbox environment for TSLint at [palantir.github.io/tslint-playground](https://palantir.github.io/tslint-playground/), which can be used to test rules and see how TSLint works. Issues can be filed against `tslint-playground` [here](https://github.com/palantir/tslint-playground). + +## Custom Rules & Plugins #### Custom rule sets from Palantir @@ -59,11 +63,10 @@ Prerequisites: - `node` v7+ - `yarn` v1.0+ -#### Quick start +#### Quick Start ```bash git clone git@github.com:palantir/tslint.git --config core.autocrlf=input --config core.eol=lf -cd tslint yarn yarn compile yarn test