tslint-immutable
Advanced tools
Comparing version 6.0.0 to 6.0.1
187
CHANGELOG.md
@@ -10,25 +10,32 @@ # Change Log | ||
## [v6.0.1] - 2019-07-02 | ||
### Added | ||
- Deprecation notice added to the readme. | ||
## [v6.0.0] - 2019-06-05 | ||
* Overhaul ignore-prefix, adding in ignore-suffix and ignore-pattern. | ||
- Overhaul ignore-prefix, adding in ignore-suffix and ignore-pattern. See PR [#137](https://github.com/jonaskello/tslint-immutable/pull/137) | ||
- Updated the list of rules included in each ruleset. See PR [#138](https://github.com/jonaskello/tslint-immutable/pull/138) | ||
## [v5.5.2] - 2019-03-25 | ||
* readonly-array rule with the option ignore-prefix set will now ignore nested arrays within an ignored variable. See [#132](https://github.com/jonaskello/tslint-immutable/issues/132). See PR [#133](https://github.com/jonaskello/tslint-immutable/pull/133) | ||
- readonly-array rule with the option ignore-prefix set will now ignore nested arrays within an ignored variable. See [#132](https://github.com/jonaskello/tslint-immutable/issues/132). See PR [#133](https://github.com/jonaskello/tslint-immutable/pull/133) | ||
## [v5.5.1] - 2019-03-22 | ||
* no-array-mutation now checks nested arrays. See [#134](https://github.com/jonaskello/tslint-immutable/issues/134). See PR [#135](https://github.com/jonaskello/tslint-immutable/pull/135) | ||
- no-array-mutation now checks nested arrays. See [#134](https://github.com/jonaskello/tslint-immutable/issues/134). See PR [#135](https://github.com/jonaskello/tslint-immutable/pull/135) | ||
## [v5.5.0] - 2019-03-21 | ||
* readonly-array rule now allows for the readonly keyword to specify an array as readonly. This is a new feature supported in TypeScript 3.4. See [#129](https://github.com/jonaskello/tslint-immutable/issues/129). See PR [#130](https://github.com/jonaskello/tslint-immutable/pull/130) | ||
- readonly-array rule now allows for the readonly keyword to specify an array as readonly. This is a new feature supported in TypeScript 3.4. See [#129](https://github.com/jonaskello/tslint-immutable/issues/129). See PR [#130](https://github.com/jonaskello/tslint-immutable/pull/130) | ||
## [v5.4.0] - 2019-03-14 | ||
* no-object-mutation rule now disallows Object.assign mutation on identifiers and property access expressions. See [#112](https://github.com/jonaskello/tslint-immutable/issues/112). See PR [#127](https://github.com/jonaskello/tslint-immutable/pull/127) | ||
- no-object-mutation rule now disallows Object.assign mutation on identifiers and property access expressions. See [#112](https://github.com/jonaskello/tslint-immutable/issues/112). See PR [#127](https://github.com/jonaskello/tslint-immutable/pull/127) | ||
## [v5.3.3] - 2019-03-12 | ||
* Fixed rule readonly-array with option ignore-return-type not checking within union, intersection and conditional types. This fix should now catch all return types that contain a nested array. See [#124](https://github.com/jonaskello/tslint-immutable/issues/124). See PR [#125](https://github.com/jonaskello/tslint-immutable/pull/125) | ||
- Fixed rule readonly-array with option ignore-return-type not checking within union, intersection and conditional types. This fix should now catch all return types that contain a nested array. See [#124](https://github.com/jonaskello/tslint-immutable/issues/124). See PR [#125](https://github.com/jonaskello/tslint-immutable/pull/125) | ||
@@ -39,3 +46,3 @@ ## [v5.3.2] - 2019-03-07 | ||
* Fixed rule readonly-array with option ignore-return-type not checking within tuple types. See [#121](https://github.com/jonaskello/tslint-immutable/issues/121). See PR [#122](https://github.com/jonaskello/tslint-immutable/pull/122) | ||
- Fixed rule readonly-array with option ignore-return-type not checking within tuple types. See [#121](https://github.com/jonaskello/tslint-immutable/issues/121). See PR [#122](https://github.com/jonaskello/tslint-immutable/pull/122) | ||
@@ -46,3 +53,3 @@ ## [v5.3.1] - 2019-03-07 | ||
* Fixed rule readonly-array with option ignore-return-type not checking within generic parameters. See [#117](https://github.com/jonaskello/tslint-immutable/issues/117). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for this fix! (See PR [#120](https://github.com/jonaskello/tslint-immutable/pull/120)). | ||
- Fixed rule readonly-array with option ignore-return-type not checking within generic parameters. See [#117](https://github.com/jonaskello/tslint-immutable/issues/117). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for this fix! (See PR [#120](https://github.com/jonaskello/tslint-immutable/pull/120)). | ||
@@ -53,3 +60,3 @@ ## [v5.3.0] - 2019-02-19 | ||
* New rule `no-reject` (moved from no-throw rule in previous version). See PR [#118](https://github.com/jonaskello/tslint-immutable/pull/118). | ||
- New rule `no-reject` (moved from no-throw rule in previous version). See PR [#118](https://github.com/jonaskello/tslint-immutable/pull/118). | ||
@@ -60,7 +67,7 @@ ## [v5.2.0] - 2019-02-14 | ||
* Update `no-throw` to not allow Promise.reject(). See [#115](https://github.com/jonaskello/tslint-immutable/issues/115) and PR [#116](https://github.com/jonaskello/tslint-immutable/pull/116). Thanks to [@sbdchd](https://github.com/sbdchd) for this addition! | ||
- Update `no-throw` to not allow Promise.reject(). See [#115](https://github.com/jonaskello/tslint-immutable/issues/115) and PR [#116](https://github.com/jonaskello/tslint-immutable/pull/116). Thanks to [@sbdchd](https://github.com/sbdchd) for this addition! | ||
## [v5.1.2] - 2019-01-25 | ||
* Republished without changes (becuase previous publish failed). | ||
- Republished without changes (becuase previous publish failed). | ||
@@ -71,3 +78,3 @@ ## [v5.1.1] - 2019-01-25 | ||
* Fixes readonly-keyword fixer adds the `readonly` modifier in the wrong place for decorated class properties. See [#81](https://github.com/jonaskello/tslint-immutable/issues/81). Thanks to [@tkryskiewicz](https://github.com/tkryskiewicz) for this fix! (See PR [#113](https://github.com/jonaskello/tslint-immutable/pull/113)). | ||
- Fixes readonly-keyword fixer adds the `readonly` modifier in the wrong place for decorated class properties. See [#81](https://github.com/jonaskello/tslint-immutable/issues/81). Thanks to [@tkryskiewicz](https://github.com/tkryskiewicz) for this fix! (See PR [#113](https://github.com/jonaskello/tslint-immutable/pull/113)). | ||
@@ -78,3 +85,3 @@ ## [v5.1.0] - 2019-01-15 | ||
* New option `ignore-new-array` for the `no-array-mutation` rule. This option replaces the `ignore-mutation-following-accessor` option, however the old option name will remain as an alias and will be removed in the next major release. See [#102](https://github.com/jonaskello/tslint-immutable/issues/102). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for adding this option! (See PR [#110](https://github.com/jonaskello/tslint-immutable/pull/110)) | ||
- New option `ignore-new-array` for the `no-array-mutation` rule. This option replaces the `ignore-mutation-following-accessor` option, however the old option name will remain as an alias and will be removed in the next major release. See [#102](https://github.com/jonaskello/tslint-immutable/issues/102). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for adding this option! (See PR [#110](https://github.com/jonaskello/tslint-immutable/pull/110)) | ||
@@ -85,3 +92,3 @@ ## [v5.0.1] - 2018-12-15 | ||
* Fixed a regression in the `readonly-array`. See [#104](https://github.com/jonaskello/tslint-immutable/issues/104). | ||
- Fixed a regression in the `readonly-array`. See [#104](https://github.com/jonaskello/tslint-immutable/issues/104). | ||
@@ -92,3 +99,3 @@ ## [v5.0.0] - 2018-11-24 | ||
* Internal refactoring to use the [tsutils](https://www.npmjs.com/package/tsutils) library, see PR [100](https://github.com/jonaskello/tslint-immutable/pull/100). This cleans up a lot of code and makes it easier to do further development. Becasue the tsutils library requires typescript version >=2.8 and node >=6 this refactoring required a major version bump. Big thanks to [RebeccaStevens](https://github.com/RebeccaStevens) for the amazing work on this refactoring :-). | ||
- Internal refactoring to use the [tsutils](https://www.npmjs.com/package/tsutils) library, see PR [100](https://github.com/jonaskello/tslint-immutable/pull/100). This cleans up a lot of code and makes it easier to do further development. Becasue the tsutils library requires typescript version >=2.8 and node >=6 this refactoring required a major version bump. Big thanks to [RebeccaStevens](https://github.com/RebeccaStevens) for the amazing work on this refactoring :-). | ||
@@ -99,3 +106,3 @@ ## [v4.9.1] - 2018-11-04 | ||
* `ignore-return-type` option for the `readonly-array` doesn't catch method declarations. See [#95](https://github.com/jonaskello/tslint-immutable/issues/95). | ||
- `ignore-return-type` option for the `readonly-array` doesn't catch method declarations. See [#95](https://github.com/jonaskello/tslint-immutable/issues/95). | ||
@@ -106,3 +113,3 @@ ## [v4.9.0] - 2018-11-01 | ||
* New option `ignore-return-type` for the `readonly-array` rule. See [#82](https://github.com/jonaskello/tslint-immutable/issues/82). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for adding this option! (See PR [#95](https://github.com/jonaskello/tslint-immutable/pull/95)) | ||
- New option `ignore-return-type` for the `readonly-array` rule. See [#82](https://github.com/jonaskello/tslint-immutable/issues/82). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for adding this option! (See PR [#95](https://github.com/jonaskello/tslint-immutable/pull/95)) | ||
@@ -113,3 +120,3 @@ ## [v4.8.0] - 2018-10-07 | ||
* New option `ignore-rest-parameters` for the `readonly-array` rule. See [#73](https://github.com/jonaskello/tslint-immutable/issues/73). Thanks to [@aboyton](https://github.com/aboyton) for adding this option! (See PR [#93](https://github.com/jonaskello/tslint-immutable/pull/93)) | ||
- New option `ignore-rest-parameters` for the `readonly-array` rule. See [#73](https://github.com/jonaskello/tslint-immutable/issues/73). Thanks to [@aboyton](https://github.com/aboyton) for adding this option! (See PR [#93](https://github.com/jonaskello/tslint-immutable/pull/93)) | ||
@@ -122,7 +129,7 @@ ### Added | ||
* New option `ignore-mutation-following-accessor` for the `no-array-mutation` rule. See [#88](https://github.com/jonaskello/tslint-immutable/issues/88). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for adding this option! (See PR [#89](https://github.com/jonaskello/tslint-immutable/pull/89)) | ||
- New option `ignore-mutation-following-accessor` for the `no-array-mutation` rule. See [#88](https://github.com/jonaskello/tslint-immutable/issues/88). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for adding this option! (See PR [#89](https://github.com/jonaskello/tslint-immutable/pull/89)) | ||
* New rules `no-throw` and `no-try`. See [#86](https://github.com/jonaskello/tslint-immutable/issues/86). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for adding these rules! (See PR [#91](https://github.com/jonaskello/tslint-immutable/pull/91)) | ||
- New rules `no-throw` and `no-try`. See [#86](https://github.com/jonaskello/tslint-immutable/issues/86). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for adding these rules! (See PR [#91](https://github.com/jonaskello/tslint-immutable/pull/91)) | ||
* Option for enabling all the rules with `tslint-immutable/all`. See [#66](https://github.com/jonaskello/tslint-immutable/issues/66). Thanks to [@bakerface](https://github.com/bakerface) for adding this! (See PR [#85](https://github.com/jonaskello/tslint-immutable/pull/85)) | ||
- Option for enabling all the rules with `tslint-immutable/all`. See [#66](https://github.com/jonaskello/tslint-immutable/issues/66). Thanks to [@bakerface](https://github.com/bakerface) for adding this! (See PR [#85](https://github.com/jonaskello/tslint-immutable/pull/85)) | ||
@@ -133,9 +140,9 @@ ## [v4.6.0] - 2018-06-12 | ||
* New rule `no-array-mutation`. See [#74](https://github.com/jonaskello/tslint-immutable/issues/74). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for adding this rule! (See PR [#84](https://github.com/jonaskello/tslint-immutable/pull/84)) | ||
- New rule `no-array-mutation`. See [#74](https://github.com/jonaskello/tslint-immutable/issues/74). Thanks to [@RebeccaStevens](https://github.com/RebeccaStevens) for adding this rule! (See PR [#84](https://github.com/jonaskello/tslint-immutable/pull/84)) | ||
## [v4.5.4] - 2018-04-17 | ||
* `no-object-mutation` rule, allow class member mutation in constructor [#79](https://github.com/jonaskello/tslint-immutable/pull/79). | ||
- `no-object-mutation` rule, allow class member mutation in constructor [#79](https://github.com/jonaskello/tslint-immutable/pull/79). | ||
* `readonly-keyword` rule, check function params and return type [#80](https://github.com/jonaskello/tslint-immutable/pull/80) | ||
- `readonly-keyword` rule, check function params and return type [#80](https://github.com/jonaskello/tslint-immutable/pull/80) | ||
@@ -146,3 +153,3 @@ ## [v4.5.3] - 2018-03-31 | ||
* `readonly-array` fixer does not work for arrays with nested template type. See [#24](https://github.com/jonaskello/tslint-immutable/issues/24). Thanks to [@geon](https://github.com/geon) for fixing this longstanding bug! (See PR [#78](https://github.com/jonaskello/tslint-immutable/pull/78)) | ||
- `readonly-array` fixer does not work for arrays with nested template type. See [#24](https://github.com/jonaskello/tslint-immutable/issues/24). Thanks to [@geon](https://github.com/geon) for fixing this longstanding bug! (See PR [#78](https://github.com/jonaskello/tslint-immutable/pull/78)) | ||
@@ -153,5 +160,5 @@ ## [v4.5.2] - 2018-02-27 | ||
* Ignore await when checking `ignore-prefix` in `no-expression-statement`. See [#76](https://github.com/jonaskello/tslint-immutable/issues/76). | ||
- Ignore await when checking `ignore-prefix` in `no-expression-statement`. See [#76](https://github.com/jonaskello/tslint-immutable/issues/76). | ||
* `no-class` does not catch class expressions. See [#65](https://github.com/jonaskello/tslint-immutable/issues/65). Thanks to [@ianbollinger](https://github.com/ianbollinger) for this fix! (See PR [#70](https://github.com/jonaskello/tslint-immutable/pull/70)) | ||
- `no-class` does not catch class expressions. See [#65](https://github.com/jonaskello/tslint-immutable/issues/65). Thanks to [@ianbollinger](https://github.com/ianbollinger) for this fix! (See PR [#70](https://github.com/jonaskello/tslint-immutable/pull/70)) | ||
@@ -162,3 +169,3 @@ ## [v4.5.1] - 2018-01-16 | ||
* `no-mixed-interface` does not understand arrow function notation. See [#62](https://github.com/jonaskello/tslint-immutable/issues/62). Thanks to [@geon](https://github.com/geon) for this fix! (See PR [#63](https://github.com/jonaskello/tslint-immutable/pull/63)) | ||
- `no-mixed-interface` does not understand arrow function notation. See [#62](https://github.com/jonaskello/tslint-immutable/issues/62). Thanks to [@geon](https://github.com/geon) for this fix! (See PR [#63](https://github.com/jonaskello/tslint-immutable/pull/63)) | ||
@@ -169,15 +176,15 @@ ## [v4.5.0] - 2017-12-29 | ||
* New options `ignore-interface`, and `ignore-class` for the `readonly-keyword` rule. See [#44](https://github.com/jonaskello/tslint-immutable/issues/44) for background. Thanks to [@aboyton](https://github.com/aboyton) for these options! (See PR [#57](https://github.com/jonaskello/tslint-immutable/pull/57)) | ||
- New options `ignore-interface`, and `ignore-class` for the `readonly-keyword` rule. See [#44](https://github.com/jonaskello/tslint-immutable/issues/44) for background. Thanks to [@aboyton](https://github.com/aboyton) for these options! (See PR [#57](https://github.com/jonaskello/tslint-immutable/pull/57)) | ||
* The `ignore-prefix` option can be an array for all rules (previously just for `no-expression-statement` and `no-object-mutation`). | ||
- The `ignore-prefix` option can be an array for all rules (previously just for `no-expression-statement` and `no-object-mutation`). | ||
* New rule `no-delete`. See [readme](https://github.com/jonaskello/tslint-immutable#no-delete) for more info. | ||
- New rule `no-delete`. See [readme](https://github.com/jonaskello/tslint-immutable#no-delete) for more info. | ||
* New rule `no-if-statement`. See [readme](https://github.com/jonaskello/tslint-immutable#no-if-statement) for more info and [#54](https://github.com/jonaskello/tslint-immutable/issues/54) for discussion. | ||
- New rule `no-if-statement`. See [readme](https://github.com/jonaskello/tslint-immutable#no-if-statement) for more info and [#54](https://github.com/jonaskello/tslint-immutable/issues/54) for discussion. | ||
* New rule `no-loop-statement`. See [readme](https://github.com/jonaskello/tslint-immutable#no-loop-statement) for more info and [#54](https://github.com/jonaskello/tslint-immutable/issues/54) for discussion. | ||
- New rule `no-loop-statement`. See [readme](https://github.com/jonaskello/tslint-immutable#no-loop-statement) for more info and [#54](https://github.com/jonaskello/tslint-immutable/issues/54) for discussion. | ||
### Fixed | ||
* `no-mixed-interface` does not understand arrow function notation. See [#60](https://github.com/jonaskello/tslint-immutable/issues/60). | ||
- `no-mixed-interface` does not understand arrow function notation. See [#60](https://github.com/jonaskello/tslint-immutable/issues/60). | ||
@@ -188,3 +195,3 @@ ## [v4.4.0] - 2017-09-27 | ||
* New option `ignore-prefix` for the `no-object-mutation` rule. See [#43](https://github.com/jonaskello/tslint-immutable/issues/43) for background. Thanks to [@miangraham](https://github.com/miangraham) for this option! (See PR [#53](https://github.com/jonaskello/tslint-immutable/pull/53)) | ||
- New option `ignore-prefix` for the `no-object-mutation` rule. See [#43](https://github.com/jonaskello/tslint-immutable/issues/43) for background. Thanks to [@miangraham](https://github.com/miangraham) for this option! (See PR [#53](https://github.com/jonaskello/tslint-immutable/pull/53)) | ||
@@ -195,9 +202,9 @@ ## [v4.3.0] - 2017-09-23 | ||
* The readonly-keyword rule now properly checks for `readonly` modifier of `class` property declarations. See [#49](https://github.com/jonaskello/tslint-immutable/issues/49) and PR [#50](https://github.com/jonaskello/tslint-immutable/pull/50). | ||
- The readonly-keyword rule now properly checks for `readonly` modifier of `class` property declarations. See [#49](https://github.com/jonaskello/tslint-immutable/issues/49) and PR [#50](https://github.com/jonaskello/tslint-immutable/pull/50). | ||
### Added | ||
* New rule [no-method-signature](https://github.com/jonaskello/tslint-immutable#no-method-signature). See [#30](https://github.com/jonaskello/tslint-immutable/issues/30) and PR in [#51](https://github.com/jonaskello/tslint-immutable/pull/51). | ||
* New options `ignore-local`, and `ignore-prefix` for the `no-let` rule. See [#32](https://github.com/jonaskello/tslint-immutable/issues/32), also requested in [#43](https://github.com/jonaskello/tslint-immutable/issues/43). See PR [#48](https://github.com/jonaskello/tslint-immutable/pull/48). | ||
* Added tslint core rule [no-parameter-reassignment](https://palantir.github.io/tslint/rules/no-parameter-reassignment/) as [recommended](https://github.com/jonaskello/tslint-immutable#no-parameter-reassignment) in the README. | ||
- New rule [no-method-signature](https://github.com/jonaskello/tslint-immutable#no-method-signature). See [#30](https://github.com/jonaskello/tslint-immutable/issues/30) and PR in [#51](https://github.com/jonaskello/tslint-immutable/pull/51). | ||
- New options `ignore-local`, and `ignore-prefix` for the `no-let` rule. See [#32](https://github.com/jonaskello/tslint-immutable/issues/32), also requested in [#43](https://github.com/jonaskello/tslint-immutable/issues/43). See PR [#48](https://github.com/jonaskello/tslint-immutable/pull/48). | ||
- Added tslint core rule [no-parameter-reassignment](https://palantir.github.io/tslint/rules/no-parameter-reassignment/) as [recommended](https://github.com/jonaskello/tslint-immutable#no-parameter-reassignment) in the README. | ||
@@ -208,3 +215,3 @@ ## [v4.2.1] - 2017-09-21 | ||
* The readonly-array rule with ignore-local option does not work within `class`. See [45](https://github.com/jonaskello/tslint-immutable/issues/45). | ||
- The readonly-array rule with ignore-local option does not work within `class`. See [45](https://github.com/jonaskello/tslint-immutable/issues/45). | ||
@@ -215,3 +222,3 @@ ## [v4.2.0] - 2017-09-14 | ||
* New option `ignore-prefix` for the `no-expression-statement` rule. See [#39](https://github.com/jonaskello/tslint-immutable/issues/39) for background. Thanks to [@algesten](https://github.com/algesten) for this option! (See PR [#42](https://github.com/jonaskello/tslint-immutable/pull/42)) | ||
- New option `ignore-prefix` for the `no-expression-statement` rule. See [#39](https://github.com/jonaskello/tslint-immutable/issues/39) for background. Thanks to [@algesten](https://github.com/algesten) for this option! (See PR [#42](https://github.com/jonaskello/tslint-immutable/pull/42)) | ||
@@ -222,3 +229,3 @@ ## [v4.1.0] - 2017-08-21 | ||
* New rule `no-object-mutation`. See [#36](https://github.com/jonaskello/tslint-immutable/issues/36) for background. Thanks to [@miangraham](https://github.com/miangraham) for this rule! (See PR [#37](https://github.com/jonaskello/tslint-immutable/pull/37)) | ||
- New rule `no-object-mutation`. See [#36](https://github.com/jonaskello/tslint-immutable/issues/36) for background. Thanks to [@miangraham](https://github.com/miangraham) for this rule! (See PR [#37](https://github.com/jonaskello/tslint-immutable/pull/37)) | ||
@@ -229,3 +236,3 @@ ## [v4.0.2] - 2017-07-16 | ||
* Added an index.js file to the rules directory in order for rulesDirectory to work. See [#35](https://github.com/jonaskello/tslint-immutable/issues/35). | ||
- Added an index.js file to the rules directory in order for rulesDirectory to work. See [#35](https://github.com/jonaskello/tslint-immutable/issues/35). | ||
@@ -236,3 +243,3 @@ ## [v4.0.1] - 2017-06-06 | ||
* Invalid default tslint config (it included the removed rules). | ||
- Invalid default tslint config (it included the removed rules). | ||
@@ -243,9 +250,9 @@ ## [v4.0.0] - 2017-06-06 | ||
* `readonly-interface` rule. This rule is replaced by the `readonly-keyword` rule. | ||
* `readonly-indexer` rule. This rule is replaced by the `readonly-keyword` rule. | ||
* `no-new` rule. Please see background in [#2](https://github.com/jonaskello/tslint-immutable/issues/2). | ||
* `no-arguments` rule. This rule has been moved to the [tslint-divid](https://www.npmjs.com/package/tslint-divid) package. | ||
* `no-label` rule. This rule has been moved to the [tslint-divid](https://www.npmjs.com/package/tslint-divid) package. | ||
* `no-semicolon-interface` rule. This rule has been moved to the [tslint-divid](https://www.npmjs.com/package/tslint-divid) package. | ||
* `import-containment` rule. This rule has been moved to the [tslint-divid](https://www.npmjs.com/package/tslint-divid) package. | ||
- `readonly-interface` rule. This rule is replaced by the `readonly-keyword` rule. | ||
- `readonly-indexer` rule. This rule is replaced by the `readonly-keyword` rule. | ||
- `no-new` rule. Please see background in [#2](https://github.com/jonaskello/tslint-immutable/issues/2). | ||
- `no-arguments` rule. This rule has been moved to the [tslint-divid](https://www.npmjs.com/package/tslint-divid) package. | ||
- `no-label` rule. This rule has been moved to the [tslint-divid](https://www.npmjs.com/package/tslint-divid) package. | ||
- `no-semicolon-interface` rule. This rule has been moved to the [tslint-divid](https://www.npmjs.com/package/tslint-divid) package. | ||
- `import-containment` rule. This rule has been moved to the [tslint-divid](https://www.npmjs.com/package/tslint-divid) package. | ||
@@ -256,7 +263,7 @@ ## [v3.4.2] - 2017-05-14 | ||
* Notice in readme about deprecrating the `no-new` rule. | ||
- Notice in readme about deprecrating the `no-new` rule. | ||
### Deprecated | ||
* The `no-new` rule. See [#2](https://github.com/jonaskello/tslint-immutable/issues/2) for background. | ||
- The `no-new` rule. See [#2](https://github.com/jonaskello/tslint-immutable/issues/2) for background. | ||
@@ -267,7 +274,7 @@ ## [v3.4.1] - 2017-05-14 | ||
* Note in readme about moving the "other" rules. The `no-argument`, `no-label`, `no-semicolon-interface`, and `import containtment` rules are moving to [tslint-divid](https://github.com/jonaskello/tslint-divid). See [#19](https://github.com/jonaskello/tslint-immutable/issues/19) for more information. | ||
- Note in readme about moving the "other" rules. The `no-argument`, `no-label`, `no-semicolon-interface`, and `import containtment` rules are moving to [tslint-divid](https://github.com/jonaskello/tslint-divid). See [#19](https://github.com/jonaskello/tslint-immutable/issues/19) for more information. | ||
### Deprecated | ||
* The `no-argument`, `no-label`, `no-semicolon-interface`, and `import containtment` rules as noted above. | ||
- The `no-argument`, `no-label`, `no-semicolon-interface`, and `import containtment` rules as noted above. | ||
@@ -278,7 +285,7 @@ ## [v3.4.0] - 2017-05-14 | ||
* New rule `readonly-keyword`, to replace `readonly-interface` and `readonly-indexer` [#31](https://github.com/jonaskello/tslint-immutable/issues/31) | ||
- New rule `readonly-keyword`, to replace `readonly-interface` and `readonly-indexer` [#31](https://github.com/jonaskello/tslint-immutable/issues/31) | ||
### Deprecated | ||
* The `readonly-interface`, and `readonly-indexer` rules are deprecated and will be removed in the next major release. Please use the `readonly-keyword` rule instead. | ||
- The `readonly-interface`, and `readonly-indexer` rules are deprecated and will be removed in the next major release. Please use the `readonly-keyword` rule instead. | ||
@@ -289,3 +296,3 @@ ## [v3.3.2] - 2017-05-13 | ||
* Functions in interfaces cannot have readonly specified but are still checked [#28](https://github.com/jonaskello/tslint-immutable/issues/28) | ||
- Functions in interfaces cannot have readonly specified but are still checked [#28](https://github.com/jonaskello/tslint-immutable/issues/28) | ||
@@ -296,3 +303,3 @@ ## [v3.3.1] - 2017-05-09 | ||
* patch: fix main file in package.json. Thanks to [@yonbeastie](https://github.com/yonbeastie). (see [#29](https://github.com/jonaskello/tslint-immutable/pull/29)) | ||
- patch: fix main file in package.json. Thanks to [@yonbeastie](https://github.com/yonbeastie). (see [#29](https://github.com/jonaskello/tslint-immutable/pull/29)) | ||
@@ -303,7 +310,7 @@ ## [v3.3.0] - 2017-05-09 | ||
* ignore-local does not work for function assigned to const [#23](https://github.com/jonaskello/tslint-immutable/issues/23) | ||
- ignore-local does not work for function assigned to const [#23](https://github.com/jonaskello/tslint-immutable/issues/23) | ||
### Added | ||
* Add default tslint json. Thanks to [@yonbeastie](https://github.com/yonbeastie). (see [#26](https://github.com/jonaskello/tslint-immutable/pull/26)) | ||
- Add default tslint json. Thanks to [@yonbeastie](https://github.com/yonbeastie). (see [#26](https://github.com/jonaskello/tslint-immutable/pull/26)) | ||
@@ -314,7 +321,7 @@ ## [v3.2.0] - 2017-04-10 | ||
* readonly-array does not check shorthand syntax in return types with ignore-local option [#21](https://github.com/jonaskello/tslint-immutable/issues/21) | ||
- readonly-array does not check shorthand syntax in return types with ignore-local option [#21](https://github.com/jonaskello/tslint-immutable/issues/21) | ||
### Added | ||
* Fixer for the `readonly-array` rule. | ||
- Fixer for the `readonly-array` rule. | ||
@@ -325,8 +332,8 @@ ## [v3.1.2] - 2017-04-09 | ||
* readonly-array does not check return type when ignore-local is enabled [#16](https://github.com/jonaskello/tslint-immutable/issues/16) | ||
* readonly-array does not check shorthand syntax [#20](https://github.com/jonaskello/tslint-immutable/issues/20). | ||
- readonly-array does not check return type when ignore-local is enabled [#16](https://github.com/jonaskello/tslint-immutable/issues/16) | ||
- readonly-array does not check shorthand syntax [#20](https://github.com/jonaskello/tslint-immutable/issues/20). | ||
## Changed | ||
* Impicit return type is not checked in readonly-array [#18](https://github.com/jonaskello/tslint-immutable/issues/18). | ||
- Impicit return type is not checked in readonly-array [#18](https://github.com/jonaskello/tslint-immutable/issues/18). | ||
@@ -337,4 +344,4 @@ ## [v3.1.1] - 2017-04-05 | ||
* Function parameters are not checked when using ignore-local option, [#13](https://github.com/jonaskello/tslint-immutable/issues/13). | ||
* Implicit Array type by default value for function parameter is not checked, [#14](https://github.com/jonaskello/tslint-immutable/issues/14). | ||
- Function parameters are not checked when using ignore-local option, [#13](https://github.com/jonaskello/tslint-immutable/issues/13). | ||
- Implicit Array type by default value for function parameter is not checked, [#14](https://github.com/jonaskello/tslint-immutable/issues/14). | ||
@@ -345,4 +352,4 @@ ## [v3.1.0] - 2017-04-05 | ||
* [`ignore-local`](https://github.com/jonaskello/tslint-immutable#using-the-ignore-local-option) option added to `readonly-array`. | ||
* [`ignore-prefix`](https://github.com/jonaskello/tslint-immutable#using-the-ignore-local-option) option added to `readonly-array`. | ||
- [`ignore-local`](https://github.com/jonaskello/tslint-immutable#using-the-ignore-local-option) option added to `readonly-array`. | ||
- [`ignore-prefix`](https://github.com/jonaskello/tslint-immutable#using-the-ignore-local-option) option added to `readonly-array`. | ||
@@ -353,7 +360,7 @@ ## [v3.0.0] - 2017-04-02 | ||
* Upgraded to tslint 5.0.0 | ||
- Upgraded to tslint 5.0.0 | ||
### Added | ||
* `readonly-array` now also checks for implicity declared mutable arrays. | ||
- `readonly-array` now also checks for implicity declared mutable arrays. | ||
@@ -364,3 +371,3 @@ ## [v2.1.1] - 2017-03-29 | ||
* Remove vestigial `noMutationRule.js` and `no-mutation` example from README, thanks to [@pmlamotte](https://github.com/pmlamotte). (see [#6](https://github.com/jonaskello/tslint-immutable/pull/6)) | ||
- Remove vestigial `noMutationRule.js` and `no-mutation` example from README, thanks to [@pmlamotte](https://github.com/pmlamotte). (see [#6](https://github.com/jonaskello/tslint-immutable/pull/6)) | ||
@@ -371,7 +378,7 @@ ## [v2.1.0] - 2016-12-12 | ||
* `readonly-indexer` rule. | ||
- `readonly-indexer` rule. | ||
### Fixed | ||
* Fixed a bug in `readonly-interface` rule that made it fail on indexer declarations. | ||
- Fixed a bug in `readonly-interface` rule that made it fail on indexer declarations. | ||
@@ -382,16 +389,16 @@ ## [v2.0.0] - 2016-12-12 | ||
* `readonly-interface` rule. | ||
* `readonly-indexer` rule. | ||
* `readonly-array` rule. | ||
* `no-class` rule. | ||
* `no-new` rule. | ||
* `no-mixed-interface` rule. | ||
* `import-containment` rule. | ||
* `no-arguments` rule. | ||
* `no-label` rule. | ||
* `no-semicolon-interface` rule. | ||
- `readonly-interface` rule. | ||
- `readonly-indexer` rule. | ||
- `readonly-array` rule. | ||
- `no-class` rule. | ||
- `no-new` rule. | ||
- `no-mixed-interface` rule. | ||
- `import-containment` rule. | ||
- `no-arguments` rule. | ||
- `no-label` rule. | ||
- `no-semicolon-interface` rule. | ||
### Removed | ||
* `no-mutation` rule (replaced by the `readonly-interface` rule). | ||
- `no-mutation` rule (replaced by the `readonly-interface` rule). | ||
@@ -402,6 +409,6 @@ ## v1.0.0 - 2016-12-10 | ||
* `no-expression-statement` rule. | ||
* `no-let` rule. | ||
* `no-mutation` rule. | ||
* `no-this` rule. | ||
- `no-expression-statement` rule. | ||
- `no-let` rule. | ||
- `no-mutation` rule. | ||
- `no-this` rule. | ||
@@ -408,0 +415,0 @@ [unreleased]: https://github.com/jonaskello/tslint-immutable/compare/v5.3.0...master |
{ | ||
"name": "tslint-immutable", | ||
"version": "6.0.0", | ||
"version": "6.0.1", | ||
"description": "TSLint rules to disable mutation in TypeScript.", | ||
@@ -42,3 +42,2 @@ "main": "tslint-immutable.json", | ||
"codecov": "^3.2.0", | ||
"compare-versions": "^3.4.0", | ||
"glob": "^7.1.3", | ||
@@ -48,3 +47,2 @@ "husky": "^1.3.1", | ||
"nyc": "^13.3.0", | ||
"object.entries": "^1.1.0", | ||
"prettier": "^1.16.4", | ||
@@ -51,0 +49,0 @@ "rimraf": "^2.6.3", |
108
README.md
@@ -11,2 +11,6 @@ # tslint-immutable | ||
:warning: **TSLint will be deprecated some time in 2019**. See this issue for more details: [Roadmap: TSLint → ESLint](https://github.com/palantir/tslint/issues/4534). | ||
:rocket: **Work has started to port these rules to a new eslint plugin** over at the [eslint-plugin-ts-immutable](https://github.com/jonaskello/eslint-plugin-ts-immutable) repo. Please head over there and give it a :star: :-). | ||
## Background | ||
@@ -30,6 +34,6 @@ | ||
* tslint-immutable 5.x.x requires typescript >=2.8, node >=6, and tslint 5.x.x. | ||
* tslint-immutable 3.x.x requires tslint 5.x.x. | ||
* tslint-immutable 2.x.x requires tslint 4.x.x. | ||
* tslint-immutable 1.x.x requires tslint 3.x.x. | ||
- tslint-immutable 5.x.x requires typescript >=2.8, node >=6, and tslint 5.x.x. | ||
- tslint-immutable 3.x.x requires tslint 5.x.x. | ||
- tslint-immutable 2.x.x requires tslint 4.x.x. | ||
- tslint-immutable 1.x.x requires tslint 3.x.x. | ||
@@ -40,21 +44,21 @@ ## TSLint Rules | ||
* [Immutability rules](#immutability-rules) | ||
* [readonly-keyword](#readonly-keyword) | ||
* [readonly-array](#readonly-array) | ||
* [no-let](#no-let) | ||
* [no-array-mutation](#no-array-mutation) | ||
* [no-object-mutation](#no-object-mutation) | ||
* [no-method-signature](#no-method-signature) | ||
* [no-delete](#no-delete) | ||
* [Functional style rules](#functional-style-rules) | ||
* [no-this](#no-this-no-class) | ||
* [no-class](#no-this-no-class) | ||
* [no-mixed-interface](#no-mixed-interface) | ||
* [no-expression-statement](#no-expression-statement) | ||
* [no-if-statement](#no-if-statement) | ||
* [no-loop-statement](#no-loop-statement) | ||
* [no-throw](#no-throw) | ||
* [no-try](#no-try) | ||
* [no-reject](#no-reject) | ||
* [Recommended built-in rules](#recommended-built-in-rules) | ||
- [Immutability rules](#immutability-rules) | ||
- [readonly-keyword](#readonly-keyword) | ||
- [readonly-array](#readonly-array) | ||
- [no-let](#no-let) | ||
- [no-array-mutation](#no-array-mutation) | ||
- [no-object-mutation](#no-object-mutation) | ||
- [no-method-signature](#no-method-signature) | ||
- [no-delete](#no-delete) | ||
- [Functional style rules](#functional-style-rules) | ||
- [no-this](#no-this-no-class) | ||
- [no-class](#no-this-no-class) | ||
- [no-mixed-interface](#no-mixed-interface) | ||
- [no-expression-statement](#no-expression-statement) | ||
- [no-if-statement](#no-if-statement) | ||
- [no-loop-statement](#no-loop-statement) | ||
- [no-throw](#no-throw) | ||
- [no-try](#no-try) | ||
- [no-reject](#no-reject) | ||
- [Recommended built-in rules](#recommended-built-in-rules) | ||
@@ -121,8 +125,8 @@ ## Immutability rules | ||
* [ignore-local](#using-the-ignore-local-option) | ||
* [ignore-class](#using-the-ignore-class-option) | ||
* [ignore-interface](#using-the-ignore-interface-option) | ||
* [ignore-prefix](#using-the-ignore-prefix-option) | ||
* [ignore-suffix](#using-the-ignore-suffix-option) | ||
* [ignore-pattern](#using-the-ignore-pattern-option) | ||
- [ignore-local](#using-the-ignore-local-option) | ||
- [ignore-class](#using-the-ignore-class-option) | ||
- [ignore-interface](#using-the-ignore-interface-option) | ||
- [ignore-prefix](#using-the-ignore-prefix-option) | ||
- [ignore-suffix](#using-the-ignore-suffix-option) | ||
- [ignore-pattern](#using-the-ignore-pattern-option) | ||
@@ -180,8 +184,8 @@ #### Example config | ||
* [ignore-local](#using-the-ignore-local-option) | ||
* [ignore-prefix](#using-the-ignore-prefix-option) | ||
* [ignore-suffix](#using-the-ignore-suffix-option) | ||
* [ignore-pattern](#using-the-ignore-pattern-option) | ||
* [ignore-return-type](#using-the-ignore-return-type-option) | ||
* [ignore-rest-parameters](#using-the-ignore-rest-parameters-option) | ||
- [ignore-local](#using-the-ignore-local-option) | ||
- [ignore-prefix](#using-the-ignore-prefix-option) | ||
- [ignore-suffix](#using-the-ignore-suffix-option) | ||
- [ignore-pattern](#using-the-ignore-pattern-option) | ||
- [ignore-return-type](#using-the-ignore-return-type-option) | ||
- [ignore-rest-parameters](#using-the-ignore-rest-parameters-option) | ||
@@ -217,3 +221,5 @@ #### Example config | ||
<ul> | ||
{results.map(result => <li>result</li>) // <- Who needs let? | ||
{results.map(result => ( | ||
<li>result</li> | ||
)) // <- Who needs let? | ||
} | ||
@@ -230,6 +236,6 @@ </ul> | ||
* [ignore-local](#using-the-ignore-local-option) | ||
* [ignore-prefix](#using-the-ignore-prefix-option) | ||
* [ignore-suffix](#using-the-ignore-suffix-option) | ||
* [ignore-pattern](#using-the-ignore-pattern-option) | ||
- [ignore-local](#using-the-ignore-local-option) | ||
- [ignore-prefix](#using-the-ignore-prefix-option) | ||
- [ignore-suffix](#using-the-ignore-suffix-option) | ||
- [ignore-pattern](#using-the-ignore-pattern-option) | ||
@@ -270,7 +276,7 @@ #### Example config | ||
* [ignore-prefix](#using-the-ignore-prefix-option) | ||
* [ignore-suffix](#using-the-ignore-suffix-option) | ||
* [ignore-pattern](#using-the-ignore-pattern-option) | ||
* [ignore-new-array](#using-the-ignore-new-array-option-with-no-array-mutation) | ||
* ~~ignore-mutation-following-accessor~~ - _deprecated in favor of [ignore-new-array](#using-the-ignore-new-array-option-with-no-array-mutation)_ | ||
- [ignore-prefix](#using-the-ignore-prefix-option) | ||
- [ignore-suffix](#using-the-ignore-suffix-option) | ||
- [ignore-pattern](#using-the-ignore-pattern-option) | ||
- [ignore-new-array](#using-the-ignore-new-array-option-with-no-array-mutation) | ||
- ~~ignore-mutation-following-accessor~~ - _deprecated in favor of [ignore-new-array](#using-the-ignore-new-array-option-with-no-array-mutation)_ | ||
@@ -312,5 +318,5 @@ #### Example config | ||
* [ignore-prefix](#using-the-ignore-prefix-option) | ||
* [ignore-suffix](#using-the-ignore-suffix-option) | ||
* [ignore-pattern](#using-the-ignore-pattern-option) | ||
- [ignore-prefix](#using-the-ignore-prefix-option) | ||
- [ignore-suffix](#using-the-ignore-suffix-option) | ||
- [ignore-pattern](#using-the-ignore-pattern-option) | ||
@@ -406,3 +412,3 @@ #### Example config | ||
* [ignore-prefix](#using-the-ignore-prefix-option-with-no-expression-statement) | ||
- [ignore-prefix](#using-the-ignore-prefix-option-with-no-expression-statement) | ||
@@ -587,4 +593,4 @@ #### Example config | ||
* `**` - Match any depth (including zero). Can only be used as a full accessor. | ||
* `*` - When used as a full accessor, match the next accessor. When used as part of an accessor, match any characters. | ||
- `**` - Match any depth (including zero). Can only be used as a full accessor. | ||
- `*` - When used as a full accessor, match the next accessor. When used as part of an accessor, match any characters. | ||
@@ -591,0 +597,0 @@ ### Using the `ignore-prefix` option with `no-expression-statement` |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
128128
13
719