issue-1060 Add scriptId argument to list-deployments and list-versions commands #1066

wattry · 2025-05-30T23:44:22Z

Allow script ID as argument for list-deployments & list-versions

Add --json option to list-deployments & list-versions

Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)

npm run test succeeds.

 128 passing (581ms)

npm run lint succeeds.

 λ npm run lint --fix

> @google/[email protected] lint
> npm run check


> @google/[email protected] check
> biome check src test && npm run compile

Checked 73 files in 24ms. No fixes applied.

> @google/[email protected] compile
> tspc

Appropriate changes to README are included in PR.

### Versions

List versions of a script.

#### Options

- `--json`: Output list in json format.

#### Examples

- `clasp list-versions`: List all versions for the current project
- `clasp list-versions --json`: List all versions for the current project and output in json
- `clasp list-versions [scriptId]`: List all versions for a script ID
- `clasp list-versions --json [scriptId]`: List all versions for a script ID and output in json


### Deployments

List deployments of a script.

#### Options

- `--json`: Output list in json format.

#### Examples

- `clasp list-deployments`: List all deployments for the current project
- `clasp list-deployments --json`: List all deployments for the current project and output in json
- `clasp list-deployments [scriptId]`: List all deployments for a script ID
- `clasp list-deployments [scriptId] --json`: List all deployments for a script ID and output in json

google-cla · 2025-05-30T23:44:26Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

sqrrrl · 2025-07-23T01:14:26Z

Didn't mean to close the issue yet, but wanted the --json flag to be a global option so it's consistent throughout all the commands. If you can resolve the merge conflicts, happy to merge the parameter stuff (but similarly, would rather do this uniformly if there are additional commands that would benefit)

wattry · 2025-07-23T15:48:19Z

Ah okay I thought you were closing it because you were already implementing it globally as a broader change and this was unnecessary.

sqrrrl · 2025-07-23T17:24:07Z

Also should be able to do this without modifying anything in src/core. There's a method on the clasp instance to set the script ID if it isn't already set:

const clasp = options.clasp;
if (scriptId) { 
  clasp.withScriptId(scriptId);
}

Right now that withScriptId function will throw an error if the script is already known, so this would fail if the user is calling it in a dir with a valid clasp project, but we can probably remove/relax that check in src/core/clasp.ts

Allow script ID as argument for list-deployments & list-versions Add --json option to list-deployments & list-versions Updated commands

wattry · 2025-07-24T14:05:03Z

Also should be able to do this without modifying anything in src/core. There's a method on the clasp instance to set the script ID if it isn't already set:
const clasp = options.clasp;
if (scriptId) { 
  clasp.withScriptId(scriptId);
} 
Right now that withScriptId function will throw an error if the script is already known, so this would fail if the user is calling it in a dir with a valid clasp project, but we can probably remove/relax that check in src/core/clasp.ts

The intention behind that change was to be able to run it with the script id of library dependencies, not limited to the root package. When our users are trying to manage a package that has several libraries they have to navigate to the project and click on each package there.

Do you have any thoughts on that implementation or is it something that is out of scope for the project?

wattry · 2025-07-24T15:10:45Z

This is what I was thinking to relax the check.

  withScriptId(scriptId: string) {
    if (this.options.project) {
      debug('Project is already configured, overriding scriptId with %s', scriptId);
    }

    this.options.project = {
      scriptId,
    };
    return this;
  }

Relax the withScriptId to allow scriptId input inside a configured project Use global --json instead of command level

sqrrrl

Added a few comments, mostly just to simplify this further.

Also please add test cases

package.json

sqrrrl · 2025-07-25T04:18:53Z

src/commands/list-deployments.ts

-        const description = d.deploymentConfig?.description ? `- ${d.deploymentConfig.description}` : '';
-        console.log(`- ${d.deploymentId} ${versionString} ${description}`);
-      });
+    if (options?.json) {


This is unnecessary now. The --json output is already handled above (~ line 44) and it returns, so this code path should never run.

sqrrrl · 2025-07-25T04:19:39Z

src/commands/list-deployments.ts

-    const deployments = await withSpinner(spinnerMsg, async () => {
+    const deployments = await withSpinner(spinnerMsg, () => {
+      // If a scriptId is provided, set it on the clasp instance.
+      if (scriptId) {


Minor nit, suggest moving up to after const clasp...

sqrrrl · 2025-07-25T04:20:18Z

src/commands/list-versions.ts

-      );
-      console.log(msg);
-    });
+    if (options?.json) {


Same as other file, this shouldn't be necessary or ever execute since the JSON flag is checked earlier

sqrrrl · 2025-07-25T04:20:47Z

src/commands/list-versions.ts

-    const versions = await withSpinner(spinnerMsg, async () => {
+    const versions = await withSpinner(spinnerMsg, () => {
+      // If a scriptId is provided, set it on the clasp instance.
+      if (scriptId) {


Minor nit, same as before (move to after the const clasp... line)

sqrrrl · 2025-07-25T04:22:25Z

README.md

@@ -460,9 +461,16 @@ Clasp offers several commands to opens the current directory's `clasp` project a

 List deployments of a script.

+#### Options


I forgot to document this as a global flag in the last change, so good reminder :)

Can you move this up to the global options section please? Same for list versions too

sqrrrl · 2025-07-25T04:22:47Z

README.md

@@ -531,9 +539,16 @@ Creates an immutable version of the script.

 List versions of a script.

+#### Options


Same as other, can/should be consolidated under global options

Add test cases

wattry mentioned this pull request May 29, 2025

Feature Request - Add optional scriptId argument to list-deployments and list-versions and --json option #1060

Open

wattry force-pushed the wattry/issue-1060 branch from 5c46ac9 to 143f6d1 Compare June 11, 2025 16:47

wattry closed this Jul 22, 2025

sqrrrl reopened this Jul 23, 2025

issue-1060

6835657

Allow script ID as argument for list-deployments & list-versions Add --json option to list-deployments & list-versions Updated commands

Remove changes to core

8d8f0d2

Relax the withScriptId to allow scriptId input inside a configured project Use global --json instead of command level

wattry force-pushed the wattry/issue-1060 branch from 143f6d1 to 8d8f0d2 Compare July 24, 2025 15:12

wattry changed the title ~~issue-1060~~ issue-1060 Add scriptId argument to list-deployments and list-versions commands Jul 24, 2025

sqrrrl requested changes Jul 25, 2025

View reviewed changes

Address PR comments

bcc0b3c

Add test cases

wattry requested a review from sqrrrl July 28, 2025 17:40

		@@ -460,9 +461,16 @@ Clasp offers several commands to opens the current directory's `clasp` project a

		List deployments of a script.

		#### Options

		@@ -531,9 +539,16 @@ Creates an immutable version of the script.

		List versions of a script.

		#### Options

issue-1060 Add scriptId argument to list-deployments and list-versions commands #1066

Are you sure you want to change the base?

issue-1060 Add scriptId argument to list-deployments and list-versions commands #1066

Uh oh!

Conversation

wattry commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-cla bot commented May 30, 2025

Uh oh!

sqrrrl commented Jul 23, 2025

Uh oh!

wattry commented Jul 23, 2025

Uh oh!

sqrrrl commented Jul 23, 2025

Uh oh!

wattry commented Jul 24, 2025

Uh oh!

wattry commented Jul 24, 2025

Uh oh!

sqrrrl left a comment

Choose a reason for hiding this comment

Uh oh!

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!

Uh oh!

wattry commented May 30, 2025 •

edited

Loading