KAM Typescript standards (TsLint)

Package to unify TsLint version and rules across projects. No need to install tslint anymore in your projects and maintain them all separatly. This package will provide you with tslint itself and with the rules we follow at KAM

Install

npm install -D tslint-config-kam

or

yarn add -D tslint-config-kam

Usage

Create the file tslint.json in your root folder and extend kam rules

{
	"extends": "tslint-config-kam"
}

You will need to provide your tsconfig.json

• For just linting and showing the report, run:

kamtslint tsconfig.json tslint.json

• For linting and autofix the problems (works either with -f or --fix), run:

kamtslint --fix tsconfig.json tslint.json

Note:

• Change tsconfig.json with the location of your typescript config file
• Change tslint.json with the location of your tslint config file

Recommended

• Add to your package.json scripts section the two following scripts:

"tslint": "kamtslint tsconfig.json tslint.json",
"tslint:fix": "kamtslint -f tsconfig.json tslint.json",

• Configure your IDE to use this rules so you don't need to be running the scripts while developing

KAM rules

Rules

Update the package

To update this package when a new version is ready, run:

npm update tslint-config-kam

or

yarn upgrade tslint-config-kam

Changelog

Changelog

Contributing

Please remember to increment the version on package.json following the SemVer specification.

1. Create a new branch from master following the next pattern:

feature/[TICKET-NUM-]short-description

Example: feature/KAM-123-add-rule-foobar

Note: If there is no ticket then just do feature/add-rule-foobar

2. Create a PR agains master. You will need to have at least one approval and the inspection job from the pipeline needs to pass correctly.

3. When merging PR to master, a Bitbucket pipeline will inspect the code and if everything is correct it will generate a new tag and push it. This tag number corresponds to the verison npm uses to install/update the package (version in package.json). If the tag is created correctly then it will be automatically publish on npm registry

License

This software is licensed under the terms of the MIT license. See LICENSE.md for the full license.