[Feature] Improve `yarn npm publish` to match other package managers

[Saadnajmi]

• I'd be willing to implement this feature (contributing guide)
• This feature is important to have in this repository; a contrib plugin wouldn't do

Describe the user story

A clear and concise description of what workflow is meant to be improved.
Example: "As a developer, I often want to do , but I often face ".

See nrwl/nx#29242 (comment)

I want to use nx release, with Yarn berry, with the workspace:* protocol in my repo. Currently, I cannot do that, because yarn npm publish command does not:

• Run --dry-run
• Request JSON output with --json
• Specify a working directory via a positional argument, you have to already be in the directory
• Set the --registry on the request, it has to come from yarn config it seems?

where other package managers like pnpm and bun do.

Describe the solution you'd like

Improve the publish implementation to support these features.

Describe the drawbacks of your solution

No drawbacks, only new features?

Describe alternatives you've considered

Why not make it a plugin --> Maybe. I wanted to start by seeing if a PR to the repo could do.

[arcanis]

Run --dry-run

The --dry-run flag is on yarn pack; what would yarn npm publish add to it?

Specify a working directory via a positional argument, you have to already be in the directory

We already have --cwd and the implicit first-arg cwd (ie yarn ./packages/foo add lodash). Can you detail what you have in mind?

Set the --registry on the request, it has to come from yarn config it seems?

Yes, because the place where a package is meant to be published isn't really supposed to ever change, so it should be in the configuration rather than a one-time parameter that users could accidentally forget.

[JamesHenry]

@arcanis I work on Nx and provided the original feedback about how yarn npm publish lacks a lot of the configurability of the other package manager CLIs. This makes it much harder for us to provide a consistent user experience.

• JSON output would be great for being able to work with the output and format it consistently on our side, npm and pnpm both support this (and bun's output is more comprehensive, including information about what was published and where, so we can match the non-json case with them).

• Having a registry override is super useful for things like local publishing for testing, where your config is configured for normal releases, but you deploy to e.g. verdaccio for local e2e tests. npm, pnpm and bun all support this.

• Regarding working directory, are you saying yarn ./packages/foo npm publish should already work?

Thanks a lot for considering these things, I'd love to be able to include proper yarn npm publish support in nx release and thanks @Saadnajmi for driving the initiative

[arcanis]

JSON output would be great

Nothing against that! Various commands have --json flags, it'd make sense for yarn npm publish to have one as well. It's mostly a matter of figuring out what we want to print (I think it'd make sense to display the content of the publish tarball and the registry).

Having a registry override is super useful for things like local publishing for testing, where your config is configured for normal releases, but you deploy to e.g. verdaccio for local e2e tests. npm, pnpm and bun all support this.

We do support it, you can set YARN_NPM_PUBLISH_REGISTRY as an env variable. That's what we do in our own release setup for example.

It's just not a CLI option because it isn't a good practice for users - in the majority of cases they should configure their publish registry in their settings. If they need something more complex, whatever tool they use can afford using a lower-level environment variable (like nx, or the wrapper script I linked).

Regarding working directory, are you saying yarn ./packages/foo npm publish should already work?

If packages/foo is a proper package, yes. We don't support publishing "arbitrary" non-workspace folders at the moment (which might be the case of Nx? I'm not too sure about that); see #705.

[JamesHenry]

Thanks!

I realized I missed off the all important dry-run.

The --dry-run flag is on yarn pack; what would yarn npm publish add to it?

I don't quite understand this pushback, we (nor direct users of the CLI) are running yarn pack so it's reasonable for the yarn npm publish command to have a dry-run flag that sets dry-run on the pack and provides the rest of the output that would apply short of running the publish right? Again npm, pnpm and bun all support --dry-run, so it would be very helpful if yarn did too.

Here's a real example of what we can show the user with the data that pnpm publish --dry-run --json --registry http://localhost:4873/ gives us behind the scenes:

> nx run devkit:nx-release-publish


📦  @nx/devkit@X.X.X-dry-run
=== Tarball Contents ===

1.1kB  LICENSE                                                          
2.3kB  README.md                                                        
545B   index.d.ts                                                       
777B   index.js                                                         
71B    migrations.json                                                  
152B   ngcli-adapter.d.ts                                               
787B   ngcli-adapter.js                                                 
1.3kB  package.json                                                     
2.5kB  public-api.d.ts                                                  
6.3kB  public-api.js                                                    
1.7kB  src/executors/parse-target-string.d.ts                           
1.9kB  src/executors/parse-target-string.js                             
347B   src/executors/read-target-options.d.ts                           
1.5kB  src/executors/read-target-options.js                             
1.6kB  src/generators/artifact-name-and-directory-utils.d.ts            
5.6kB  src/generators/artifact-name-and-directory-utils.js              
854B   src/generators/e2e-web-server-info-utils.d.ts                    
3.2kB  src/generators/e2e-web-server-info-utils.js                      
871B   src/generators/executor-options-utils.d.ts                       
1.8kB  src/generators/executor-options-utils.js                         
324B   src/generators/format-files.d.ts                                 
3.7kB  src/generators/format-files.js                                   
1.8kB  src/generators/generate-files.d.ts                               
4.7kB  src/generators/generate-files.js                                 
661B   src/generators/plugin-migrations/aggregate-log-util.d.ts         
1.9kB  src/generators/plugin-migrations/aggregate-log-util.js           
2.0kB  src/generators/plugin-migrations/executor-to-plugin-migrator.d.ts
23.2kB src/generators/plugin-migrations/executor-to-plugin-migrator.js  
2.6kB  src/generators/plugin-migrations/plugin-migration-utils.d.ts     
6.7kB  src/generators/plugin-migrations/plugin-migration-utils.js       
1.5kB  src/generators/project-name-and-root-utils.d.ts                  
5.7kB  src/generators/project-name-and-root-utils.js                    
155B   src/generators/prompt.d.ts                                       
558B   src/generators/prompt.js                                         
234B   src/generators/run-tasks-in-serial.d.ts                          
344B   src/generators/run-tasks-in-serial.js                            
309B   src/generators/target-defaults-utils.d.ts                        
2.9kB  src/generators/target-defaults-utils.js                          
413B   src/generators/to-js.d.ts                                        
1.2kB  src/generators/to-js.js                                          
46B    src/generators/typescript/insert-import.d.ts                     
142B   src/generators/typescript/insert-import.js                       
46B    src/generators/typescript/insert-statement.d.ts                  
142B   src/generators/typescript/insert-statement.js                    
148B   src/generators/update-ts-configs-to-js.d.ts                      
1.5kB  src/generators/update-ts-configs-to-js.js                        
243B   src/generators/visit-not-ignored-files.d.ts                      
1.3kB  src/generators/visit-not-ignored-files.js                        
491B   src/tasks/install-packages-task.d.ts                             
2.1kB  src/tasks/install-packages-task.js                               
1.1kB  src/utils/add-plugin.d.ts                                        
12.8kB src/utils/add-plugin.js                                          
141B   src/utils/async-iterable/combine-async-iterables.d.ts            
2.0kB  src/utils/async-iterable/combine-async-iterables.js              
317B   src/utils/async-iterable/create-async-iterable.d.ts              
2.3kB  src/utils/async-iterable/create-async-iterable.js                
164B   src/utils/async-iterable/index.d.ts                              
379B   src/utils/async-iterable/index.js                                
261B   src/utils/async-iterable/map-async-iteratable.d.ts               
590B   src/utils/async-iterable/map-async-iteratable.js                 
189B   src/utils/async-iterable/tap-async-iteratable.d.ts               
354B   src/utils/async-iterable/tap-async-iteratable.js                 
61B    src/utils/binary-extensions.d.ts                                 
3.8kB  src/utils/binary-extensions.js                                   
467B   src/utils/calculate-hash-for-create-nodes.d.ts                   
1.5kB  src/utils/calculate-hash-for-create-nodes.js                     
353B   src/utils/config-utils.d.ts                                      
4.5kB  src/utils/config-utils.js                                        
242B   src/utils/convert-nx-executor.d.ts                               
3.8kB  src/utils/convert-nx-executor.js                                 
214B   src/utils/find-plugin-for-config-file.d.ts                       
1.3kB  src/utils/find-plugin-for-config-file.js                         
393B   src/utils/get-named-inputs.d.ts                                  
919B   src/utils/get-named-inputs.js                                    
576B   src/utils/get-workspace-layout.d.ts                              
1.7kB  src/utils/get-workspace-layout.js                                
386B   src/utils/invoke-nx-generator.d.ts                               
5.8kB  src/utils/invoke-nx-generator.js                                 
74B    src/utils/log-show-project-command.d.ts                          
455B   src/utils/log-show-project-command.js                            
189B   src/utils/move-dir.d.ts                                          
995B   src/utils/move-dir.js                                            
569B   src/utils/names.d.ts                                             
1.7kB  src/utils/names.js                                               
335B   src/utils/offset-from-root.d.ts                                  
748B   src/utils/offset-from-root.js                                    
3.6kB  src/utils/package-json.d.ts                                      
16.2kB src/utils/package-json.js                                        
169B   src/utils/replace-package.d.ts                                   
5.2kB  src/utils/replace-package.js                                     
265B   src/utils/replace-project-configuration-with-plugin.d.ts         
6.5kB  src/utils/replace-project-configuration-with-plugin.js           
3.0kB  src/utils/rxjs-for-await.d.ts                                    
9.4kB  src/utils/rxjs-for-await.js                                      
91B    src/utils/semver.d.ts                                            
637B   src/utils/semver.js                                              
1.4kB  src/utils/string-change.d.ts                                     
3.3kB  src/utils/string-change.js                                       
3.1kB  src/utils/string-utils.d.ts                                      
4.4kB  src/utils/string-utils.js                                        
51B    src/utils/versions.d.ts                                          
151B   src/utils/versions.js                                            
47B    testing.d.ts                                                     
253B   testing.js                                                       
=== Tarball Details ===
name:          @nx/devkit                              
version:       X.X.X-dry-run                           
filename:      nx-devkit-X.X.X-dry-run.tgz             
package size:  50.8 kB                                 
unpacked size: 211.6 kB                                
shasum:        84975019abd5f3a6436968b4fbbb9207b13dcc40
integrity:     sha512-twWNJhNR7NSnk[...]ZRKXO4Gt4rArg==
total files:   104                                     
 
Would publish to http://localhost:4873/ with tag "latest", but [dry-run] was set

[JamesHenry]

The raw JSON that was produced for this case (post-parsing and just dumped to my terminal for a quick illustration)

{
  id: '@nx/devkit@0.0.1',
  name: '@nx/devkit',
  version: '0.0.1',
  size: 50844,
  unpackedSize: 211610,
  shasum: '84975019abd5f3a6436968b4fbbb9207b13dcc40',
  integrity: 'sha512-twWNJhNR7NSnk8lPzmS7CRum6vxTV+5jVRRxkushLsxb6B8Zq6fRRoSXSZERcJfwD+kiEGc+8ZRKXO4Gt4rArg==',
  filename: 'nx-devkit-0.0.1.tgz',
  files: [
    { path: 'LICENSE', size: 1093, mode: 420 },
    { path: 'README.md', size: 2311, mode: 420 },
    { path: 'index.d.ts', size: 545, mode: 420 },
    { path: 'index.js', size: 777, mode: 420 },
    { path: 'migrations.json', size: 71, mode: 420 },
    { path: 'ngcli-adapter.d.ts', size: 152, mode: 420 },
    { path: 'ngcli-adapter.js', size: 787, mode: 420 },
    { path: 'package.json', size: 1322, mode: 420 },
    { path: 'public-api.d.ts', size: 2485, mode: 420 },
    { path: 'public-api.js', size: 6348, mode: 420 },
    {
      path: 'src/executors/parse-target-string.d.ts',
      size: 1667,
      mode: 420
    },
    {
      path: 'src/executors/parse-target-string.js',
      size: 1927,
      mode: 420
    },
    {
      path: 'src/executors/read-target-options.d.ts',
      size: 347,
      mode: 420
    },
    {
      path: 'src/executors/read-target-options.js',
      size: 1511,
      mode: 420
    },
    {
      path: 'src/generators/artifact-name-and-directory-utils.d.ts',
      size: 1645,
      mode: 420
    },
    {
      path: 'src/generators/artifact-name-and-directory-utils.js',
      size: 5557,
      mode: 420
    },
    {
      path: 'src/generators/e2e-web-server-info-utils.d.ts',
      size: 854,
      mode: 420
    },
    {
      path: 'src/generators/e2e-web-server-info-utils.js',
      size: 3224,
      mode: 420
    },
    {
      path: 'src/generators/executor-options-utils.d.ts',
      size: 871,
      mode: 420
    },
    {
      path: 'src/generators/executor-options-utils.js',
      size: 1775,
      mode: 420
    },
    { path: 'src/generators/format-files.d.ts', size: 324, mode: 420 },
    { path: 'src/generators/format-files.js', size: 3662, mode: 420 },
    {
      path: 'src/generators/generate-files.d.ts',
      size: 1813,
      mode: 420
    },
    { path: 'src/generators/generate-files.js', size: 4722, mode: 420 },
    {
      path: 'src/generators/plugin-migrations/aggregate-log-util.d.ts',
      size: 661,
      mode: 420
    },
    {
      path: 'src/generators/plugin-migrations/aggregate-log-util.js',
      size: 1850,
      mode: 420
    },
    {
      path: 'src/generators/plugin-migrations/executor-to-plugin-migrator.d.ts',
      size: 1987,
      mode: 420
    },
    {
      path: 'src/generators/plugin-migrations/executor-to-plugin-migrator.js',
      size: 23161,
      mode: 420
    },
    {
      path: 'src/generators/plugin-migrations/plugin-migration-utils.d.ts',
      size: 2609,
      mode: 420
    },
    {
      path: 'src/generators/plugin-migrations/plugin-migration-utils.js',
      size: 6697,
      mode: 420
    },
    {
      path: 'src/generators/project-name-and-root-utils.d.ts',
      size: 1488,
      mode: 420
    },
    {
      path: 'src/generators/project-name-and-root-utils.js',
      size: 5674,
      mode: 420
    },
    { path: 'src/generators/prompt.d.ts', size: 155, mode: 420 },
    { path: 'src/generators/prompt.js', size: 558, mode: 420 },
    {
      path: 'src/generators/run-tasks-in-serial.d.ts',
      size: 234,
      mode: 420
    },
    {
      path: 'src/generators/run-tasks-in-serial.js',
      size: 344,
      mode: 420
    },
    {
      path: 'src/generators/target-defaults-utils.d.ts',
      size: 309,
      mode: 420
    },
    {
      path: 'src/generators/target-defaults-utils.js',
      size: 2866,
      mode: 420
    },
    { path: 'src/generators/to-js.d.ts', size: 413, mode: 420 },
    { path: 'src/generators/to-js.js', size: 1238, mode: 420 },
    {
      path: 'src/generators/typescript/insert-import.d.ts',
      size: 46,
      mode: 420
    },
    {
      path: 'src/generators/typescript/insert-import.js',
      size: 142,
      mode: 420
    },
    {
      path: 'src/generators/typescript/insert-statement.d.ts',
      size: 46,
      mode: 420
    },
    {
      path: 'src/generators/typescript/insert-statement.js',
      size: 142,
      mode: 420
    },
    {
      path: 'src/generators/update-ts-configs-to-js.d.ts',
      size: 148,
      mode: 420
    },
    {
      path: 'src/generators/update-ts-configs-to-js.js',
      size: 1479,
      mode: 420
    },
    {
      path: 'src/generators/visit-not-ignored-files.d.ts',
      size: 243,
      mode: 420
    },
    {
      path: 'src/generators/visit-not-ignored-files.js',
      size: 1330,
      mode: 420
    },
    {
      path: 'src/tasks/install-packages-task.d.ts',
      size: 491,
      mode: 420
    },
    {
      path: 'src/tasks/install-packages-task.js',
      size: 2074,
      mode: 420
    },
    { path: 'src/utils/add-plugin.d.ts', size: 1057, mode: 420 },
    { path: 'src/utils/add-plugin.js', size: 12840, mode: 420 },
    {
      path: 'src/utils/async-iterable/combine-async-iterables.d.ts',
      size: 141,
      mode: 420
    },
    {
      path: 'src/utils/async-iterable/combine-async-iterables.js',
      size: 2006,
      mode: 420
    },
    {
      path: 'src/utils/async-iterable/create-async-iterable.d.ts',
      size: 317,
      mode: 420
    },
    {
      path: 'src/utils/async-iterable/create-async-iterable.js',
      size: 2266,
      mode: 420
    },
    {
      path: 'src/utils/async-iterable/index.d.ts',
      size: 164,
      mode: 420
    },
    { path: 'src/utils/async-iterable/index.js', size: 379, mode: 420 },
    {
      path: 'src/utils/async-iterable/map-async-iteratable.d.ts',
      size: 261,
      mode: 420
    },
    {
      path: 'src/utils/async-iterable/map-async-iteratable.js',
      size: 590,
      mode: 420
    },
    {
      path: 'src/utils/async-iterable/tap-async-iteratable.d.ts',
      size: 189,
      mode: 420
    },
    {
      path: 'src/utils/async-iterable/tap-async-iteratable.js',
      size: 354,
      mode: 420
    },
    { path: 'src/utils/binary-extensions.d.ts', size: 61, mode: 420 },
    { path: 'src/utils/binary-extensions.js', size: 3765, mode: 420 },
    {
      path: 'src/utils/calculate-hash-for-create-nodes.d.ts',
      size: 467,
      mode: 420
    },
    {
      path: 'src/utils/calculate-hash-for-create-nodes.js',
      size: 1465,
      mode: 420
    },
    { path: 'src/utils/config-utils.d.ts', size: 353, mode: 420 },
    { path: 'src/utils/config-utils.js', size: 4525, mode: 420 },
    {
      path: 'src/utils/convert-nx-executor.d.ts',
      size: 242,
      mode: 420
    },
    { path: 'src/utils/convert-nx-executor.js', size: 3752, mode: 420 },
    {
      path: 'src/utils/find-plugin-for-config-file.d.ts',
      size: 214,
      mode: 420
    },
    {
      path: 'src/utils/find-plugin-for-config-file.js',
      size: 1295,
      mode: 420
    },
    { path: 'src/utils/get-named-inputs.d.ts', size: 393, mode: 420 },
    { path: 'src/utils/get-named-inputs.js', size: 919, mode: 420 },
    {
      path: 'src/utils/get-workspace-layout.d.ts',
      size: 576,
      mode: 420
    },
    {
      path: 'src/utils/get-workspace-layout.js',
      size: 1665,
      mode: 420
    },
    {
      path: 'src/utils/invoke-nx-generator.d.ts',
      size: 386,
      mode: 420
    },
    { path: 'src/utils/invoke-nx-generator.js', size: 5840, mode: 420 },
    {
      path: 'src/utils/log-show-project-command.d.ts',
      size: 74,
      mode: 420
    },
    {
      path: 'src/utils/log-show-project-command.js',
      size: 455,
      mode: 420
    },
    { path: 'src/utils/move-dir.d.ts', size: 189, mode: 420 },
    { path: 'src/utils/move-dir.js', size: 995, mode: 420 },
    { path: 'src/utils/names.d.ts', size: 569, mode: 420 },
    { path: 'src/utils/names.js', size: 1694, mode: 420 },
    { path: 'src/utils/offset-from-root.d.ts', size: 335, mode: 420 },
    { path: 'src/utils/offset-from-root.js', size: 748, mode: 420 },
    { path: 'src/utils/package-json.d.ts', size: 3557, mode: 420 },
    { path: 'src/utils/package-json.js', size: 16238, mode: 420 },
    { path: 'src/utils/replace-package.d.ts', size: 169, mode: 420 },
    { path: 'src/utils/replace-package.js', size: 5244, mode: 420 },
    {
      path: 'src/utils/replace-project-configuration-with-plugin.d.ts',
      size: 265,
      mode: 420
    },
    {
      path: 'src/utils/replace-project-configuration-with-plugin.js',
      size: 6534,
      mode: 420
    },
    { path: 'src/utils/rxjs-for-await.d.ts', size: 3026, mode: 420 },
    { path: 'src/utils/rxjs-for-await.js', size: 9397, mode: 420 },
    { path: 'src/utils/semver.d.ts', size: 91, mode: 420 },
    { path: 'src/utils/semver.js', size: 637, mode: 420 },
    { path: 'src/utils/string-change.d.ts', size: 1444, mode: 420 },
    { path: 'src/utils/string-change.js', size: 3311, mode: 420 },
    { path: 'src/utils/string-utils.d.ts', size: 3094, mode: 420 },
    { path: 'src/utils/string-utils.js', size: 4385, mode: 420 },
    ... 4 more items
  ],
  entryCount: 104,
  bundled: []
}

npm is identical to this, pnpm matched them

[JamesHenry]

#705 is likely a limitation, yes, but we can hopefully account for that for now and only limit yarn usage in that case, instead of completely like now. Nx release supports various setups when it comes to publishing a source package directly or building to a dist location and then publishing from there. So it's dependent on the user config and we can account for it hopefully

[Saadnajmi]

@JamesHenry thanks for providing the raw json. In my testing yesterday I realized I didn't actually know what was the output that matched other package managers.
Yarn has a StreamReport class that handles printing to stdout that is already used and takes a json flag. I'll take a look to my PR and see if that's close to what we want.

[arcanis]

Again npm, pnpm and bun all support --dry-run, so it would be very helpful if yarn did too.

Just a nit because I saw it mentioned a couple of times already, "other package managers are doing it" isn't a proper argument. It's cool that they do, but I want to understand why it makes sense for Yarn before taking decisions. Let's focus on why that's worth it, it's more interesting anyway 🙂

we (nor direct users of the CLI) are[n't] running yarn pack so it's reasonable for the yarn npm publish command to have a dry-run flag that sets dry-run on the pack and provides the rest of the output that would apply short of running the publish right?

My point is that maybe you should use yarn pack rather than yarn npm publish if you don't intend to actually publish the tarball. Maybe that's the dry mode you're looking for, except it's a command rather than a CLI option.

From what you shared the only difference in output between yarn pack --dry-run and an hypothetical yarn npm publish --dry-run is the final line:

Would publish to http://localhost:4873/ with tag "latest", but [dry-run] was set

To be honest I can see that being useful, so I'm not against merging something like that, but it's not like you have absolutely no way to implement what you're looking for.

npm is identical to this, pnpm matched them

Our JSON output isn't bound by other package managers' output. Most of what we print is an NDJSON stream, this would necessarily follow the same format; for example yarn pack --dry-run --json already returns this:

{"base":"/Users/mael.nison/berry/packages/yarnpkg-cli"}
{"location":"lib/boot-cli-dev.js"}
{"location":"lib/index.d.ts"}
{"location":"lib/index.js"}
{"location":"lib/lib.d.ts"}
{"location":"lib/lib.js"}
{"location":"lib/pluginCommands.d.ts"}
{"location":"lib/pluginCommands.js"}
{"location":"lib/polyfills.d.ts"}
{"location":"lib/polyfills.js"}
{"location":"lib/tools/BaseCommand.d.ts"}
{"location":"lib/tools/BaseCommand.js"}
{"location":"lib/tools/WorkspaceRequiredError.d.ts"}
{"location":"lib/tools/WorkspaceRequiredError.js"}
{"location":"lib/tools/getDynamicLibs.d.ts"}
{"location":"lib/tools/getDynamicLibs.js"}
{"location":"lib/tools/getPluginConfiguration.d.ts"}
{"location":"lib/tools/getPluginConfiguration.js"}
{"location":"lib/tools/getPluginConfiguration.val.js"}
{"location":"lib/tools/openWorkspace.d.ts"}
{"location":"lib/tools/openWorkspace.js"}
{"location":"package.json"}

We're open to extend it with additional information, when they make sense.

[Saadnajmi]

Hi, I updated my PR to remove the --registry and --directory flags, since there are alternatives for them. What is left is the --dry-run and --json flags. Using both with a test package ATM looks like this:

sanajmi@Saads-MacBook-Pro-14 berry % yarn ./packages/foo npm publish --dry-run
➤ YN0000: another-one.js
➤ YN0000: bar.js
➤ YN0000: foo.js
➤ YN0000: index.js
➤ YN0000: package.json
➤ YN0000: [DRY RUN] Package would be published to https://registry.yarnpkg.com with tag latest
➤ YN0000: Done in 0s 56ms

sanajmi@Saads-MacBook-Pro-14 berry % yarn ./packages/foo npm publish --json --dry-run
{"type":"files","files":["another-one.js","bar.js","foo.js","index.js","package.json"]}
{"name":"foo","version":"1.0.0","registry":"https://registry.yarnpkg.com","dryRun":true,"published":false,"message":"[DRY RUN] Package would be published to https://registry.yarnpkg.com with tag latest"}
sanajmi@Saads-MacBook-Pro-14 berry % 

[Saadnajmi]

Open question I still have. Should we print out one JSON object in total ( as @JamesHenry has in #6849 (comment)) , or a stream of JSON objects (as @arcanis has in #6849 (comment)). To do the former, I need to rework my test case. To do the latter, I need to rework the publish implementation so that we only ever have one reportJson call, which I think is a bigger delta.

Going with NDJSON stream for now. The final object has a combo of all the info, so it's easy to parse.

[ItsHarper]

The PR that implemented this didn't properly link this issue, but it has been merged.