Skip to content

Commit

Permalink
Add readme and dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
p.kabir committed May 20, 2019
1 parent 5cc0374 commit 3d96b8c
Show file tree
Hide file tree
Showing 3 changed files with 523 additions and 1 deletion.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# eslint-config-clean-code

Linter rules for clean and fast TypeScript development

# Why?

Because every TypeScript developer deserves not to think about code style and minor approaches.

# Installation

1. `npm install --save-dev eslint-config-clean-code`
1. In your `.eslintrc` file at the project root, add `extends: eslint-config-clean-code`.
1. Customise the rules as required.

# Choices

## Single automatic code formatting

We consciously disable rules related to whitespace, indents, etc. and recommend using [`Prettier`](https://prettier.io/docs/en/install.html) instead, as a complementary tool to your linter. Having wasted numerous workdays bickering about minor formatting issues, this is the only sane choice for all projects, in our opinion.
Loading

0 comments on commit 3d96b8c

Please sign in to comment.