feat(cli): add -outdated modifier in list command by AshokThangavel · Pull Request #1095 · intersystems/ipm

AshokThangavel · 2026-03-10T18:00:06Z

Description:

Introduced the -outdated modifier (alias -o) to the list command to allow users to quickly identify installed modules with newer versions available in the registry.

#586

Key Changes:

New Modifier: Added -outdated and the short-form alias -o to the list-installed command logic.

zpm:USER>list -o
irisjwt 1.0.0  1.0.1

CLI Documentation Update:

Component	Text
Modifier	`-outdated, -o`
Description	Lists installed modules that have available updates in the registry.
Example	`list -outdated`

Testing Performed:

Executed list -o and verified that only modules with pending updates are displayed.
Confirmed that the output adheres to the existing project format (Module : OldVersion NewVersion).

- Implement '-outdated' (alias '-o') to filter for modules with updates. - Update CLI help text with descriptions and usage examples.

isc-dchui · 2026-03-16T13:53:57Z

src/cls/IPM/Main.cls

    }
 }

+ClassMethod GetOutdatedModulesList(Output List)


Does this also check if the new versions satisfy the existing version constraints? If not, it should.

For example, if we have module-a that depends on module-b ^1.3.0, and the available versions of module-b are 1.3.0 and 2.0.0, then list -outdated should not include module-b since 2.0.0 cannot be installed anyway.

Hi @isc-dchui
Thank you for pointing out this excellent case. Currently, the check only determines whether a newer version exists and does not verify whether that version satisfies the existing version constraints.

So, in this scenario, module-b is not a directly installed module; it is installed as a dependency of module-a. Because of that, it likely should not appear in the list -outdated output.
Thank you!

Ok! Let's add a test to make sure this works! (Also you have some failing tests)

sure. Thank you!

Hi @isc-dchui Thanks for pointing that out. Since the irisjwt module cannot be resolved from the external registry in CI, Could you suggest the best way to utilize local custom modules as test assets to bypass the registry requirement?
Thank you!

Hi @isc-dchui
I’ve implemented the -outdated flag to skip modules installed only as dependencies. Thank you!

The simplest would probably be adding the test modules to the Integration/_data directory and setting up a filesystem repo to point to it like so:

repo -fs -name local -path /home/irisowner/zpm/tests/integration_tests/Test/PM/Integration/_data/<dtest_directory>

Thank you for the suggestion. Setting up a filesystem repository is a new configuration for me. Could you please point me toward the official documentation or a guide for this? That would be very helpful for my setup.

There isn't much, but here's an example in the wiki:
https://github.com/intersystems/ipm/wiki/02.-CLI-commands#repo

CHANGELOG.md

isc-dchui

Two little nits and a suggestion for the testing

isc-dchui · 2026-03-17T15:11:51Z

src/cls/IPM/Main.cls

 {
-    do ..GetListModules($namespace,,.installedModules)
+    // Get the dependencies list to prevent displaying an outdated list
+    set List=""


Nit: make "List" lowercase

changed to lowercase.

isc-dchui · 2026-03-17T15:15:20Z

src/cls/IPM/Main.cls

 <modifier name="repository" aliases="repo" value="true" description="If specified, only show modules installed that belong to the provided repository." />
 <modifier name="python" aliases="py" description="If specified, lists installed Embedded Python libraries instead of IPM modules." />
-<modifier name="outdated" aliases="o" description="Lists installed modules that have available updates in the registry." />
+<modifier name="outdated" aliases="o" description="If specified, only lists installed modules that have available updates in the registry. Modules installed only as dependencies are skipped." />


Nit: I would reword this by removing the "only" from the second sentence, i.e. " Modules installed as dependencies are skipped"

Updated the description. Thank you!

isc-kiyer

@AshokThangavel Looks good! Few small comments

isc-kiyer · 2026-04-02T20:59:02Z

src/cls/IPM/Main.cls

+        set moduleName = $listget(moduleInfo)
+
+        // Skip processing if the module is a dependency module
+        if moduleName="zpm"||($data(visitedMap(moduleName))) {


Skipping of dependencies should be an optional flag. The default should be to list all outdated modules in the namespace.

isc-kiyer · 2026-04-02T21:00:28Z

src/cls/IPM/Main.cls

+            set reg = $order(serverModuleVersions(moduleName,""),1,versionString)
+            if currentVersion'=versionString {
+                set currentwidth = $length(moduleName)
+                set list($increment(list)) = $listbuild(moduleName,$$$FormattedLine($$$Red, currentVersion)_"  "_$$$FormattedLine($$$Green,versionString))


Similar to npm outdated, it would be great to show both the highest version available on the current major version and the highest version available overall.

isc-kiyer · 2026-04-02T21:01:36Z

src/cls/IPM/Main.cls

 	}
+    if $data(pCommandInfo("modifiers","outdated")) {
+        merge tModifiers = pCommandInfo("modifiers")
+        do ..GetOutdatedModulesList(.list)


It would be nice for the list to have column headers to display

isc-kiyer · 2026-04-02T21:02:51Z

tests/unit_tests/Test/PM/Unit/CLI.cls

+/// Validates that the '-outdated' modifier correctly identifies and displays modules with newer registry versions
+Method TestListOutdatedModules()
+{
+    set moduleName = "irisjwt"


Should probably add a test with more than one module and one with dependencies.

feat(cli): add -outdated modifier to list command

2029db0

- Implement '-outdated' (alias '-o') to filter for modules with updates. - Update CLI help text with descriptions and usage examples.

AshokThangavel requested review from isc-cborbonm, isc-dchui, isc-egabhart, isc-eneil, isc-jili, isc-jlechtne, isc-kiyer, isc-pbarton and isc-tleavitt as code owners March 10, 2026 18:00

docs: Changelog entry added

42d3684

isc-dchui requested changes Mar 16, 2026

View reviewed changes

AshokThangavel added 2 commits March 17, 2026 20:32

refactor(list): filter outdated modules to exclude dependencies

265414b

docs: updated the changelog

c71fcf3

isc-dchui reviewed Mar 17, 2026

View reviewed changes

Merge branch 'main' into feat/list-outdated-flag and code update

269c97b

isc-kiyer requested changes Apr 2, 2026

View reviewed changes

Conversation

AshokThangavel commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Key Changes:

CLI Documentation Update:

Testing Performed:

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!

isc-dchui 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!

isc-kiyer 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AshokThangavel commented Mar 10, 2026 •

edited

Loading