Can I run `npx arethetypeswrong` (CLI for library authors)

[brainkim]

Can I run npx are-the-types-wrong in my library, or pointed to a package.json, or to an npm URL, or a project, and

be told if I am doing it right

so I don’t have to read that long README.md 🙈

[andrewbranch]

No, but I’d like to make a CLI eventually.

[jasikpark]

maybe via https://github.com/natemoo-re/clack? 🧐

[andrewbranch]

Have you seen the web UI of this project? clack looks way too pretty 🤪

[markerikson]

FYI, a couple weeks ago I was working on a CLI tool that uses the React ink CLI renderer to generate a table equivalent to what's on the website, with the goal of using it in a GH Action job:

I'm picking up with that work now.

Might be something that can be rolled over into an actual attw CLI tool!

[markerikson]

I just got this working, and added it to Redux Toolkit's "check published artifact in CI" job:

reduxjs/redux-toolkit#3294

edit

And now I've got that suite of examples being used over in the redux-thunk repo as well, including the attw check:

reduxjs/redux-thunk#342

[andrewbranch]

That looks great! I would take a PR for it. I have some vague ideas for making the CLI experience different from the web experience, but since it’s low on my priority list, I’d be happy to run with this in the meantime since a few people have asked for it.

I think the only thing I would need to add for the minimum bar is a severity system and a way to expect or ignore violations (for exit code purposes). I’ve had to tell people a few times already that the info the site shows you is just information and there are cases where it’s ok for a package not to show all green checks. Being ESM-only is an important enough compatibility restriction to show in the tool, but by showing it I don’t mean to prescribe that no package should ever be ESM-only.

[fubhy]

Just found this (thanks @karlhorky), and indeed, a CLI and/or github action would be absolutely wonderful. Would also be great to get a README badge for this so projects can p[roudly show off their standard compliance!

[markerikson]

Yeah, I'm pretty sure that the code I've got in https://github.com/reduxjs/redux-toolkit/tree/master/examples/publish-ci/are-the-types-wrong can be turned into both a standalone CI tool and a Github Action pretty straightforwardly!

But someone else needs to do it :) I've got entirely too many other things on my mind atm.

[fubhy]

Happy to take over if you don't mind. It'd be a few days before I can get to it too but I think this would be immensely useful!

[fubhy]

This has helped me so much already. I still got quite a few question marks around how things work in some scenarios, for instance that which @markerikson is also describing with publishing of CJS & ESM in parallel. My situation is slightly different though because I'm trying to stay as close as possible to tsc and avoid bundlers entirely (ultimately, I still believe (or hope?) that libraries generally just don't (or shouldn't) need bundlers at all).

Anyways, thanks for putting this together @andrewbranch and for starting that CLI @markerikson. I can't promise when I can get to it yet (probably right after easter), but I'll definitely turn this into a github action & standalone cli. Will report back here.

[timostamm]

This is fantastic. I think it's an excellent idea to make use of TypeScripts understanding of module resolution. Thanks for the work @andrewbranch!

A CLI with a meaningful exit code and the option to ignore violations would be very helpful. I would love to run this in CI, either by giving a path to a package, or by doing an npm pack first myself.

Ignoring violations by ProblemKind, and optionally narrowing to a specific ResolutionKind and entrypoint seems useful.