Skip to main content

Tooling package for Koreo

Project description

koreo-tooling

Developer tooling to make working with Koreo Workflows, Functions, and ResourceTemplates easy.

We provide a CLI tool, for use within CICD or by hand.

More helpfully, we provide a language server that surfaces issues within your IDE.

Inspector

A helper to get information about Workflow trigger resource, and the resources created by a Workflow. Without -v, basic summary information will be printed for each resource. With each additional -v, more information is output (up to the full object).

pdm run python src/inspector.py TriggerDummy -n koreo-update-loop difference-demo -v

Language Server

Register the Koreo LSP with your IDE. Maybe in a config block like this:

"koreo-ls": {
  "command": "koreo-ls",
  "filetypes": ["koreo"],
  "root_dir": ["*.git"]
}

Implemented Capabilities

Diagnostics

Robust diagnostic messages to help spot errors early, ensure tests are passing, and that resources are correctly named.

Diagnostics combined with FunctionTests provide an immediate and rich development feedback loop to make writing Koreo feel like a first-class language.

Semantic Syntax Highlighting

We support LSP semantic syntax highlighting capabilities. This provides rich syntax highlighting with deeper information than typically available.

Go to Def / Ref

Go to Workflow or Function definitions or list references. Navigation supports constant named ResourceTemplates as well.

Hover Status for Workflows & Functions

Hover information is available for Workflows, Workflow Steps, and Functions.

This is an area with a lot of potential for enhancement going forward.

Inlay Hints to indicate FunctionTest outcome

To make testing within Koreo easy, FunctionTest supports inlay-hints to indicate success or failure of the function test.

Basic completion (Early WIP)

Context-aware auto-completion recommendations. Recommending implemented function names for Workflow steps, for example.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

koreo-0.3.0.tar.gz (46.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

koreo-0.3.0-py3-none-any.whl (54.6 kB view details)

Uploaded Python 3

File details

Details for the file koreo-0.3.0.tar.gz.

File metadata

  • Download URL: koreo-0.3.0.tar.gz
  • Upload date:
  • Size: 46.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.24.1 CPython/3.13.3 Linux/6.11.0-1012-azure

File hashes

Hashes for koreo-0.3.0.tar.gz
Algorithm Hash digest
SHA256 2a7389888af8ce47dfcce25454b5474e461ea339840cc2f284a3f3d6c4b6d98a
MD5 a9e87b953c5990c19ebb3399fce28334
BLAKE2b-256 60127b7cc30f09c8b3234ecaee5452f137e70fda456e9c656df78df54ce8cd5a

See more details on using hashes here.

File details

Details for the file koreo-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: koreo-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 54.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.24.1 CPython/3.13.3 Linux/6.11.0-1012-azure

File hashes

Hashes for koreo-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8d613b7c3d087f44330747722637ebc3ba83ca2088ac432b4c4c3eaf798df4c3
MD5 602a5a3350bef74f29b750d0033eb735
BLAKE2b-256 3c214b1cb4b2782a6e2a537b1ace872fe5025c6c777f24f3c7b678ff7f2fc215

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page