fix: document the -r option (#5044)

close #5019

.changeset/perfect-peaches-explain.md

@@ -0,0 +1,6 @@
+---
+"@pnpm/plugin-commands-publishing": patch
+"pnpm": patch
+---
+
+`pnpm publish --help` should print the `--recursive` and `--filter` options [#5019](https://github.com/pnpm/pnpm/issues/5019).

packages/plugin-commands-publishing/package.json

@@ -60,6 +60,7 @@
   "dependencies": {
     "@pnpm/cli-utils": "workspace:*",
     "@pnpm/client": "workspace:*",
+    "@pnpm/common-cli-options-help": "workspace:*",
     "@pnpm/config": "workspace:*",
     "@pnpm/error": "workspace:*",
     "@pnpm/exportable-manifest": "workspace:*",

packages/plugin-commands-publishing/src/publish.ts

@@ -1,6 +1,7 @@
 import { promises as fs, existsSync } from 'fs'
 import path from 'path'
 import { docsUrl, readProjectManifest } from '@pnpm/cli-utils'
+import { FILTERING } from '@pnpm/common-cli-options-help'
 import { Config, types as allTypes } from '@pnpm/config'
 import PnpmError from '@pnpm/error'
 import runLifecycleHooks, { RunLifecycleHookOptions } from '@pnpm/lifecycle'
@@ -88,8 +89,14 @@ export function help () {
             description: 'When publishing packages that require two-factor authentication, this option can specify a one-time password',
             name: '--otp',
           },
+          {
+            description: 'Publish all packages from the workspace',
+            name: '--recursive',
+            shortAlias: '-r',
+          },
         ],
       },
+      FILTERING,
     ],
     url: docsUrl('publish'),
     usages: ['pnpm publish [<tarball>|<dir>] [--tag <tag>] [--access <public|restricted>] [options]'],

packages/plugin-commands-publishing/tsconfig.json

@@ -18,6 +18,9 @@
     {
       "path": "../client"
     },
+    {
+      "path": "../common-cli-options-help"
+    },
     {
       "path": "../config"
     },

packages/pnpm/src/cmd/help.ts

@@ -148,6 +148,17 @@ function getHelpText () {
           },
         ],
       },
+      {
+        title: 'Options',
+
+        list: [
+          {
+            description: 'Run the command for each project in the workspace.',
+            name: '--recursive',
+            shortAlias: '-r',
+          },
+        ],
+      },
     ],
     usages: ['pnpm [command] [flags]', 'pnpm [ -h | --help | -v | --version ]'],
   })