Skip to content
This repository has been archived by the owner on Aug 23, 2022. It is now read-only.

Latest commit

 

History

History
81 lines (51 loc) · 3.54 KB

README.md

File metadata and controls

81 lines (51 loc) · 3.54 KB
Raw

coc-pyright-tools

!!WARNING!!

Inlay hints feature of coc-pyright-tools, have been ported to coc-pyright itself. https://github.com/fannheyward/coc-pyright/commit/1f36838eaacc0d564946733e847a785709550966

coc-pyright-tools is no longer maintained

coc-pyright-tools is a coc-extension that adds its own functionality to coc-pyright for coc.nvim. Currently the "Inlay Hints", "CodeLens" and "Test Framework commands" feature is available.

Install

e.g. vim-plug:

Plug 'yaegassy/coc-pyright-tools', {'do': 'yarn install --frozen-lockfile'}

Requirement

You must have coc-pyright installed to use the features of coc-pyright-tools. Check the coc-pyright repository for installation instructions.

Features

Inlay Hints

Pyright itself does not provide inlay hints, but implements client-based Pylance-like inlay hints feature.

Check about Pylance inlay type hints. See: https://devblogs.microsoft.com/python/python-in-visual-studio-code-july-2022-release/#inlay-type-hints

DEMO (mp4):

coc-pyright-tools-inlay-hints.mp4

CodeLens

Running test such as unittest, pytest, etc.

DEMO (mp4):

coc-pyright-tools-code-lens-unittest.mp4

Commands

  • pyright-tools.toggleInlayHints: Toggle enable/disable inlay hints
  • pyright-tools.unittest.fileTest: Run unittest for current file
  • pyright-tools.unittest.singleTest: Run unittest for single (nearest) test
  • pyright-tools.pytest.fileTest: Run pytest for current file
  • pyright-tools.pytest.singleTest: Run pytest for single (nearest) test

Configuration options

  • pyright-tools.enable: Enable coc-pyright-tools extension, default: true
  • pyright-tools.python.interpreterPath: Path to the Python interpreter executable. Particularly important if you are using a Python virtual environment. Leave blank to use Python from PATH, default: ""
  • pyright-tools.inlayHints.enable: Enable/disable inlay hints feature, true
  • pyright-tools.inlayHints.functionReturnTypes: Enable/disable inlay hints for function return types, default: true
  • pyright-tools.inlayHints.variableTypes: Enable/disable inlay hints for variable types, default: true
  • pyright-tools.codeLens.enable: Enable/disable codelens feature, default: true
  • pyright-tools.codeLens.testFramework: Testing framework used by codelens, valid options ["unittest", "pytest"], default: unittest
  • pyright-tools.codeLens.unittestTitle: CodeLens title. Can be changed to any display, default: >> [Run unittest]
  • pyright-tools.codeLens.pytestTitle: CodeLens title. Can be changed to any display, default: >> [Run pytest]
  • pyright-tools.test.unittestArgs: Arguments passed in. Each argument is a separate item in the array, default: []
  • pyright-tools.test.pytestArgs: Arguments passed in. Each argument is a separate item in the array, default: []
  • pyright-tools.terminal.enableSplitRight: Use vertical belowright for unittest/pytest terminal window, default: false

Thanks

License

MIT

This extension is built with create-coc-extension