Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

5.13 introduced a breaking change #4555

Closed
alan-agius4 opened this issue Feb 28, 2019 · 3 comments · Fixed by #4561
Closed

5.13 introduced a breaking change #4555

alan-agius4 opened this issue Feb 28, 2019 · 3 comments · Fixed by #4561

Comments

@alan-agius4
Copy link
Contributor

alan-agius4 commented Feb 28, 2019

Bug Report

  • TSLint version: 5.13
  • TypeScript version: 3.2
  • Running TSLint via: (pick one) API

This commit 9000479 caused the API signature to changes and caused a breaking change in a minor release of tslint for API users.

The issue is that now format method needs an additional parameter which is not optional, and hence it will be fail during compile time and during runtime since fileNames is not specified.

Expected behavior

Possible solutions;

  1. Revert the change, release a patch & release this in a major
  2. Make this optional

Relates to angular/angular-cli#13783

@alan-agius4 alan-agius4 changed the title 5.13 introduces a breaking change 5.13 introduced a breaking change Feb 28, 2019
@adidahiya
Copy link
Contributor

Ah, sorry about that, I should have been more careful about AbstractFormatter and made sure its signature matched IFormatter exactly so that this break wouldn't happen (I was only focusing on IFormatter because that's the only one exported as public API)... maybe there's room for a lint rule here like #4175 to catch this in the future

@adidahiya
Copy link
Contributor

I'll fix this and release 5.13.1

@alan-agius4
Copy link
Contributor Author

Thank you

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants