As TSLint has grown in usage and popularity alongside of TypeScript, it also has evolved in terms of functionality and complexity. Today, all sorts of projects and products, from Angular 2 to the TypeScript compiler itself use TSLint to help keep their code high-quality.
Unfortunately, we’ve done a poor job of scaling the documentation and guides for TSLint as it has grown. For example, the only good way to see the possible rules TSLint can enforce and what they can do is to scroll through the quite-long TSLint README. Each rule is accompanied by a short description of its functionality, but nowhere does it explain why the rule is actually useful. There’s also a short description of the rule’s options, but the syntax for specifying these options is often unclear.
This website, in its current, very simple form, marks the beginning of a renewed focus on developer and user experience. But it’s just the tip of the iceberg in changes to come - other things in progress include:
- A documentation overhaul that will provide more comprehensive and clear documentation on TSLint and will make it easier to navigate that documentation.
- A new
--initfeature in the TSLint CLI that will make it easier to generate a sensible initial
- An improved contributor experience that will make things easier for those who want to contribute code to TSLint.
Feedback is always great, so please comment on any of the above GitHub issues and let us know what you would like to see to make TSLint user experience even better!