jordemort/action-pyright

A GitHub Action to run pyright

Hi, I’m Jordan. I’m a systems engineer. I build Linux distributions and Linux distribution accessories.

Latest blog posts

• Amazon's Dash Carts are unusably bad
• WeblogPoMo 2024: Books I read on vacation
• Jobs, swords, and doors
• Why Android can't use CDC Ethernet
• The License Plate Game

action-pyright's Issues

pyright installation installs all node dependencies

The action runs npm install pyright here (or similar when specific pyright version is specified). This means all node dependencies are installed as well if package.json exists in the repo as well. I don't think it's necessary and it slows down the check significantly.

It might be better to use npx/npm exec to install and run directly in one command.

Add some tests

It'd be nice to have some unit tests for pyright_to_rdjson.py

Action does not respect the reviewdog error level

The action produces error comments even when level: warning is set:

- name: pyright
  uses: jordemort/action-pyright@v1
  with:
    github_token: ${{ secrets.github_token }}
    reporter: github-pr-check
    level: warning
    filter_mode: diff_context
    lib: true

It would be great if the highest error level is reduced to the level specified in the action config.

Comments are off by 1 line

It seems like comments are generally off by 1 line, e.g.

This affects all test comments I have generated.

Action not catching obvious errors, and moving on

Hello!

I'm not even sure where to begin with this bug report.

I believe I have either misunderstood how to set up this action, or it will not catch obvious errors.

I noticed it during this run, where the Type Coverage step passed successfully, however there were numerous type errors relating to return type were completely missed.
My action specification at the time looked like this, which should have inherited from the pyproject.toml file outlined here.

I have managed to manually install node, and run pyright in an actual to verify that it will actually return these results, this can be viewed here in the "Run Pyright" step.

Could you please let me know if this is an issue with you, or me? I very much like and appreciate the features you offer.

pyright_to_rdjson.py - KeyError: 'rule'

Hi, I was hoping to test out this action, but there seems to be an issue in pyright_to_rdjson.py regarding a KeyError. I'm guessing the output format from pyright has changed slightly?

I may find the time in the next week or so to look into it, but if you already know how to solve it, some help/input would be appreciated!

Example stacktrace:

  Searching for source files
  Found 10 source files
  Traceback (most recent call last):
    File "/home/runner/work/_actions/jordemort/action-pyright/v1/pyright_to_rdjson.py", line 44, in <module>
      print(pyright_to_rdjson(sys.stdin))
    File "/home/runner/work/_actions/jordemort/action-pyright/v1/pyright_to_rdjson.py", line 22, in pyright_to_rdjson
      "message": f"{d['message']} ({d['rule']})",
  KeyError: 'rule'
  reviewdog: parse error: failed to unmarshal rdjson (DiagnosticResult): proto: syntax error (line 1:1): unexpected token 

Fails with 'Broken pipe'

Setup this action using a default config of:

    - uses: jordemort/action-pyright@v1
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }} # You need this
        reporter: github-pr-review

This gives me this output when running the action:

  Traceback (most recent call last):
    File "/home/runner/work/_actions/jordemort/action-pyright/v1/pyright_to_rdjson.py", line 52, in <module>
      print(pyright_to_rdjson(sys.stdin))
  BrokenPipeError: [Errno 32] Broken pipe
  Error: Process completed with exit code 1.

Do you have any clue as to what could be going on here?