rxjs icon indicating copy to clipboard operation
rxjs copied to clipboard

ts-api-guardian is apparently dead.

Open benlesh opened this issue 3 years ago • 5 comments

The Angular team killed ts-api-guardian: https://github.com/angular/angular/pull/42735

It's no longer supported. Not sure what they're using now, but there's pretty much no way I'd ever use anything alpha for this again.

So:

  1. We have to remove ts-api-guardian eventually
  2. What should we replace it with, if anything? Does the tool have value?

Side note: I'm pretty ticked about this on a personal level because I was shamed into adding this and then support was just dropped without warning.

benlesh avatar Dec 27 '21 20:12 benlesh

This is one option: https://api-extractor.com/pages/setup/invoking/

benlesh avatar Dec 27 '21 20:12 benlesh

FYI, I looked (briefly) at api-extractor when I was dealing with the internal bits - see this comment - and something to be aware of is: https://api-extractor.com/pages/setup/configure_rollup/#an-important-limitation

Whether or not that applies to only the rollup feature, IDK, but it's something to bear in mind.

cartant avatar Dec 27 '21 22:12 cartant

@cartant am I to understand that rxjs/testing, rxjs/ajax, rxjs/operators, et al, will not work properly with api-extractor? That's what it seems like, reading that. If that's the case, I guess we can't use it until we figure out what we're going to do there.

benlesh avatar Dec 28 '21 00:12 benlesh

Core Team: Still an issue... punting.

benlesh avatar Jan 12 '22 21:01 benlesh

@cartant am I to understand that rxjs/testing, rxjs/ajax, rxjs/operators, et al, will not work properly with api-extractor? That's what it seems like, reading that. If that's the case, I guess we can't use it until we figure out what we're going to do there.

When i looked into api-explorer for the handling of @internal that limitation came up too: https://github.com/ReactiveX/rxjs/issues/5768#issuecomment-703135265

tmair avatar Feb 19 '22 07:02 tmair

I really hate this issue. :\

Maybe just a straight diff-tool over .d.ts files would work? This is super annoying. I can't update packages with npm audit fix because of this dead package.

benlesh avatar Sep 25 '22 18:09 benlesh

I can't update packages with npm audit fix because of this dead package.

Can we remove it as a dep and run it in the script via npx or something? That's pretty nasty, but 🤷‍♂️

cartant avatar Sep 25 '22 18:09 cartant

We removed it.

benlesh avatar Feb 08 '23 21:02 benlesh