oasisprotocol / oasisprotocol/cli
rofl.yaml could specify a schema to have autocomplete
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 80
- Forks
- 23
- Avg merge
- 9h 43m
- Merged PRs (30d)
- 3
Description
Depending on how often users will manually edit rofl.yaml, it may be worth adding a yaml schema.
But yaml schema support in editors is not as common as json schema support
- vscode needs extension https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
- zed does support it https://zed.dev/docs/languages/yaml
# yaml-language-server: $schema=https://raw.githubusercontent.com/oasisprotocol/cli/...schema.json
This works like "$schema": in json:
- editor marks typos and type errors
- editor autocompletes field names
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the rofl.yaml format and determining where a schema.json could be maintained and published. Check the YAML language-server schema convention described in the issue and verify the resulting URL works; done means supported editors can autocomplete fields and flag typos or type errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100