Repository files navigation

A set ofTSLint rules used to enforceClean Code practices. Inspired byClean Code: A Handbook of Agile Software Craftsmanship.

👉 Sign up forCodePass,the Quickest Way To Solve Your Coding Errors! 💥

npm install tslint-clean-code

In yourtslint.json file, extend this package.For example:

{"extends": ["tslint-clean-code"  ],"rules": {"newspaper-order":true  }}

You can also extend other tslint config packages to combine this plugin with other community custom rules.

Add the new rulesDirectory to your tslint task:

grunt.initConfig({  tslint: {    options: {      rulesDirectory: 'node_modules/tslint-clean-code/dist/src',      configuration: grunt.file.readJSON("tslint.json")    },    files: {      src: ['src/file1.ts', 'src/file2.ts']    }  }})

The tslint.json file does not change format when using this package. Just add our rule definitions to your existing tslint.json file.

To develop tslint-clean-code simply clone the repository, install dependencies and run grunt:

git clone git@github.com:Glavin001/tslint-clean-code.git --config core.autocrlf=input --config core.eol=lfcd tslint-clean-codenpm installgrunt allgrunt create-rule --rule-name=no-something-or-other

If command fails because of file access permissions, prefix it with sudo.

npm install -g node-inspector

Then run:

node-debug grunt mochaTest

Thenode-debug command will load Node Inspector in your default browser (works in Chrome and Opera only).

Set a breakpoint somewhere in your code and resume execution. Your breakpoint should be hit.

Thank you to maintainers oftslint-microsoft-contrib, from which this repository was forked. The initial structure was kept and new rules were added, this would not have been possible without Microsoft's awesome work!