From 13541e1620570c183f34b014953f8ab2f090a167 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonathan=20Pich=C3=A9?= Date: Sun, 17 Nov 2024 05:57:22 -0500 Subject: [PATCH] reword the --with help text and deprecate --without (#212) --- README.md | 6 +++--- docs/_index.md | 8 ++++---- src/poetry_plugin_export/command.py | 25 ++++++++++++++++++++++++- 3 files changed, 31 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7f3d1c6..a10cca8 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,9 @@ poetry export -f requirements.txt --output requirements.txt * `--format (-f)`: The format to export to (default: `requirements.txt`). Currently, only `constraints.txt` and `requirements.txt` are supported. * `--output (-o)`: The name of the output file. If omitted, print to standard output. -* `--without`: The dependency groups to ignore when exporting. -* `--with`: The optional dependency groups to include when exporting. -* `--only`: The only dependency groups to include when exporting. +* `--with`: The optional and non-optional dependency groups to include. By default, only the main dependencies are included. +* `--only`: The only dependency groups to include. It is possible to exclude the `main` group this way. +* `--without`: The dependency groups to ignore. (**Deprecated**) * `--default`: Only export the main dependencies. (**Deprecated**) * `--dev`: Include development dependencies. (**Deprecated**) * `--extras (-E)`: Extra sets of dependencies to include. diff --git a/docs/_index.md b/docs/_index.md index 3b766eb..fc9251c 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -67,10 +67,10 @@ poetry export --only test,docs * `--format (-f)`: The format to export to (default: `requirements.txt`). Currently, only `constraints.txt` and `requirements.txt` are supported. * `--output (-o)`: The name of the output file. If omitted, print to standard output. -* `--without`: The dependency groups to ignore when exporting. -* `--with`: The optional dependency groups to include when exporting. -* `--only`: The only dependency groups to include when exporting. -* `--default`: Only export the main dependencies. (**Deprecated**) +* `--with`: The optional and non-optional dependency groups to include. By default, only the main dependencies are included. +* `--only`: The only dependency groups to include. It is possible to exclude the `main` group this way. +* {{< option name="without" deprecated=true >}}The dependency groups to ignore.{{< /option >}} +* {{< option name="default" deprecated=true >}}Only export the main dependencies.{{< /option >}} * {{< option name="dev" deprecated=true >}}Include development dependencies.{{< /option >}} * `--extras (-E)`: Extra sets of dependencies to include. * `--all-extras`: Include all sets of extra dependencies. diff --git a/src/poetry_plugin_export/command.py b/src/poetry_plugin_export/command.py index ec97c5d..feb98bd 100644 --- a/src/poetry_plugin_export/command.py +++ b/src/poetry_plugin_export/command.py @@ -41,8 +41,31 @@ class ExportCommand(GroupCommand): None, "Include development dependencies. (Deprecated)", ), - *GroupCommand._group_dependency_options(), option("all-groups", None, "Include all dependency groups"), + option( + "with", + None, + # note: unlike poetry install, the default excludes non-optional groups + "The optional and non-optional dependency groups to include." + " By default, only the main dependencies are included.", + flag=False, + multiple=True, + ), + option( + "only", + None, + "The only dependency groups to include.", + flag=False, + multiple=True, + ), + option( + "without", + None, + # deprecated: groups are always excluded by default + "The dependency groups to ignore. (Deprecated)", + flag=False, + multiple=True, + ), option( "extras", "E",