Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

Add tslint-playground to README and bug report template. #4150

Merged
merged 7 commits into from Jun 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Expand Up @@ -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)

<!--
Bug reports for rules should include a reproduction using the tslint-playground website. Click the `Save to URL` button and paste the URL here.
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
-->

#### TypeScript code being linted

```ts
Expand Down
9 changes: 6 additions & 3 deletions README.md
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down