Adds tslint #33

gunzip · 2018-06-06T16:09:54Z

No description provided.

…wagger

digitalcitizenship · 2018-06-06T16:11:08Z

	Warnings
⚠️	Please include a Pivotal story at the beginning of the PR title (see below).
⚠️	Please include a description of your PR changes.

	Messages
📖	🎉 - congrats on your new release

Example of PR titles that include pivotal stories:

single story: [#123456] my PR title
multiple stories: [#123456,#123457,#123458] my PR title

New dependencies added: tslint, tslint-config-prettier, tslint-plugin-prettier, tslint-sonarts and typestrict.

tslint

Author: Unknown

Description: An extensible static analysis linter for the TypeScript language

Homepage: http://npmjs.com/package/tslint


Created	almost 5 years ago
Last Updated	about 1 month ago
License	Apache-2.0
Maintainers	1
Releases	162
Direct Dependencies	`babel-code-frame`, `builtin-modules`, `chalk`, `commander`, `diff`, `glob`, `js-yaml`, `minimatch`, `resolve`, `semver`, `tslib` and `tsutils`
Keywords	cli, typescript and linter

README

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:

an extensive set of core rules
custom lint rules
custom formatters (failure reporters)
inline disabling and enabling of rules with comment flags in source code
configuration presets (tslint:latest, tslint-react, etc.) and plugin composition
automatic fixing of formatting & style violations
integration with MSBuild, Grunt, Gulp, Atom, Eclipse, Emacs, Sublime, Vim, Visual Studio 2015, Visual Studio 2017, Visual Studio code, WebStorm and more

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

tslint-react - Lint rules related to React & JSX.
tslint-blueprint - Lint rules to enforce best practices with blueprintjs libraries

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:

ESLint rules for TSLint - Improve your TSLint with the missing ESLint Rules
tslint-microsoft-contrib - A set of TSLint rules used on some Microsoft projects
codelyzer - A set of tslint rules for static code analysis of Angular TypeScript projects
vrsource-tslint-rules
tslint-immutable - TSLint rules to disable mutation in TypeScript
tslint-consistent-codestyle - TSLint rules to enforce consistent code style in TypeScript
tslint-sonarts - Bug-finding rules based on advanced code models to spot hard to find errors in TypeScript
tslint-clean-code - A set of TSLint rules inspired by the Clean Code handbook
rxjs-tslint-rules - TSLint rules for RxJS

Development

Prerequisites:

node v7+
yarn v1.0+

Quick Start

git clone git@github.com:palantir/tslint.git --config core.autocrlf=input --config core.eol=lf
yarn
yarn compile
yarn test

Creating a new release

Bump the version number in package.json and src/linter.ts
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.
Commit with message Prepare release <version>
Push your branch to GitHub and make a PR
Once your PR is merged, wait for the tests to pass on CircleCI for develop
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
Run yarn run publish:local

tslint-config-prettier

Author: Alex Jover Morales

Description: Do you wanna use tslint and prettier without conflicts? tslint-config-prettier disables all conflicting rules that may cause such problems. Prettier takes care of formatting and tslint the rest.

Homepage: https://github.com/alexjoverm/tslint-config-prettier#readme


Created	12 months ago
Last Updated	17 days ago
License	MIT
Maintainers	1
Releases	14
Keywords	lint, tslint, ts-lint, prettier, config and typescript

README

tslint-config-prettier

👮 tslint + 💅 prettier = 😍

Do you want to use tslint and prettier without conflicts? tslint-config-prettier disables all conflicting rules that may cause such problems. Prettier takes care of the formatting whereas tslint takes care of all the other things.

Get started

npm install -D tslint-config-prettier

Make sure you've already set up tslint and prettier.

Then, extend your tslint.json, and make sure tslint-config-prettier is at the end:

{
  "extends": [
    "tslint:latest",
    "tslint-config-prettier"
  ]
}

More configuration

tslint-config-prettier also turns off formatting rules from the following rulesets, so you can use them safely.

{
  "extends": [
    "tslint:latest",
    "tslint-react",
    "tslint-eslint-rules",
    "tslint-config-prettier"
  ]
}

CLI helper tool

tslint-config-prettier is shipped with a little CLI tool to help you check if your configuration contains any rules that are in conflict with Prettier. (require tslint installed)

In order to execute the CLI tool, first add a script for it to package.json:

{
  "scripts": {
    "tslint-check": "tslint-config-prettier-check ./tslint.json"
  }
}

Then run npm run tslint-check.

Tutorials

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Credits

Made with ❤️ by @alexjoverm and all its contributors

tslint-plugin-prettier

Author: Ika

Description: Runs Prettier as a TSLint rule and reports differences as individual TSLint issues.

Homepage: https://github.com/ikatyang/tslint-plugin-prettier#readme


Created	10 months ago
Last Updated	8 months ago
License	MIT
Maintainers	1
Releases	4
Direct Dependencies	`eslint-plugin-prettier` and `tslib`
Keywords	prettier, tslint, tslint-plugin and tslint-rules

README

tslint-plugin-prettier

Runs Prettier as a TSLint rule and reports differences as individual TSLint issues.

NOTE: This project uses official reporter from eslint-plugin-prettier.

Changelog

Sample

a();;;
    ~~
;;;
~~~ [Delete `;;⏎;;;`]

var foo = ''
          ~~ [Replace `''` with `"";⏎`]

var foo= "";
       ~ [Insert `·`]

Install

# using npm
npm install --save-dev tslint-plugin-prettier prettier

# using yarn
yarn add --dev tslint-plugin-prettier prettier

Usage

(tslint.json)

for tslint@5.0.0+

{
  "extends": ["tslint-plugin-prettier"],
  "rules": {
    "prettier": true
  }
}

for tslint@5.2.0+

{
  "rulesDirectory": ["tslint-plugin-prettier"],
  "rules": {
    "prettier": true
  }
}

NOTE: To use this plugin, it'd better to also use tslint-config-prettier to disable all prettier-related rules, so as to avoid conflicts between existed rules.

Options

If there is no option provided, it'll try to load config file if possible (require prettier@1.7.0+), uses Prettier's default option if not found.

{
  "extends": ["tslint-plugin-prettier"],
  "rules": {
    "prettier": true
  }
}

If you'd like to specify where to find the config file, just put the search path (relative to process.cwd()) in the second argument, the following example shows how to use the config file from <cwd>/configs/.prettierrc:

{
  "extends": ["tslint-plugin-prettier"],
  "rules": {
    "prettier": [true, "configs"]
  }
}

If you'd like to specify options manually, just put Prettier Options in the second argument, for example:

{
  "extends": ["tslint-plugin-prettier"],
  "rules": {
    "prettier": [true, { "singleQuote": true }]
  }
}

Development

# lint
yarn run lint

# build
yarn run build

# test
yarn run test

License

MIT © Ika

tslint-sonarts

Author: Unknown

Description: SonarTS rules for TSLint

Homepage: https://github.com/SonarSource/SonarTS


Created	about 1 year ago
Last Updated	6 days ago
License	LGPL-3.0
Maintainers	3
Releases	35
Direct Dependencies	`immutable`
Keywords	sonarts, sonarqube, typescript and tslint

README

ERROR: No README data found!

typestrict

Author: Unknown

Description:

TypeStrict

Squash bugs before shipping them with Typescript and TSlint!

Homepage: https://github.com/krzkaczor/TypeStrict#readme


Created	6 months ago
Last Updated	about 18 hours ago
License	MIT
Maintainers	1
Releases	8
Direct Dependencies	`tslint-microsoft-contrib` and `tslint-sonarts`

README

TypeStrict

Squash bugs before shipping them with Typescript and TSlint!

Tslint config focused on maximizing type safety

Installation

npm install --save-dev typestrict

or

yarn add --dev typestrict

Usage

Create tslint.json:

{
  "extends": "typestrict"
  // ... add here your own rules
}

and run tslint -c ./tslint.json --project ./tsconfig.json --format stylish.

Remember to use strict compiler setting in tsconfig.json!

Description

All rules in this config are focused on catching bugs in your code and be as not annoying as possible. They don't
care about code style or formatting.

TypeStrict combines rules from various rule sets: tslint,
sonarTS,
tslint-microsoft-contrib.

Complete rules list

Tslint

await-promise
no-floating-promises
no-unused-variable (with "check-parameters" and {"ignore-pattern": "^_" })
no-use-before-declare
no-duplicate-super
no-inferred-empty-object-type
no-invalid-this
no-misused-new
restrict-plus-operands
use-isnan

SonarTS

Microsoft Contrib

promise-must-complete

Contributing

Do you have idea for new rule to be added? You don't agree with one of rules included? Feel free to create issue / PR.

License

MIT by Krzysztof Kaczor

Generated by 🚫 dangerJS

Spinelli Danilo added 18 commits June 5, 2018 13:22

feat: extend generator features

5f7cae7

fix: import order

644f1fe

tests: update snapshots

5f27178

fix: arrays

0cfc9a0

fix: withDefault

f344706

fix: comments

73aee62

fix: type aliases

668aaa8

docs: added comments

a95ec96

fix: typescript target

03a40ad

fix: enums

14ccfc1

update deps

7b6d877

fix: upgrade

a17f066

fix: tests

9b27ec0

feat: add one-of

0194cc9

chore: bump italia-ts-commons version

fb80cad

Merge remote-tracking branch 'origin/master' into 157911013-wsdl-to-s…

9ff6b6f

…wagger

added tslint

0fb4b65

3.7.2

a8a3eab

gunzip merged commit a6d66bf into master Jun 6, 2018

gunzip deleted the add-tslint branch June 7, 2018 08:06

Adds tslint #33

Adds tslint #33

Conversation

gunzip commented Jun 6, 2018

digitalcitizenship commented Jun 6, 2018

tslint

TSLint

Installation & Usage

Custom Rules & Plugins

Custom rule sets from Palantir

Custom rule sets from the community

Development

Quick Start

Creating a new release

tslint-config-prettier

tslint-config-prettier

👮 tslint + 💅 prettier = 😍

Get started

More configuration

CLI helper tool

Tutorials

Contributing

Related

Credits

tslint-plugin-prettier

tslint-plugin-prettier

Sample

Install

Usage

Options

Development

Related

License

tslint-sonarts

typestrict

TypeStrict

TypeStrict

Installation

Usage

Description

Complete rules list

Tslint

SonarTS

Microsoft Contrib

Contributing

License