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.1.4.tar.gz (44.9 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.1.4-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for koreo-0.1.4.tar.gz
Algorithm Hash digest
SHA256 ddba1050c0134d53e223d5b7fecce288924c4a836e89f9f4d6911751b6d46d75
MD5 e36d518c461d63896a47786d3c1ebbfe
BLAKE2b-256 48297e0a6a5329f7bc1e25fb6070f8199c9333072973203216aa47079f5bd4c8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for koreo-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2d40e8d0ac96dc90fdfcd8f49e5c272870c68102380f7ee91ba6f362216f5cdd
MD5 a41fd8eee1d2048544f07fde8c5336f0
BLAKE2b-256 3c51cbd3b0af9e6f5292c2cdcf709a1954171e6a92dd40afe670dd73a0635ccc

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