🛠 Tooling: Add a tsc check for solutions to CI about projects HOT 6 CLOSED

Ah sorry if the OP is unclear, thanks for asking!

Right now a lot of projects have package.json scripts that look like this (example: analyzing-dna):

"scripts": {
  "test": "jest",
  "test:solutions": "cross-env TEST_SOLUTIONS=1 jest"
}

Nothing in CI validates that the solution file (typically solutions.ts) in those projects passes TypeScript type checking. Someone could send in a PR with solution code that passes Jest tests but has a type error.

So, there should be some new step added to builds that runs tsc on all solution code. Does that make sense?

from projects.

Hey @JoshuaKGoldberg , I don't seem to understand this issue and I would love to help with it, if possible.

from projects.

This makes sense @JoshuaKGoldberg .

Should this be another CI? Or should it be augmented with the solutions CI?

from projects.

What do you see as the pros and cons of those two options? 🙂

from projects.

The cons of augmenting them IMO is if the solutions CI fail, and one runs the test on their local machine and it passes they might be confused. I would add descriptive logs like type errors at /path/to/file.

The pro of augmenting IMO is the speed of CI.

from projects.

if the solutions CI fail, and one runs the test on their local machine and it passes they might be confused

Sorry, I don't follow why this would be likely to happen? Assuming the user has run npm install, why would they be different locally vs. on CI?

I see the cons of augmenting as being mostly related to the cons of running the two checks in series:

• Clarity: If the first fails, the second won't even start
• Speed: The second can't start until the first is done.

They could be run in parallel, but the CI images are pretty limited and don't have a lot of cores. Also I'd imagine the output logs would be confusing to read.

In general for CI, I've found it to be better to have a single job/workflow per discrete action/check. In this case that would lean towards adding a new one for tsc.

from projects.