`tsci check` and `tsci check netlist` exit 0 when they report errors

Open
#5,776 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@aswadi is already working on this.

Since Nov 12, 2026.

  • #5777 by @aswadi — open
  • #5799 by @tirumallaharish0200 — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
57/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
bun, typescript
Domain
cli, testing

Research direction

Start with cli/check/register.ts and cli/check/netlist/register.ts, then compare how cli/check/placement/register.ts sets the exit code. Read tests/cli/check/check-all-diagnostics.test.ts and reproduce with the supplied floating-pin.circuit.tsx commands. Done means both check commands return a non-zero exit code when they report errors, with the test expectations updated to match the intended behavior.

Written by the indexing model from the issue text.

Description

What happens

tsci check netlist and plain tsci check print Errors: 1 and exit with code 0. tsci build on the same file exits 1, and tsci check placement exits 1 when it finds errors, so scripts and CI can't rely on the exit code of these two.

Reproduction

floating-pin.circuit.tsx:

export default () => (
  <board width="10mm" height="10mm" routingDisabled>
    <chip
      name="U1"
      footprint="soic8"
      pinLabels={{ pin1: "EN", pin4: "GND", pin8: "VCC" }}
      pinAttributes={{
        EN: { mustBeConnected: true },
        VCC: { requiresPower: true },
        GND: { requiresGround: true },
      }}
      connections={{ VCC: "net.VCC", GND: "net.GND" }}
    />
  </board>
)
tsci check netlist floating-pin.circuit.tsx; echo "exit=$?"
tsci check floating-pin.circuit.tsx; echo "exit=$?"
tsci build floating-pin.circuit.tsx --disable-parts-engine; echo "exit=$?"

Expected

A non-zero exit code when Errors: is greater than 0.

Actual

$ tsci check netlist floating-pin.circuit.tsx
Errors: 1
Warnings: 0
- source_pin_must_be_connected_error: Port EN on U1 must be connected but is floating
...
exit=0

$ tsci check floating-pin.circuit.tsx
Errors: 1
Warnings: 2
- source_pin_must_be_connected_error: Port EN on U1 must be connected but is floating
...
exit=0

$ tsci build floating-pin.circuit.tsx --disable-parts-engine
Port EN on U1 must be connected but is floating
1 error(s), all written to dist/floating-pin/errors.json:
...
Build exiting with code 1: circuit build errors occurred
exit=1

For comparison, tsci check placement on a board with two overlapping 0402 resistors prints placement summary: 1 pad overlap and exits 1.

Versions

tscircuit 0.0.3161 (@tscircuit/cli 0.1.2454), Bun 1.4.4, Linux.

Cause

The netlist action and the top-level check action only print the output; process.exit(1) is reached only when an exception is thrown:

placement sets the exit code from its result (added in #4247):
https://github.com/tscircuit/cli/blob/575228265fd48b2e29ad4c3287b35408e883fb47/cli/check/placement/register.ts#L205-L210

pin_specification and source have the same shape as netlist; I haven't found an input that makes them report an error, so I haven't confirmed their exit code.

A test currently pins exit 0 for plain tsci check with Errors: 3 (https://github.com/tscircuit/cli/blob/575228265fd48b2e29ad4c3287b35408e883fb47/tests/cli/check/check-all-diagnostics.test.ts#L28-L34), so this may be intentional. #5155 tried the netlist part together with another change; the review questioned that other change and the PR was closed as stale.

Suggestion

If exit 0 is intended, a --fail-on-error flag or a note in the docs would be enough. Otherwise: return the error count from checkNetlist / check and set process.exitCode = 1 when it is non-zero, as placement does.


AI-assisted: I used Claude Code to read the source, run the reproduction above and draft this report.

Dominant language
TypeScript
Stars
19
Forks
115
Avg merge
1h 50m
Merged PRs (30d)
260

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from tscircuit/cli

All issues in tscircuit/cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.