Added json schema for 0.8 version #1617

mohsenari · 2023-11-10T16:52:10Z

Summary

Title says it.

I put the file in .schema/ directory so that in future if we change the schema we can align it with version. Meaning, we can add new schema files with version numbers and enforce the schema based on the version of devbox a user has installed. Putting it in root of this repository would make the root too crowded especially if we add more schema files.

I'm going to host our schema in this repository and subsequently send a PR to https://github.com/SchemaStore/schemastore/ with a link to the schema file in our repo to register our repo in https://schemastore.org

afterwards, I can update the vscode extension to reference the schemastore.org link and enforce our defined schema on files that are named devbox.json

How was it tested?

validated schema and examples of devbox.json in https://www.jsonschemavalidator.net/

mohsenari · 2023-11-10T16:57:57Z

.schema/0.8.schema.json

+            "required": [
+                "init_hook"
+            ]
+        }
+    },
+    "required": [
+        "packages",
+        "shell"
+    ]


I put these fields as required, If they're wrong or missing something lmk.

gcurtis

Awesome! I've been wanting this for a while. I left some wording suggestions, but feel free to take them or leave them as you see fit.

Question about the schema versioning - could we have a single schema.json and just link to specific commits in GitHub? For example, https://github.com/jetpack-io/devbox/blob/0.8.1/.schema/0.8.schema.json would return the schema as of devbox 0.8.1.

gcurtis · 2023-11-10T17:02:55Z

.schema/0.8.schema.json

+    "type": "object",
+    "properties": {
+        "packages": {
+            "description": "A specification of packages to be installed via devbox.",


Suggested change

"description": "A specification of packages to be installed via devbox.",

"description": "Collection of packages to install",

gcurtis · 2023-11-10T17:03:49Z

.schema/0.8.schema.json

+                    "patternProperties": {
+                        ".*": {
+                            "type": "string",
+                            "description": "Version number of the package in this object."


Suggested change

"description": "Version number of the package in this object."

"description": "Version of the package to install."

gcurtis · 2023-11-10T17:16:05Z

.schema/0.8.schema.json

+                    "patternProperties": {
+                        ".*": {
+                            "type": "object",
+                            "description": "Version number of the specified package in {\"version\": \"1.2.3\"} formmat.",


This object can contain a few more fields. I think they are:

version

platforms - only install the package on these Nix systems (e.g., aarch64-darwin, x86_64-linux, etc.)

excluded_platforms - don't install the package on these Nix systems.

glibc_patch - apply the glibc-patch feature to this package's binaries.

@gcurtis can you send me an example of devbox.json with these parameters included?
Also a list of all possible values for platforms/excluded_platforms.
Side note: If I remember correctly, platforms and excluded_platforms can not co-exist right?

gcurtis · 2023-11-10T17:16:21Z

.schema/0.8.schema.json

+                    "patternProperties": {
+                        ".*": {
+                            "type": "object",
+                            "description": "Version number of the specified package in {\"version\": \"1.2.3\"} formmat.",


Suggested change

"description": "Version number of the specified package in {\"version\": \"1.2.3\"} formmat.",

"description": "Version number of the specified package in {\"version\": \"1.2.3\"} format.",

gcurtis · 2023-11-10T17:21:41Z

.schema/0.8.schema.json

+            ]
+        },
+        "env": {
+            "description": "List of additional environment variables to be set in devbox shell. Values can contain $PATH and $PWD.",


Suggested change

"description": "List of additional environment variables to be set in devbox shell. Values can contain $PATH and $PWD.",

"description": "List of additional environment variables to be set in the Devbox environment. Values containing $PATH or $PWD will be expanded. No other variable expansion or command substitution will occur.",

gcurtis · 2023-11-10T17:22:28Z

.schema/0.8.schema.json

+            "description": "Definitions of scripts and actions to take when in devbox shell.",
+            "type": "object",
+            "properties": {
+                "init_hook": {


This can also be a single string.

gcurtis · 2023-11-10T17:23:20Z

.schema/0.8.schema.json

+                    }
+                },
+                "scripts": {
+                    "description": "List of commads/scripts definitions to run with `devbox run <script_name>` command.",


Suggested change

"description": "List of commads/scripts definitions to run with `devbox run <script_name>` command.",

"description": "List of command/script definitions to run with `devbox run <script_name>`.",

gcurtis · 2023-11-10T17:25:48Z

.schema/0.8.schema.json

+                "init_hook": {
+                    "type": "array",
+                    "items": {
+                        "description": "list of shell commands/scripts to run right after devbox shell starts.",


Suggested change

"description": "list of shell commands/scripts to run right after devbox shell starts.",

"description": "List of shell commands/scripts to run right after devbox shell starts.",

gcurtis · 2023-11-10T17:27:26Z

.schema/0.8.schema.json

+                            ],
+                            "items": {
+                                "type": "string",
+                                "description": "command/script to run as part of a list of commands defined here."


Suggested change

"description": "command/script to run as part of a list of commands defined here."

"description": "The script's shell commands."

gcurtis · 2023-11-10T17:28:24Z

.schema/0.8.schema.json

+            "required": [
+                "init_hook"
+            ]
+        }
+    },
+    "required": [
+        "packages",
+        "shell"
+    ]


Are these required? I thought an empty devbox.json object was valid.

I actually don't know. I'll test it out and if they weren't I'll remove.

Seems like empty devbox shell is accepted. I'll remove the required fields

mohsenari · 2023-11-10T18:36:17Z

Awesome! I've been wanting this for a while. I left some wording suggestions, but feel free to take them or leave them as you see fit.

Question about the schema versioning - could we have a single schema.json and just link to specific commits in GitHub? For example, https://github.com/jetpack-io/devbox/blob/0.8.1/.schema/0.8.schema.json would return the schema as of devbox 0.8.1.

@gcurtis
The link we provide has to point to the raw file content. If we can have the link to that within multiple versions then we can have a single file, otherwise we gotta keep a separate file per version

gcurtis · 2023-11-10T22:46:12Z

@mohsenari it should be possible to get the raw content. For example, https://raw.githubusercontent.com/jetpack-io/devbox/ab2e606cc3c71b9f84d92d1d22441b6b400bf959/.schema/0.8.schema.json

savil · 2023-11-16T23:10:13Z

.schema/devbox.schema.json

+                                "platform": {},
+                                "excluded_platform": {},


I think these should be platforms and excluded_platforms (note the s for plural)

added json schema for 0.8 version

686aa9a

mohsenari requested review from gcurtis, loreto and Lagoja November 10, 2023 16:52

mohsenari commented Nov 10, 2023

View reviewed changes

gcurtis approved these changes Nov 10, 2023

View reviewed changes

PR comments

ab2e606

mohsenari added 2 commits November 10, 2023 23:58

renamed to devbox.schema.json

2ea9b6b

Removed required fields

942de80

mohsenari merged commit e93a2f0 into main Nov 11, 2023

mohsenari deleted the mohsen--json-schema branch November 11, 2023 05:03

savil reviewed Nov 16, 2023

View reviewed changes

	"description": "A specification of packages to be installed via devbox.",
	"description": "Collection of packages to install",

	"description": "Version number of the package in this object."
	"description": "Version of the package to install."

	"description": "Version number of the specified package in {\"version\": \"1.2.3\"} formmat.",
	"description": "Version number of the specified package in {\"version\": \"1.2.3\"} format.",

	"description": "List of additional environment variables to be set in devbox shell. Values can contain $PATH and $PWD.",
	"description": "List of additional environment variables to be set in the Devbox environment. Values containing $PATH or $PWD will be expanded. No other variable expansion or command substitution will occur.",

	"description": "List of commads/scripts definitions to run with `devbox run <script_name>` command.",
	"description": "List of command/script definitions to run with `devbox run <script_name>`.",

	"description": "list of shell commands/scripts to run right after devbox shell starts.",
	"description": "List of shell commands/scripts to run right after devbox shell starts.",

	"description": "command/script to run as part of a list of commands defined here."
	"description": "The script's shell commands."

Added json schema for 0.8 version #1617

Added json schema for 0.8 version #1617

Uh oh!

Conversation

mohsenari commented Nov 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

How was it tested?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gcurtis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mohsenari commented Nov 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gcurtis commented Nov 10, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mohsenari commented Nov 10, 2023 •

edited

Loading

mohsenari commented Nov 10, 2023 •

edited

Loading