sourcegraph/tslint

Name: tslint

Owner: Sourcegraph

Description: :vertical_traffic_light: An extensible linter for the TypeScript language

Forked from: palantir/tslint

Created: 2017-09-17 22:21:10.0

Updated: 2017-09-17 22:21:14.0

Pushed: 2017-09-17 23:05:43.0

Homepage: http://palantir.github.io/tslint/

Size: 13130

Language: TypeScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

NPM version Downloads Circle CI Join the chat at https://gitter.im/palantir/tslint

TSLint

TSLint is an extensible static analysis tool that checks TypeScript code for readability, maintainability, and functionality errors. It is widely supported across modern editors & build systems and can be customized with your own lint rules, configurations, and formatters.

TSLint supports:

Installation & Usage

Please refer to the full installation & usage documentation on the TSLint website. There, you'll find information about

Custom Rules & Plugins
Custom rule sets from Palantir Custom rule sets from the community

If we don't have all the rules you're looking for, you can either write your own custom rules or use rules implementations developed by the community. The repos below are a good source of custom rules:

Development

Requirements:

Quick Start
clone git@github.com:palantir/tslint.git --config core.autocrlf=input --config core.eol=lf

 compile
 test
Creating a new release
  1. Bump the version number in package.json and src/linter.ts
  2. Add release notes in CHANGELOG.md
    • Use ./scripts/generate-changelog.js (after building it with tsc -p scripts) to generate the changelog diff. This script expects a Github.com personal access token to exist at ~/github_token.txt with “repo” permissions.
  3. Commit with message Prepare release <version>
  4. Push your branch to GitHub and make a PR
  5. Once your PR is merged, wait for the tests to pass on CircleCI for develop
  6. Create a “Release” on GitHub with the proper tag version and notes from the changelog.
    • The tag should be identical to the version in package.json
  7. Run yarn run publish:local

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.