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.2.0.tar.gz (43.3 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.2.0-py3-none-any.whl (50.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: koreo-0.2.0.tar.gz
  • Upload date:
  • Size: 43.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.23.1 CPython/3.13.2 Linux/6.8.0-1021-azure

File hashes

Hashes for koreo-0.2.0.tar.gz
Algorithm Hash digest
SHA256 41cdb3df2187739a47c1d75638337da166963e75f0e59cbec11a3cb0d73af27d
MD5 57c4225bc8025629f3afae85e6178002
BLAKE2b-256 437ce167e0764e93a6ebeb2b6f596ef13fb884f89009b64d23fdefa59671f5ab

See more details on using hashes here.

File details

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

File metadata

  • Download URL: koreo-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 50.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.23.1 CPython/3.13.2 Linux/6.8.0-1021-azure

File hashes

Hashes for koreo-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d084543092b9461c62c57793c0e7237231bc2f21fcdf786bb08ac4d8bd0021b4
MD5 8ed437b4dc3998f9d86d71b049eaf1c9
BLAKE2b-256 03f2281ba907a17a372ebf2f828c8267325ef2dc67c6ea5b4d0a66a08c03f136

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