Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Json schema to provide coding assistance for goss.yaml in IDEs #793

Merged
merged 6 commits into from
Dec 25, 2022
Merged

Json schema to provide coding assistance for goss.yaml in IDEs #793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
982fe96
Initial addition of goss json schema
gberche-orange Dec 21, 2022
b2d6183
Document using Json schema draft 7
gberche-orange Dec 22, 2022
8fe9eea
Document maintaining Json schema
gberche-orange Dec 22, 2022
ac8b1ef
Json schema support for matching
gberche-orange Dec 22, 2022
d3dd6df
Refine Json schema with initial support for matcher illustrated in ex…
gberche-orange Dec 22, 2022
ce7a121
Refine Json schema with title and meta attributes
gberche-orange Dec 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,13 @@ curl -H "Accept: application/vnd.goss-rspecish" localhost:8080/healthz

### Manually editing Goss files

Goss files can be manually edited to use:
Goss files can be manually edited to improve readability and expresssiveneess of tests.

A [Json draft 7 schema](https://github.com/json-schema-org/json-schema-spec/blob/draft-07/schema.json) available in [docs/goss-json-schema.yaml](./docs/goss-json-schema.yaml) makes it easier to edit simple goss.yaml files in IDEs, providing usual coding assistance such as inline documentation, completion and static analysis.

For example, to configure the Json schema in JetBrains intellij IDEA, follow [documented instructions](https://www.jetbrains.com/help/idea/json.html#ws_json_schema_add_custom), with arguments such as `schema url=https://raw.githubusercontent.com/goss-org/goss/master/docs/goss-json-schema.yaml`, `schema version=Json schema version 7`, `file path pattern=*/goss.yaml`

In addition, Goss files can also be further manually edited (without full json support) to use:

* [Patterns](https://github.com/goss-org/goss/blob/master/docs/manual.md#patterns)
* [Advanced Matchers](https://github.com/goss-org/goss/blob/master/docs/manual.md#advanced-matchers)
Expand Down
Loading