From 582d4c499636209740063f93fe192d8db1850b6e Mon Sep 17 00:00:00 2001 From: mgechev Date: Mon, 11 Dec 2017 12:19:38 +0300 Subject: [PATCH] docs: update readme.md --- README.md | 48 ++++++++++++++++++++++-------------------------- 1 file changed, 22 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 9c4a698a9..c2565460d 100644 --- a/README.md +++ b/README.md @@ -60,8 +60,8 @@ Create the following `tslint.json` file like: ```json { - "extends": [ "codelyzer" ], - "rules":{ + "extends": ["codelyzer"], + "rules": { "angular-whitespace": [true, "check-interpolation", "check-semicolon"], "banana-in-box": true, "templates-no-negated-async": true, @@ -93,6 +93,7 @@ To run TSLint with this setup you can use one of the following alternatives: 1. Install codelyzer globally `npm install -g codelyzer` 2. Run TSLint from a package.json script by adding a script like `tslint .` to your package.json, similar to: + ``` "scripts": { ... @@ -100,6 +101,7 @@ To run TSLint with this setup you can use one of the following alternatives: ... }, ``` + Then run `npm run lint` B. Using codelyzer from node_modules directory @@ -108,10 +110,8 @@ Now create the following `tslint.json` file where your `node_modules` directory ```json { - "rulesDirectory": [ - "node_modules/codelyzer" - ], - "rules":{ + "rulesDirectory": ["node_modules/codelyzer"], + "rules": { "angular-whitespace": [true, "check-interpolation", "check-semicolon"], "banana-in-box": true, "templates-no-negated-async": true, @@ -236,7 +236,6 @@ Codelyzer supports any template and style language by custom hooks. If you're us var sass = require('node-sass'); module.exports = { - // Definition of custom interpolation strings interpolation: ['{{', '}}'], @@ -273,9 +272,7 @@ module.exports = { // Custom predefined directives in case you get error for // missing property and you are using a template reference - predefinedDirectives: [ - { selector: 'form', exportAs: 'ngForm' } - ], + predefinedDirectives: [{ selector: 'form', exportAs: 'ngForm' }], // None = 0b000, Error = 0b001, Info = 0b011, Debug = 0b111 logLevel: 0b111 @@ -284,27 +281,26 @@ module.exports = { ## Contributors -[mgechev](https://github.com/mgechev) |[preslavsh](https://github.com/preslavsh) |[wKoza](https://github.com/wKoza) |[rokerkony](https://github.com/rokerkony) |[GregOnNet](https://github.com/GregOnNet) |[eppsilon](https://github.com/eppsilon) | -:---: |:---: |:---: |:---: |:---: |:---: | -[mgechev](https://github.com/mgechev) |[preslavsh](https://github.com/preslavsh) |[wKoza](https://github.com/wKoza) |[rokerkony](https://github.com/rokerkony) |[GregOnNet](https://github.com/GregOnNet) |[eppsilon](https://github.com/eppsilon) | +| [mgechev](https://github.com/mgechev) | [preslavsh](https://github.com/preslavsh) | [wKoza](https://github.com/wKoza) | [rokerkony](https://github.com/rokerkony) | [GregOnNet](https://github.com/GregOnNet) | [eppsilon](https://github.com/eppsilon) | +| :---------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------: | +| [mgechev](https://github.com/mgechev) | [preslavsh](https://github.com/preslavsh) | [wKoza](https://github.com/wKoza) | [rokerkony](https://github.com/rokerkony) | [GregOnNet](https://github.com/GregOnNet) | [eppsilon](https://github.com/eppsilon) | -[csvn](https://github.com/csvn) |[ghsyeung](https://github.com/ghsyeung) |[Kobzol](https://github.com/Kobzol) |[lazarljubenovic](https://github.com/lazarljubenovic) |[clydin](https://github.com/clydin) |[connor4312](https://github.com/connor4312) | -:---: |:---: |:---: |:---: |:---: |:---: | -[csvn](https://github.com/csvn) |[ghsyeung](https://github.com/ghsyeung) |[Kobzol](https://github.com/Kobzol) |[lazarljubenovic](https://github.com/lazarljubenovic) |[clydin](https://github.com/clydin) |[connor4312](https://github.com/connor4312) | +| [csvn](https://github.com/csvn) | [ghsyeung](https://github.com/ghsyeung) | [Kobzol](https://github.com/Kobzol) | [lazarljubenovic](https://github.com/lazarljubenovic) | [clydin](https://github.com/clydin) | [connor4312](https://github.com/connor4312) | +| :----------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------: | +| [csvn](https://github.com/csvn) | [ghsyeung](https://github.com/ghsyeung) | [Kobzol](https://github.com/Kobzol) | [lazarljubenovic](https://github.com/lazarljubenovic) | [clydin](https://github.com/clydin) | [connor4312](https://github.com/connor4312) | -[Foxandxss](https://github.com/Foxandxss) |[Hotell](https://github.com/Hotell) |[comfroels](https://github.com/comfroels) |[plantain-00](https://github.com/plantain-00) |[nexus-uw](https://github.com/nexus-uw) |[rtfpessoa](https://github.com/rtfpessoa) | -:---: |:---: |:---: |:---: |:---: |:---: | -[Foxandxss](https://github.com/Foxandxss) |[Hotell](https://github.com/Hotell) |[comfroels](https://github.com/comfroels) |[plantain-00](https://github.com/plantain-00) |[nexus-uw](https://github.com/nexus-uw) |[rtfpessoa](https://github.com/rtfpessoa) | +| [Foxandxss](https://github.com/Foxandxss) | [Hotell](https://github.com/Hotell) | [comfroels](https://github.com/comfroels) | [plantain-00](https://github.com/plantain-00) | [nexus-uw](https://github.com/nexus-uw) | [rtfpessoa](https://github.com/rtfpessoa) | +| :--------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | +| [Foxandxss](https://github.com/Foxandxss) | [Hotell](https://github.com/Hotell) | [comfroels](https://github.com/comfroels) | [plantain-00](https://github.com/plantain-00) | [nexus-uw](https://github.com/nexus-uw) | [rtfpessoa](https://github.com/rtfpessoa) | -[Gillespie59](https://github.com/Gillespie59) |[Manduro](https://github.com/Manduro) |[karol-depka](https://github.com/karol-depka) |[leosvelperez](https://github.com/leosvelperez) |[Martin-Wegner](https://github.com/Martin-Wegner) |[eromano](https://github.com/eromano) | -:---: |:---: |:---: |:---: |:---: |:---: | -[Gillespie59](https://github.com/Gillespie59) |[Manduro](https://github.com/Manduro) |[karol-depka](https://github.com/karol-depka) |[leosvelperez](https://github.com/leosvelperez) |[Martin-Wegner](https://github.com/Martin-Wegner) |[eromano](https://github.com/eromano) | +| [Gillespie59](https://github.com/Gillespie59) | [Manduro](https://github.com/Manduro) | [karol-depka](https://github.com/karol-depka) | [leosvelperez](https://github.com/leosvelperez) | [Martin-Wegner](https://github.com/Martin-Wegner) | [eromano](https://github.com/eromano) | +| :-----------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------: | +| [Gillespie59](https://github.com/Gillespie59) | [Manduro](https://github.com/Manduro) | [karol-depka](https://github.com/karol-depka) | [leosvelperez](https://github.com/leosvelperez) | [Martin-Wegner](https://github.com/Martin-Wegner) | [eromano](https://github.com/eromano) | -[scttcper](https://github.com/scttcper) |[lacolaco](https://github.com/lacolaco) |[tmair](https://github.com/tmair) |[cexbrayat](https://github.com/cexbrayat) |[reduckted](https://github.com/reduckted) | -:---: |:---: |:---: |:---: |:---: | -[scttcper](https://github.com/scttcper) |[lacolaco](https://github.com/lacolaco) |[tmair](https://github.com/tmair) |[cexbrayat](https://github.com/cexbrayat) |[reduckted](https://github.com/reduckted) | +| [scttcper](https://github.com/scttcper) | [lacolaco](https://github.com/lacolaco) | [tmair](https://github.com/tmair) | [cexbrayat](https://github.com/cexbrayat) | [reduckted](https://github.com/reduckted) | [sagittarius-rev](https://github.com/sagittarius-rev) | +| :------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------: | +| [scttcper](https://github.com/scttcper) | [lacolaco](https://github.com/lacolaco) | [tmair](https://github.com/tmair) | [cexbrayat](https://github.com/cexbrayat) | [reduckted](https://github.com/reduckted) | [sagittarius-rev](https://github.com/sagittarius-rev) | ## License MIT -