microsoft / microsoft/DefinitelyTyped-tools

Issues with check-parse-results

Open
#540 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
423
Forks
237
Avg merge
18h 18m
Merged PRs (30d)
11

Description

So, we just merged https://github.com/microsoft/DefinitelyTyped-tools/pull/484, and there are some issues with it:

  • The checks made by check-parse-results should ideally also run overnight to make sure everything is in order on DT, not only when there are PRs to this tools repo.
  • check-parse-results seems to write from the logger, but the checks it performs don't write to the log, they throw instead (https://github.com/microsoft/DefinitelyTyped-tools/blob/master/packages/dtslint-runner/src/check-parse-results.ts#L34-L36). We should change the checks so they log instead of throwing. This would mean that we log all failures at once (instead of stopping on the first failure).
  • The result of logging should show up somewhere visible. That's related to the first item above.

cc @jablko

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with packages/dtslint-runner/src/check-parse-results.ts, especially the checks at lines 34–36, to understand the current throwing and logging behavior. Identify how these checks could run overnight and where their output would be visible. Done means overnight execution is covered, all failures are logged instead of stopping at the first, and the results appear somewhere visible.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.