tslint-consistent-codestyle

v1.16.0

Additional rules to enforce constistent code style with tslint For more information about how to use this package see README

Latest version published 5 years ago

License: MIT

NPM

GitHub

Package Health Score

53 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.16.0	\|	09/2019	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.15.1	\|	03/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.2	\|	02/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.3	\|	12/2016		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.10	\|	11/2016		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (85,615)

GitHub Stars: 209
Forks: 30
Contributors: 20

Direct Usage Popularity

The npm package tslint-consistent-codestyle receives a total of 85,615 downloads a week. As such, we scored tslint-consistent-codestyle popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package tslint-consistent-codestyle, we found that it has been starred 209 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the tslint-consistent-codestyle repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like tslint-consistent-codestyle is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 28
Open PR: 5
Last Release: 5 years ago
Last Commit: 5 years ago

Further analysis of the maintenance status of tslint-consistent-codestyle based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for tslint-consistent-codestyle is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 3 Direct
Versions: 50
Install Size: 248 kB
Dist-tags: 1
# of Files: 48
Maintainers: 1
TS Typings: No

tslint-consistent-codestyle has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Purpose

The rules in this package can be used to enforce consistent code style.

Usage

Install from npm to your devDependencies (https://www.npmjs.com/package/tslint-consistent-codestyle)

npm install --save-dev tslint-consistent-codestyle

With TSLint

Configure tslint to use tslint-consistent-codestyle:

This package provides an empty configuration preset that just contains the rulesDirectory. That means you can easily use the rules in this package, but don't get any predefined configuration. To use it, just add it to the extends array in your tslint.json:

{
   "extends": ["tslint-consistent-codestyle"]
   "rules": {
     ...
   }
}

As of tslint@5.2.0 you can also use tslint-consistent-codestyle as rulesDirectory:

{
   "rulesDirectory": ["tslint-consistent-codestyle"]
   "rules": {
     ...
   }
}

Now configure some of the new rules.

With Wotan

This package provides all rules for both TSLint and Wotan.

To use rules from this package, add the following to your .wotanrc.yaml file:

extends:
  - tslint-consistent-codestyle # makes rules from the package available with the 'tcc/' prefix
rules: # now configure the rules you want to use, remember to use the 'tcc/' prefix
  tcc/no-collapsible-if: error
  tcc/no-unused:
    options: 'ignore-parameters'

Rules

Rule	Description
const-parameters	Declare parameters as `const` with JsDoc `/** @const */`
early-exit	Recommends to use an early exit instead of a long `if` block.
ext-curly	Enforces where to consistently use curly braces where not strictly necessary.
naming-convention	Fine grained configuration to enforce consistent naming for almost everything. E.g. variables, functions, classes, methods, parameters, enums, etc.
no-as-type-assertion	Prefer `foo` over `foo as Type`.
no-accessor-recursion	Don't use `get foo() { return this.foo; }`. This is most likely a typo.
no-collapsible-if	Identifies nested if statements that can be combined into one.
no-else-after-return	Like no-else-return from eslint.
no-return-undefined	Just `return;` instead of `return undefined;`.
no-static-this	Ban the use of `this` in static methods.
no-unnecessary-else	Like `no-else-after-return` but better.
no-unnecessary-type-annotation	Finds type annotations that can safely be removed.
no-unused	Find dead code and unused declarations.
no-var-before-return	Checks if the returned variable is declared right before the `return` statement.
object-shorthand-properties-first	Shorthand properties should precede regular properties.
parameter-properties	Configure how and where to declare parameter properties.
prefer-const-enum	Prefer `const enum` where possible.
prefer-while	Prefer a `while` loop instead of a `for` loop without initializer and incrementer.

tslint-consistent-codestyle dependencies

@fimbul/bifrost tslib tsutils

tslint-consistent-codestyle development dependencies

@fimbul/mithotyn @fimbul/valtyr @fimbul/wotan coveralls github-release-from-changelog npm-run-all nyc rimraf tslint typescript

FAQs

What is tslint-consistent-codestyle?

Additional rules to enforce constistent code style with tslint. Visit Snyk Advisor to see a full health score report for tslint-consistent-codestyle, including popularity, security, maintenance & community analysis.

Is tslint-consistent-codestyle popular?

The npm package tslint-consistent-codestyle receives a total of 85,615 weekly downloads. As such, tslint-consistent-codestyle popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is tslint-consistent-codestyle well maintained?

We found indications that tslint-consistent-codestyle is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is tslint-consistent-codestyle safe to use?

The npm package tslint-consistent-codestyle was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 18 April-2024, at 21:43 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP