krzkaczor/typestrict

ESLint config focused on maximizing type safety 💪

TypeStrict

Squash bugs before shipping them with TypeScript and ESLint!

ESLint config focused on maximizing type safety

Installation

npm install --save-dev @typescript-eslint/eslint-plugin eslint-plugin-sonarjs eslint-config-typestrict

👉 If you still use TSLint please use typestrict@1

Usage

In your .eslintrc.json:

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

Unfortunately, you need to install plugins that we depend on manually: @typescript-eslint/eslint-plugin, eslint-plugin-sonarjs

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 your code style or formatting.

TypeStrict combines rules from various rule sets: typescript-eslint, sonarJS,

Complete rules list

ESLint

• constructor-super
• no-invalid-this
• no-restricted-syntax (with "check-parameters" and {"ignore-pattern": "^_" })
• use-isnan

TypeScript ESLint

• @typescript-eslint/no-unused-vars with {"argsIgnorePattern": "^_"}
• @typescript-eslint/await-thenable
• @typescript-eslint/no-floating-promises
• @typescript-eslint/no-misused-new
• @typescript-eslint/restrict-plus-operands
• @typescript-eslint/no-unnecessary-condition

SonarTS

• no-all-duplicated-branches
• no-collection-size-mischeck
• no-duplicated-branches
• no-element-overwrite
• no-identical-conditions
• no-identical-expressions

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.

Logo by @codeandcats.

License

MIT by Krzysztof Kaczor

typestrict's Issues

Update tslint-sonarts dependency

Please update tslint-sonarts dependency to ^1.8.0 (currently "tslint-sonarts": "^1.7.0").

Deprecated TsLint Rules

Hello guys,

The Ts Lint rules no-unused-variable and no-use-before-declare are deprecated.

It results with some warning messages:

no-unused-variable is deprecated. Since TypeScript 2.9. Please use the built-in compiler checks instead.

no-use-before-declare is deprecated. Since TypeScript 2.9. Please use the built-in compiler checks instead.

Thanks

Replace eslint-plugin-sonarjs with eslint-plugin-radar

It's the same, but actively maintained and supports newest eslint.
The main reason is this: SonarSource/eslint-plugin-sonarjs#183

Logo Suggestion

I noticed the logo was an exact copy of the Apple bug emoji.

That's cool, it's a gorgeous emoji, but if you're open to it I wanted to propose a slightly customised version of the well known icon.

I basically took the existing logo and slapped some TypeScript blue on it.

Then I played around with putting it in a No Smoking/Ghost Buster's style cross.

I'd be delighted if you chose to use either of these but absolutely no worries if you're not interested. 👍

fead: add some more rules

Some new rules were added to TSLint lately, for example no-promise-as-boolean (changelog), that could be interesting to have in TypeStrict.

Any plans to support ESLint?

Since the core TypeScript and VS Code team is moving from TSLint to ESLint, and as ESLint is getting help from Microsoft with the TypeScript compatibility (see The future of TypeScript on ESLint) are there any plans for TypeStrict to support ESLint as well, like including an ESLint config with similar rules in addition to tslint.js?

TypeScript Roadmap: January - June 2019 - microsoft/TypeScript#29288:

ESLint already has the more-performant architecture we're looking for from a linter. Additionally, different communities of users often have lint rules (e.g. rules for React Hooks or Vue) that are built for ESLint, but not TSLint.

Given this, our editor team will be focusing on leveraging ESLint rather than duplicating work. For scenarios that ESLint currently doesn't cover (e.g. semantic linting or program-wide linting), we'll be working on sending contributions to bring ESLint's TypeScript support to parity with TSLint. As an initial testbed of how this works in practice, we'll be switching the TypeScript repository over to using ESLint, and sending any new rules upstream.

TypeScript Roadmap: July - December 2019 - microsoft/TypeScript#33118:

ESLint is now a capable linter for TypeScript projects. There is room for improvement in editor scenarios, but we'll focus on core editor functionality and performance for JavaScript/TypeScript. We will monitor TypeScript integration in ESLint and assist the project when needed.

rules require type information

When TSLint runs, I get the following in tslint output

Warning: The 'await-promise' rule requires type information.
Warning: The 'no-floating-promises' rule requires type information.
Warning: The 'no-inferred-empty-object-type' rule requires type information.
Warning: The 'restrict-plus-operands' rule requires type information.
Warning: The 'no-accessor-field-mismatch' rule requires type information.
Warning: The 'no-collection-size-mischeck' rule requires type information.
Warning: The 'no-dead-store' rule requires type information.
Warning: The 'no-element-overwrite' rule requires type information.
Warning: The 'no-gratuitous-expressions' rule requires type information.
Warning: The 'no-ignored-return' rule requires type information.
Warning: The 'no-self-assignment' rule requires type information.
Warning: The 'no-unused-array' rule requires type information.
Warning: The 'no-useless-cast' rule requires type information.
Warning: The 'no-variable-usage-before-declaration' rule requires type information.

How did you manage to solve this problem?

Broken links in the readme

@krzkaczor All of the SonarTS links in the readme are broken (404), see: https://github.com/krzkaczor/TypeStrict#sonarts

The readme in the SonarTS repo says: "TypeScript analysis for SonarQube was migrated to SonarJS plugin. This is a legacy repository used to produce an artifact required for backward compatibility with SonarQube." - see: https://github.com/SonarSource/SonarTS#readme

Is TypeStrict still using the legacy SonarTS or the newer SonarJS? Are there only links broken but the rules are working fine even after the deprecation of SonarTS?

I'll be teaching a TypeScript workshop on Oct 27 and I'd like to recommend TypeStrict so that's why I want to make sure everything is fine. Thanks!

Why the JS file?

Hi, I was wondering why you are defining your main file as js instead of json? I believe you only use js to extend tslint-microsoft-contrib and tslint-sonarts. Then why not just "extend" those libs the same way a user would extend yours, from json?

Branch for v1?

Hi,

The move to eslint was kind of disruptive. In hindsight it would have made more sense to create a new package for eslint and keep this one for tslint. But whatever it's done now.

Could you at least keep an active branch for v1 and link to it from the readme of master? This way there is a place to track the tslint branch?

Thanks.