From 5081f30daf1667423e1cff4c4e92f89b0aaf19e7 Mon Sep 17 00:00:00 2001 From: Amr Bashir Date: Tue, 13 Aug 2024 13:55:55 +0300 Subject: [PATCH] fix(shell): fix inlined docs for scope (#1656) * fix(shell): fix inlined docs for scope * Update plugins/shell/guest-js/index.ts --------- Co-authored-by: Lucas Fernandes Nogueira --- plugins/shell/guest-js/index.ts | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/plugins/shell/guest-js/index.ts b/plugins/shell/guest-js/index.ts index 45a95273..ea27ba85 100644 --- a/plugins/shell/guest-js/index.ts +++ b/plugins/shell/guest-js/index.ts @@ -18,7 +18,7 @@ * * ### Restricting access to the {@link Command | `Command`} APIs * - * The plugin configuration object has a `scope` field that defines an array of CLIs that can be used. + * The plugin permissions object has a `scope` field that defines an array of CLIs that can be used. * Each CLI is a configuration object `{ name: string, cmd: string, sidecar?: bool, args?: boolean | Arg[] }`. * * - `name`: the unique identifier of the command, passed to the {@link Command.create | Command.create function}. @@ -35,12 +35,13 @@ * * CLI: `git commit -m "the commit message"` * - * Configuration: + * Capability: * ```json * { - * "plugins": { - * "shell": { - * "scope": [ + * "permissions": [ + * { + * "identifier": "shell:allow-execute", + * "allow": [ * { * "name": "run-git-commit", * "cmd": "git", @@ -48,7 +49,7 @@ * } * ] * } - * } + * ] * } * ``` * Usage: