[PR #4141] [MERGED] feat: CLI collection runner command generation UI flow #4676

New issue

Closed

opened 2026-03-17 02:11:34 +03:00 by kerem · 0 comments

kerem commented

2026-03-17 02:11:34 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/4141
Author: @jamesgeorge007
Created: 6/22/2024
Status: ✅ Merged
Merged: 6/27/2024
Merged by: @jamesgeorge007

Base: next ← Head: feat/cli-collection-runner-command-gen-ui

📝 Commits (10+)

715d457 feat: CLI collection runner command generation UI flow
bc38bbb feat: add new Details tab under Collection Properties modal
3106ca1 feat: add Environment Properties modal
2571b40 chore: Collection Properties modal updates
a205aa6 chore: cleanup
1cf15ab chore: move to i18n strings
4a0c5af fix: prevent the exception while dismissing environment context menu
ed5e9c3 refactor: update editingProperties prop type for the CollectionsProperties component
fe2ee2f chore: allow user to select ID's
3f8a477 chore: minor change

📊 Changes

11 files changed (+584 additions, -97 deletions)

View changed files

📝 packages/hoppscotch-common/locales/en.json (+18 -2)
📝 packages/hoppscotch-common/src/components.d.ts (+2 -0)
📝 packages/hoppscotch-common/src/components/collections/Collection.vue (+42 -17)
📝 packages/hoppscotch-common/src/components/collections/Properties.vue (+98 -18)
➕ packages/hoppscotch-common/src/components/collections/Runner.vue (+149 -0)
📝 packages/hoppscotch-common/src/components/collections/TeamCollections.vue (+3 -0)
📝 packages/hoppscotch-common/src/components/collections/index.vue (+101 -48)
➕ packages/hoppscotch-common/src/components/environments/Properties.vue (+123 -0)
📝 packages/hoppscotch-common/src/components/environments/teams/Environment.vue (+29 -12)
📝 packages/hoppscotch-common/src/components/environments/teams/index.vue (+18 -0)
📝 packages/hoppscotch-common/src/vite-envs.d.ts (+1 -0)

📄 Description

Description

#4095 adds support for accessing collections/environments from a team workspace straightaway via the CLI by supplying the respective IDs without having to obtain an export. This PR includes UI flow updates to support the same where the CLI command to run a certain collection with the ID can be obtained (optionally including the active environment) via the context menu.

Closes HFE-520.

Changes

Fixes the case about dismissing the environment context menu (opened via pressing the More kebab menu) via pressing Escape, which results in an exception.
Made editingProperties a required prop for the CollectionsProperties component with null removed from the types since the existing usages guarantee the above prop to be an object.

The below additions apply only to team workspaces.

New Run collection action under the context menu option for collections that displays the modal with the respective CLI command to run the collection, optionally including any active environment. It can also be accessed while hovering over a certain collection.
The Collection Properties modal now includes a new Details tab that shows the collection ID.
There'll be a new properties action under the context menu for environments that opens a new Environment Properties modal which displays the respective environment ID.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/hoppscotch/hoppscotch/pull/4141 **Author:** [@jamesgeorge007](https://github.com/jamesgeorge007) **Created:** 6/22/2024 **Status:** ✅ Merged **Merged:** 6/27/2024 **Merged by:** [@jamesgeorge007](https://github.com/jamesgeorge007) **Base:** `next` ← **Head:** `feat/cli-collection-runner-command-gen-ui` --- ### 📝 Commits (10+) - [`715d457`](https://github.com/hoppscotch/hoppscotch/commit/715d4577f3140287d0b0102e94f5e7cec84f0d58) feat: CLI collection runner command generation UI flow - [`bc38bbb`](https://github.com/hoppscotch/hoppscotch/commit/bc38bbb577f92d40bfd89403f718e5e841b1ad81) feat: add new `Details` tab under `Collection Properties` modal - [`3106ca1`](https://github.com/hoppscotch/hoppscotch/commit/3106ca136042a2ed8512d1fda03ec509caf6344d) feat: add `Environment Properties` modal - [`2571b40`](https://github.com/hoppscotch/hoppscotch/commit/2571b40d7583debca2c936cf02684977211edab8) chore: `Collection Properties` modal updates - [`a205aa6`](https://github.com/hoppscotch/hoppscotch/commit/a205aa6c9b8baaf70388d49472232ac1b4e8a33c) chore: cleanup - [`1cf15ab`](https://github.com/hoppscotch/hoppscotch/commit/1cf15abbce9d007956d0de4374289aa475f92a0a) chore: move to i18n strings - [`4a0c5af`](https://github.com/hoppscotch/hoppscotch/commit/4a0c5af3707e9d8698711248cc2153e38a6e11ce) fix: prevent the exception while dismissing environment context menu - [`ed5e9c3`](https://github.com/hoppscotch/hoppscotch/commit/ed5e9c3ced738be6b93c4128259cde7a6d1ab486) refactor: update `editingProperties` prop type for the `CollectionsProperties` component - [`fe2ee2f`](https://github.com/hoppscotch/hoppscotch/commit/fe2ee2f5d5c194b8cf65998945790de9b1836e55) chore: allow user to select ID's - [`3f8a477`](https://github.com/hoppscotch/hoppscotch/commit/3f8a4773b80f46df130be7fd8359808f53305424) chore: minor change ### 📊 Changes **11 files changed** (+584 additions, -97 deletions) <details> <summary>View changed files</summary> 📝 `packages/hoppscotch-common/locales/en.json` (+18 -2) 📝 `packages/hoppscotch-common/src/components.d.ts` (+2 -0) 📝 `packages/hoppscotch-common/src/components/collections/Collection.vue` (+42 -17) 📝 `packages/hoppscotch-common/src/components/collections/Properties.vue` (+98 -18) ➕ `packages/hoppscotch-common/src/components/collections/Runner.vue` (+149 -0) 📝 `packages/hoppscotch-common/src/components/collections/TeamCollections.vue` (+3 -0) 📝 `packages/hoppscotch-common/src/components/collections/index.vue` (+101 -48) ➕ `packages/hoppscotch-common/src/components/environments/Properties.vue` (+123 -0) 📝 `packages/hoppscotch-common/src/components/environments/teams/Environment.vue` (+29 -12) 📝 `packages/hoppscotch-common/src/components/environments/teams/index.vue` (+18 -0) 📝 `packages/hoppscotch-common/src/vite-envs.d.ts` (+1 -0) </details> ### 📄 Description ### Description #4095 adds support for accessing collections/environments from a team workspace straightaway via the CLI by supplying the respective IDs without having to obtain an export. This PR includes UI flow updates to support the same where the CLI command to run a certain collection with the ID can be obtained (optionally including the active environment) via the context menu. Closes HFE-520. ### Changes - Fixes the case about dismissing the environment context menu (opened via pressing the `More` kebab menu) via pressing `Escape`, which results in an exception. <img width="496" alt="image" src="https://github.com/hoppscotch/hoppscotch/assets/25279263/c1161e83-7c8b-4710-99f9-f0c57fcb6d61"> - Made `editingProperties` a required prop for the `CollectionsProperties` component with `null` removed from the types since the existing usages guarantee the above prop to be an object. > The below additions apply only to team workspaces. - New `Run collection` action under the context menu option for collections that displays the modal with the respective CLI command to run the collection, optionally including any active environment. It can also be accessed while hovering over a certain collection. <img width="440" alt="image" src="https://github.com/hoppscotch/hoppscotch/assets/25279263/fe425732-e2ba-47bd-9761-d19dc31937ab"> ![image](https://github.com/hoppscotch/hoppscotch/assets/25279263/5abf3ab3-b373-43dd-a798-59aaac9c2185) <img width="525" alt="image" src="https://github.com/hoppscotch/hoppscotch/assets/25279263/60f15f54-169b-4a80-bed0-67a0e8aa493f"> - The `Collection Properties` modal now includes a new `Details` tab that shows the collection ID. <img width="527" alt="image" src="https://github.com/hoppscotch/hoppscotch/assets/25279263/1cfb948c-780d-49ef-8cfe-706f98e03225"> - There'll be a new `properties` action under the context menu for environments that opens a new `Environment Properties` modal which displays the respective environment ID. ![image](https://github.com/hoppscotch/hoppscotch/assets/25279263/0038c6b4-7753-47d2-a203-6e8190fe2069) <img width="526" alt="image" src="https://github.com/hoppscotch/hoppscotch/assets/25279263/14a23d5d-5191-4224-ad78-8455a0b739b1"> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>