feat: Added descriptions to all JSON schemas

kevinwang5658 · kevinwang5658 · commit b0ef2a42dcc1 · 2025-02-18T08:06:42.000-05:00
diff --git a/src/resources/android/android-studio-schema.json b/src/resources/android/android-studio-schema.json
@@ -3,13 +3,16 @@
   "$id": "https://www.codifycli.com/pgcli.json",
   "title": "Android studios resource",
   "type": "object",
+  "description": "Install Android Studios.",
   "properties": {
     "version": {
       "type": "string",
       "description": "Android studios version. Visit: https://developer.android.com/studio/releases for version info"
     },
     "directory": {
-
+      "type": "string",
+      "description": "The directory to install Android Studios into. Defaults to /Applications",
+      "default": "/Applications"
     }
   },
   "additionalProperties": false
diff --git a/src/resources/asdf/asdf-global-schema.json b/src/resources/asdf/asdf-global-schema.json
@@ -3,6 +3,7 @@
   "$id": "https://www.codifycli.com/asdf-global-schema.json",
   "title": "Asdf plugin global resource",
   "type": "object",
+  "description": "Manage the asdf global version for a tool. An asdf-global or asdf-local resource must be specified before a tool installed with asdf is active in the shell.",
   "properties": {
     "plugin": {
       "type": "string",
diff --git a/src/resources/asdf/asdf-install-schema.json b/src/resources/asdf/asdf-install-schema.json
@@ -3,6 +3,7 @@
   "$id": "https://www.codifycli.com/asdf-install-schema.json",
   "title": "Asdf plugin resource",
   "type": "object",
+  "description": "Install a .tools-version file or directly install an asdf plugin + tool version.",
   "properties": {
     "plugin": {
       "type": "string",
diff --git a/src/resources/asdf/asdf-local-schema.json b/src/resources/asdf/asdf-local-schema.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/asdf-local-schema.json",
   "title": "Asdf plugin local resource",
+  "description": "Manage the asdf local version for a tool. An asdf-global or asdf-local resource must be specified before a tool installed with asdf is active in the shell.",
   "type": "object",
   "properties": {
     "plugin": {
diff --git a/src/resources/asdf/asdf-plugin-schema.json b/src/resources/asdf/asdf-plugin-schema.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/asdf-plugin-schema.json",
   "title": "Asdf plugin resource",
+  "description": "Installs a plugin and manages specific tool versions.",
   "type": "object",
   "properties": {
     "plugin": {
diff --git a/src/resources/asdf/asdf-schema.json b/src/resources/asdf/asdf-schema.json
@@ -3,6 +3,7 @@
   "$id": "https://www.codifycli.com/asdf-schema.json",
   "title": "Asdf resource",
   "type": "object",
+  "description": "Installs asdf and manages asdf plugins. Use 'asdf-install' or 'asdf-plugin' to install the actual tool. Use 'asdf-global' or 'asdf-local' to activate the tool in the shell.",
   "properties": {
     "plugins": {
       "type": "array",
diff --git a/src/resources/aws-cli/cli/aws-cli-schema.json b/src/resources/aws-cli/cli/aws-cli-schema.json
@@ -3,6 +3,7 @@
   "$id": "https://www.codifycli.com/aws-cli.json",
   "title": "Aws-CLI resource",
   "type": "object",
+  "description": "Installs aws-cli.",
   "properties": {},
   "additionalProperties": false
 }
diff --git a/src/resources/aws-cli/profile/aws-profile-schema.json b/src/resources/aws-cli/profile/aws-profile-schema.json
@@ -3,6 +3,7 @@
   "$id": "https://www.codifycli.com/aws-profile.json",
   "title": "Aws-CLI configure resource",
   "type": "object",
+  "description": "Configures AWS profiles.",
   "properties": {
     "profile": {
       "type": "string",
diff --git a/src/resources/git/clone/git-clone-schema.json b/src/resources/git/clone/git-clone-schema.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/git-clone.json",
   "title": "Git-clone resource",
+  "description": "Git clone a repository. Choose either to specify the exact directory to clone into or the parent directory (it deduces the folder name using the repository name).",
   "type": "object",
   "properties": {
     "repository": {
diff --git a/src/resources/git/git/git-schema.json b/src/resources/git/git/git-schema.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/git.json",
   "title": "Git resource",
+  "description": "Set and manage global git settings (email and username)",
   "type": "object",
   "properties": {
     "email": {
diff --git a/src/resources/git/lfs/git-lfs-schema.json b/src/resources/git/lfs/git-lfs-schema.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/git-lfs.json",
   "title": "Git-LFS resource",
+  "description": "Installs git-lfs. This resource will automatically activate git-lfs as well.",
   "type": "object",
   "properties": {},
   "additionalProperties": false
diff --git a/src/resources/homebrew/homebrew-schema.json b/src/resources/homebrew/homebrew-schema.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/homebrew-main.json",
   "title": "Homebrew plugin main resource",
+  "description": "Install homebrew and manages formulae, casks and taps.",
   "type": "object",
   "properties": {
     "formulae": {
diff --git a/src/resources/java/jenv/jenv-schema.json b/src/resources/java/jenv/jenv-schema.json
@@ -3,14 +3,17 @@
   "$id": "https://www.codifycli.com/jenv.json",
   "title": "Jenv resource",
   "type": "object",
+  "description": "Install jenv and manage Java versions using jenv. Jenv cannot install Java directly, it needs to be installed separately and added to Jenv.",
   "properties": {
     "add": {
       "type": "array",
+      "description": "The java_home path to add to jenv. Jenv does not directly install Java. This resources optionally allows users to specify a LTS version instead of a path (8, 11, 17, 21, 22) and install it via Homebrew",
       "items": {
         "type": "string"
       }
     },
     "global": {
+      "description": "Set the global Java version using Jenv.",
       "type": "string"
     }
   },
diff --git a/src/resources/node/nvm/nvm-schema.json b/src/resources/node/nvm/nvm-schema.json
@@ -2,15 +2,18 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/nvm.json",
   "title": "Nvm resource",
+  "description": "Install and manage Node versions using nvm.",
   "type": "object",
   "properties": {
     "nodeVersions": {
       "type": "array",
+      "description": "An array of node versions to install using nvm. Partial matching is supported (20 instead of 20.15.1)",
       "items": {
         "type": "string"
       }
     },
     "global": {
+      "description": "The global Node version set by nvm.",
       "type": "string"
     }
   },
diff --git a/src/resources/pgcli/pgcli-schema.json b/src/resources/pgcli/pgcli-schema.json
@@ -3,6 +3,7 @@
   "$id": "https://www.codifycli.com/pgcli.json",
   "title": "Pgcli resource",
   "type": "object",
+  "description": "Installs pgcli.",
   "properties": {},
   "additionalProperties": false
 }
diff --git a/src/resources/python/pyenv/pyenv-schema.json b/src/resources/python/pyenv/pyenv-schema.json
@@ -3,15 +3,18 @@
   "$id": "https://www.codifycli.com/pyenv.json",
   "title": "Pyenv resource",
   "type": "object",
+  "description": "Install and manage Python versions using pyenv.",
   "properties": {
     "pythonVersions": {
       "type": "array",
+      "description": "An array of Python versions to install using pyenv. Partial matching is supported (3.9 instead of 3.9.11)",
       "items": {
         "type": "string"
       }
     },
     "global": {
-      "type": "string"
+      "type": "string",
+      "description": "The global Python version set by pyenv."
     }
   },
   "additionalProperties": false
diff --git a/src/resources/scripting/action-schema.json b/src/resources/scripting/action-schema.json
@@ -2,16 +2,20 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/action.json",
   "title": "Action resource",
+  "description": "Run custom scripts using the action resource. A condition can be specified to conditionally trigger a script.",
   "type": "object",
   "properties": {
     "condition": {
-      "type": "string"
+      "type": "string",
+      "description": "A condition (in bash) that decides if the action is triggered. Return 0 to trigger and any non-zero exit code to skip."
     },
     "action": {
-      "type": "string"
+      "type": "string",
+      "description": "A bash command to run."
     },
     "cwd": {
-      "type": "string"
+      "type": "string",
+      "description": "The directory that the action should be ran in."
     }
   },
   "required": ["action"],
diff --git a/src/resources/scripting/file-schema.json b/src/resources/scripting/file-schema.json
@@ -2,16 +2,20 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/file.json",
   "title": "File resource",
+  "description": "Manages a file.",
   "type": "object",
   "properties": {
     "path": {
-      "type": "string"
+      "type": "string",
+      "description": "The location of the file."
     },
     "contents": {
-      "type": "string"
+      "type": "string",
+      "description": "The contents of the file."
     },
     "onlyCreate": {
-      "type": "boolean"
+      "type": "boolean",
+      "description": "Forces the resource to only create the file if it doesn't exist but don't detect any content changes."
     }
   },
   "required": ["path", "contents"],
diff --git a/src/resources/shell/alias/alias-schema.json b/src/resources/shell/alias/alias-schema.json
@@ -1,13 +1,14 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://www.codifycli.com/path.json",
-  "title": "Path resource",
+  "$id": "https://www.codifycli.com/alias.json",
+  "title": "Alias resource",
+  "description": "Manages user aliases. It permanently saves the alias by adding it to the shell startup script.",
   "type": "object",
   "properties": {
     "alias": {
       "type": "string",
       "pattern": "^[^ \t\n/\\$`=|&;()<>'\"]*$",
-      "description": "The path to append. This parameter cannot be used at the same time as paths"
+      "description": "The name of the alias"
     },
     "value": {
       "type": "string",
diff --git a/src/resources/shell/path/path-schema.json b/src/resources/shell/path/path-schema.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/path.json",
   "title": "Path resource",
+  "description": "Manages user paths. It will permanently save paths by adding them to the shell startup script.",
   "type": "object",
   "properties": {
     "path": {
diff --git a/src/resources/ssh/ssh-add-schema.json b/src/resources/ssh/ssh-add-schema.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/ssh-add.json",
   "title": "Ssh add resource",
+  "description": "Adds ssh private keys to the ssh agent.",
   "type": "object",
   "properties": {
     "path": {
diff --git a/src/resources/ssh/ssh-config-schema.json b/src/resources/ssh/ssh-config-schema.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/ssh-config.json",
   "title": "Ssh config resource",
+  "description": "Configures the ssh config file.",
   "type": "object",
   "properties": {
     "hosts": {
diff --git a/src/resources/ssh/ssh-key-schema.json b/src/resources/ssh/ssh-key-schema.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/ssh-key.json",
   "title": "Ssh key resource",
+  "description": "Generate and manage a ssh private/public key.",
   "type": "object",
   "properties": {
     "keyType": {
diff --git a/src/resources/terraform/terraform-schema.json b/src/resources/terraform/terraform-schema.json
@@ -2,13 +2,16 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/terraform.json",
   "title": "Terraform resource",
+  "description": "Installs Terraform.",
   "type": "object",
   "properties": {
     "directory": {
-      "type": "string"
+      "type": "string",
+      "description": "The directory to install Terraform. Defaults to /usr/local/bin."
     },
     "version": {
-      "type": "string"
+      "type": "string",
+      "description": "The specific version of Terraform to install. Defaults to latest."
     }
   },
   "additionalProperties": false
diff --git a/src/resources/vscode/vscode-schema.json b/src/resources/vscode/vscode-schema.json
@@ -2,11 +2,12 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://www.codifycli.com/vscode.json",
   "title": "Vscode resource",
+  "description": "Installs Vscode.",
   "type": "object",
   "properties": {
     "directory": {
       "type": "string",
-      "description": "The installation of VSCode. This value defaults to the Applications folder",
+      "description": "The directory to install VSCode into. Defaults to /Applications.",
       "default": "/Applications"
     }
   },

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`"$id": "https://www.codifycli.com/aws-cli.json",`
`4`	`4`	`"title": "Aws-CLI resource",`
`5`	`5`	`"type": "object",`
	`6`	`+ "description": "Installs aws-cli.",`
`6`	`7`	`"properties": {},`
`7`	`8`	`"additionalProperties": false`
`8`	`9`	`}`