Add a dfetch remove command

Fixes #26

Author: spoorcc

CHANGELOG.rst

@@ -4,6 +4,7 @@ Release 0.14.0 (unreleased)
 * Use github purl, repo and version for a github release archive in SBOM (#1063)
 * Allow ``dfetch freeze`` to accept project names to freeze only specific projects (#1063)
 * Edit manifest in-place when freezing inside a git or SVN superproject, preserving comments and layout (#1063)
+* Add new ``remove`` command to remove projects from manifest and disk (#26)
 
 Release 0.13.0 (released 2026-03-30)
 ====================================

dfetch/__main__.py

@@ -17,6 +17,7 @@
 import dfetch.commands.freeze
 import dfetch.commands.import_
 import dfetch.commands.init
+import dfetch.commands.remove
 import dfetch.commands.report
 import dfetch.commands.update
 import dfetch.commands.update_patch
@@ -52,6 +53,7 @@ def create_parser() -> argparse.ArgumentParser:
     dfetch.commands.freeze.Freeze.create_menu(subparsers)
     dfetch.commands.import_.Import.create_menu(subparsers)
     dfetch.commands.init.Init.create_menu(subparsers)
+    dfetch.commands.remove.Remove.create_menu(subparsers)
     dfetch.commands.report.Report.create_menu(subparsers)
     dfetch.commands.update.Update.create_menu(subparsers)
     dfetch.commands.update_patch.UpdatePatch.create_menu(subparsers)

dfetch/commands/remove.py

@@ -0,0 +1,81 @@
+"""Remove projects from the manifest and delete their directories.
+
+Use ``dfetch remove <project>`` to remove one or more projects.
+See :ref:`remove-a-project` for the full guide.
+
+.. scenario-include:: ../features/remove-project.feature
+
+"""
+
+import argparse
+import shutil
+
+import dfetch.commands.command
+from dfetch.log import get_logger
+from dfetch.manifest.manifest import RequestedProjectNotFoundError
+from dfetch.project import create_super_project
+from dfetch.project.superproject import NoVcsSuperProject
+from dfetch.util.util import in_directory, safe_rm
+
+logger = get_logger(__name__)
+
+
+class Remove(dfetch.commands.command.Command):
+    """Remove a project from the manifest and delete its directory.
+
+    Edits the manifest in-place when the manifest lives inside a git or SVN
+    superproject to preserve comments and layout. When the manifest is not
+    inside version control, a ``.backup`` copy of the manifest is written
+    before updating it.
+    """
+
+    @staticmethod
+    def create_menu(subparsers: dfetch.commands.command.SubparserActionType) -> None:
+        """Add the menu for the remove action."""
+        parser = dfetch.commands.command.Command.parser(subparsers, Remove)
+        parser.add_argument(
+            "projects",
+            metavar="<project>",
+            type=str,
+            nargs="+",
+            help="Specific project(s) to remove",
+        )
+
+    def __call__(self, args: argparse.Namespace) -> None:
+        """Perform the remove action."""
+        superproject = create_super_project()
+        make_backup = isinstance(superproject, NoVcsSuperProject)
+
+        with in_directory(superproject.root_directory):
+            manifest_path = superproject.manifest.path
+
+            # Pre-validate all projects and collect their destinations
+            projects_to_remove = []
+            for project in args.projects:
+                try:
+                    project_entries = superproject.manifest.selected_projects([project])
+                    destination = project_entries[0].destination
+                    projects_to_remove.append((project, destination))
+                except RequestedProjectNotFoundError:
+                    logger.print_info_line(
+                        project, f"project '{project}' not found in manifest"
+                    )
+
+            if not projects_to_remove:
+                return  # Nothing to do
+
+            # Create backup once if any projects will be removed
+            if make_backup:
+                shutil.copyfile(manifest_path, manifest_path + ".backup")
+
+            # Remove all projects from manifest in-memory
+            for project, _ in projects_to_remove:
+                superproject.manifest.remove(project)
+
+            # Persist the manifest changes
+            superproject.manifest.update_dump()
+
+            # Only after successful persistence, perform filesystem deletions and logging
+            for project, destination in projects_to_remove:
+                safe_rm(destination)
+                logger.print_info_line(project, "removed")

dfetch/manifest/manifest.py

@@ -322,6 +322,19 @@ def selected_projects(self, names: Sequence[str]) -> Sequence[ProjectEntry]:
         self._check_all_names_found(names, projects)
         return projects
 
+    def remove(self, project_name: str) -> None:
+        """Remove a project from the manifest."""
+        if project_name not in self._projects:
+            possibles = [project.name for project in self._projects.values()]
+            raise RequestedProjectNotFoundError([project_name], possibles)
+
+        del self._projects[project_name]
+
+        for index, project in enumerate(self._doc["manifest"]["projects"]):
+            if project["name"].data == project_name:
+                del self._doc["manifest"]["projects"][index]
+                break
+
     def _check_all_names_found(
         self, names: Sequence[str], projects: Sequence[ProjectEntry]
     ) -> None:

doc/asciicasts/remove.cast

@@ -0,0 +1,93 @@
+{"version": 2, "width": 141, "height": 38, "timestamp": 1775680966, "env": {"SHELL": "/bin/sh", "TERM": "xterm-256color"}}
+[3.908283, "o", "\u001b[H\u001b[2J\u001b[3J"]
+[3.917146, "o", "$ "]
+[4.920026, "o", "\u001b["]
+[5.100307, "o", "1m"]
+[5.190507, "o", "ca"]
+[5.280647, "o", "t "]
+[5.370807, "o", "df"]
+[5.460964, "o", "et"]
+[5.551105, "o", "ch"]
+[5.641276, "o", ".y"]
+[5.731408, "o", "am"]
+[5.821579, "o", "l\u001b"]
+[6.001802, "o", "[0m"]
+[7.00335, "o", "\r\n"]
+[7.008837, "o", "manifest:\r\n  version: 0.0                                            # DFetch Module syntax version\r\n\r\n  remotes:                                                # declare common sources in one place\r\n  - name: github\r\n    url-base: https://github.com/\r\n\r\n  projects:\r\n  - name: cpputest\r\n    dst: cpputest/src/                                    # Destination of this project (relative to this file)\r\n    repo-path: cpputest/cpputest.git                      # Use default github remote\r\n    tag: v3.4                                             # tag\r\n\r\n  - name: jsmn                                            # without destination, defaults to project name\r\n    repo-path: zserge/jsmn.git                            # only repo-path is enough\r\n"]
+[7.015158, "o", "$ "]
+[8.020859, "o", "\u001b["]
+[8.201143, "o", "1m"]
+[8.293924, "o", "ls"]
+[8.381484, "o", " -"]
+[8.471613, "o", "la"]
+[8.561783, "o", " c"]
+[8.651916, "o", "pp"]
+[8.742054, "o", "ut"]
+[8.832196, "o", "es"]
+[8.923123, "o", "t/"]
+[9.103408, "o", "sr"]
+[9.193552, "o", "c\u001b"]
+[9.283692, "o", "[0"]
+[9.373843, "o", "m"]
+[10.37565, "o", "\r\n"]
+[10.381775, "o", "total 1764\r\ndrwxrwxrwx+ 14 dev dev   4096 Apr  8 20:42 .\r\ndrwxrwxrwx+  3 dev dev   4096 Apr  8 20:42 ..\r\n-rw-rw-rw-   1 dev dev   2179 Apr  8 20:42 .cdtproject\r\n-rw-rw-rw-   1 dev dev   6175 Apr  8 20:42 .cproject\r\n-rw-rw-rw-   1 dev dev    347 Apr  8 20:42 .dfetch_data.yaml\r\n-rw-rw-rw-   1 dev dev    316 Apr  8 20:42 .gitignore\r\n-rw-rw-rw-   1 dev dev   2286 Apr  8 20:42 .project\r\ndrwxrwxrwx+  2 dev dev   4096 Apr  8 20:42 .settings\r\n-rw-rw-rw-   1 dev dev    533 Apr  8 20:42 .travis.yml\r\n-rw-rw-rw-   1 dev dev    201 Apr  8 20:42 AUTHORS\r\n-rw-rw-rw-   1 dev dev   2462 Apr  8 20:42 CMakeLists.txt\r\n-rw-rw-rw-   1 dev dev   1515 Apr  8 20:42 COPYING\r\n-rw-rw-rw-   1 dev dev    103 Apr  8 20:42 ChangeLog\r\n-rw-rw-rw-   1 dev dev   6458 Apr  8 20:42 CppUTest.dsp\r\n-rw-rw-rw-   1 dev dev    825 Apr  8 20:42 CppUTest.dsw\r\n-rw-rw-rw-   1 dev dev   7455 Apr  8 20:42 CppUTest.mak\r\n-rw-rw-rw-   1 dev dev   9597 Apr  8 20:42 CppUTest.vcproj\r\n-rw-rw-rw-   1 dev dev  11381 Apr  8 20:42 CppUTest.vcxproj\r\n-rw-rw-rw-   1 dev dev   1500 Apr  8 20:42 CppUTest_VS2008.sln\r\n-rw-rw-rw-   1 dev dev   1316 Apr  8 20:42 CppUTest_VS2010.sln\r\n-rw-rw-rw-   1 dev dev  53997 Apr  8 20:42 Doxyfile\r\n-rw-rw-rw-   1 dev dev  15578 Apr  8 20:42 INSTALL\r\n-rw-rw-rw-   1 dev dev   9707 Apr  8 20:42 Makefile.am\r\n-rw-rw-rw-   1 dev dev 248957 Apr  8 20:42 Makefile.in\r\n-rw-rw-rw-   1 dev dev    525 Apr  8 20:42 Makefile_CppUTestExt\r\n-rw-rw-rw-   1 dev dev   5177 Apr  8 20:42 Makefile_using_MakefileWorker\r\n-rw-rw-rw-   1 dev dev     68 Apr  8 20:42 NEWS\r\n-rw-rw-rw-   1 dev dev     85 Apr  8 20:42 README\r\n-rw-rw-rw-   1 dev dev   6777 Apr  8 20:42 README.md\r\n-rw-rw-rw-   1 dev dev   2327 Apr  8 20:42 README_CppUTest_for_C.txt\r\n-rw-rw-rw-   1 dev dev   2291 Apr  8 20:42 README_InstallCppUTest.txt\r\n-rw-rw-rw-   1 dev dev    888 Apr  8 20:42 README_UsersOfPriorVersions.txt\r\n-rw-rw-rw-   1 dev dev  39778 Apr  8 20:42 aclocal.m4\r\ndrwxrwxrwx+  2 dev dev   4096 Apr  8 20:42 build\r\ndrwxrwxrwx+  3 dev dev   4096 Apr  8 20:42 cmake\r\n-rwxrwxrwx   1 dev dev   3769 Apr  8 20:42 compile\r\n-rwxrwxrwx   1 dev dev  44504 Apr  8 20:42 config.guess\r\n-rw-rw-rw-   1 dev dev    313 Apr  8 20:42 config.h.cmake\r\n-rw-rw-rw-   1 dev dev   5821 Apr  8 20:42 config.h.in\r\n-rwxrwxrwx   1 dev dev  35206 Apr  8 20:42 config.sub\r\n-rwxrwxrwx   1 dev dev 609242 Apr  8 20:42 configure\r\n-rw-rw-rw-   1 dev dev  16153 Apr  8 20:42 configure.ac\r\n-rw-rw-rw-   1 dev dev  67701 Apr  8 20:42 cpputest-hist.txt\r\n-rw-rw-rw-   1 dev dev    298 Apr  8 20:42 cpputest.pc.in\r\n-rw-rw-rw-   1 dev dev  79904 Apr  8 20:42 cpputest_doxy_gen.conf\r\n-rwxrwxrwx   1 dev dev  18615 Apr  8 20:42 depcomp\r\ndrwxrwxrwx+  2 dev dev   4096 Apr  8 20:42 docs\r\ndrwxrwxrwx+  5 dev dev   4096 Apr  8 20:42 examples\r\ndrwxrwxrwx+  5 dev dev   4096 Apr  8 20:42 include\r\n-rwxrwxrwx   1 dev dev  13663 Apr  8 20:42 install-sh\r\ndrwxrwxrwx+  2 dev dev   4096 Apr  8 20:42 lib\r\n-rwxrwxrwx   1 dev dev 282967 Apr  8 20:42 ltmain.sh\r\ndrwxrwxrwx+  2 dev dev   4096 Apr  8 20:42 m4\r\n-rw-rw-rw-   1 dev dev    344 Apr  8 20:42 makeVS2008.bat\r\n-rw-rw-rw-   1 dev dev    348 Apr  8 20:42 makeVS2010.bat\r\n-rw-rw-rw-   1 dev dev    533 Apr  8 20:42 makeVc6.bat\r\n-rwxrwxrwx   1 dev dev  11419 Apr  8 20:42 missing\r\ndrwxrwxrwx+  2 dev dev   4096 Apr  8 20:42 platforms\r\ndrwxrwxrwx+  7 dev dev   4096 Apr  8 20:42 scripts\r\ndrwxrwxrwx+  5 dev dev   4096 Apr  8 20:42 src\r\n-rwxrwxrwx   1 dev dev   3977 Apr  8 20:42 test-driver\r\ndrwxrwxrwx+  3 dev dev   4096 Apr  8 20:42 tests\r\n"]
+[10.390098, "o", "$ "]
+[11.393098, "o", "\u001b["]
+[11.573599, "o", "1m"]
+[11.663756, "o", "df"]
+[11.753878, "o", "et"]
+[11.844029, "o", "ch"]
+[11.934154, "o", " r"]
+[12.024311, "o", "em"]
+[12.11446, "o", "ov"]
+[12.204584, "o", "e "]
+[12.294755, "o", "cp"]
+[12.475004, "o", "pu"]
+[12.565138, "o", "te"]
+[12.655281, "o", "st"]
+[12.745419, "o", "\u001b["]
+[12.835556, "o", "0m"]
+[13.837403, "o", "\r\n"]
+[14.451432, "o", "\u001b[1;34mDfetch (0.13.0)\u001b[0m\r\n"]
+[14.469446, "o", "  \u001b[1;92mcpputest:\u001b[0m\r\n"]
+[14.470004, "o", "  \u001b[1;34m> removed\u001b[0m\r\n"]
+[14.568244, "o", "$ "]
+[15.571831, "o", "\u001b["]
+[15.752143, "o", "1m"]
+[15.842258, "o", "ca"]
+[15.932442, "o", "t "]
+[16.022561, "o", "df"]
+[16.112731, "o", "et"]
+[16.202855, "o", "ch"]
+[16.293005, "o", ".y"]
+[16.383157, "o", "am"]
+[16.473281, "o", "l\u001b"]
+[16.653586, "o", "[0"]
+[16.74371, "o", "m"]
+[17.745521, "o", "\r\n"]
+[17.748708, "o", "manifest:\r\n  version: '0.0'                                          # DFetch Module syntax version\r\n\r\n  remotes:                                                # declare common sources in one place\r\n  - name: github\r\n    url-base: https://github.com/\r\n\r\n  projects:\r\n  - name: jsmn                                            # without destination, defaults to project name\r\n    repo-path: zserge/jsmn.git                            # only repo-path is enough\r\n"]
+[17.753954, "o", "$ "]
+[18.757376, "o", "\u001b"]
+[18.937652, "o", "[1"]
+[19.027838, "o", "ml"]
+[19.117972, "o", "s "]
+[19.208125, "o", "-l"]
+[19.298262, "o", "a "]
+[19.388399, "o", "cp"]
+[19.478549, "o", "pu"]
+[19.568699, "o", "te"]
+[19.658854, "o", "st"]
+[19.839109, "o", "\u001b"]
+[19.929275, "o", "[0"]
+[20.019419, "o", "m"]
+[21.022025, "o", "\r\n"]
+[21.026546, "o", "total 8\r\n"]
+[21.027105, "o", "drwxrwxrwx+ 2 dev dev 4096 Apr  8 20:43 .\r\ndrwxrwxrwx+ 4 dev dev 4096 Apr  8 20:42 ..\r\n"]
+[24.036633, "o", "$ "]
+[24.03876, "o", "\u001b"]
+[24.219047, "o", "[1"]
+[24.309197, "o", "m\u001b"]
+[24.399338, "o", "[0"]
+[24.489575, "o", "m"]
+[24.490251, "o", "\r\n"]
+[24.49335, "o", "/workspaces/dfetch/doc/generate-casts\r\n"]

doc/generate-casts/generate-casts.sh

@@ -15,6 +15,7 @@ asciinema rec --overwrite -c "./interactive-add-demo.sh" ../asciicasts/interacti
 asciinema rec --overwrite -c "./basic-demo.sh" ../asciicasts/basic.cast
 asciinema rec --overwrite -c "./init-demo.sh" ../asciicasts/init.cast
 asciinema rec --overwrite -c "./add-demo.sh" ../asciicasts/add.cast
+asciinema rec --overwrite -c "./remove-demo.sh" ../asciicasts/remove.cast
 asciinema rec --overwrite -c "./environment-demo.sh" ../asciicasts/environment.cast
 asciinema rec --overwrite -c "./validate-demo.sh" ../asciicasts/validate.cast
 asciinema rec --overwrite -c "./check-demo.sh" ../asciicasts/check.cast

doc/generate-casts/remove-demo.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+source ./demo-magic/demo-magic.sh
+
+PROMPT_TIMEOUT=1
+
+# Copy example manifest and fetch projects
+mkdir remove
+pushd remove
+
+dfetch init
+dfetch update
+clear
+
+# Run the command
+pe "cat dfetch.yaml"
+pe "ls -la cpputest/src"
+pe "dfetch remove cpputest"
+pe "cat dfetch.yaml"
+pe "ls -la cpputest"
+
+PROMPT_TIMEOUT=3
+wait
+
+pei ""
+
+popd
+rm -rf remove

doc/howto/remove-a-project.rst

@@ -0,0 +1,57 @@
+.. _remove-a-project:
+
+Remove a project
+================
+
+``dfetch remove`` deletes a project from your manifest and removes its
+directory from disk. Use it when you no longer need a dependency.
+
+- :ref:`removing-basic` — remove a single project
+- :ref:`removing-multiple` — remove several projects at once
+- :ref:`removing-backup` — manifest backup behavior
+
+.. _removing-basic:
+
+Removing a single project
+-------------------------
+
+Pass the project name to ``dfetch remove``:
+
+.. code-block:: console
+
+    $ dfetch remove mylib
+
+*Dfetch* removes the project entry from ``dfetch.yaml`` and deletes the
+destination folder. The manifest is updated in-place when inside a Git or
+SVN repository, preserving comments and formatting. Outside version control,
+a ``.backup`` copy is created first.
+
+.. scenario-include:: ../features/remove-project.feature
+
+.. _removing-multiple:
+
+Removing multiple projects
+--------------------------
+
+List multiple project names to remove them all at once:
+
+.. code-block:: console
+
+    $ dfetch remove lib1 lib2 lib3
+
+Each project is removed from the manifest and its directory deleted.
+
+.. asciinema:: ../asciicasts/remove.cast
+
+.. _removing-backup:
+
+Manifest backup behavior
+------------------------
+
+When your manifest lives inside a Git or SVN repository, ``dfetch remove``
+edits it in-place to preserve comments, blank lines, and indentation. When
+outside version control (no ``.git`` or ``.svn`` directory), a backup copy
+is created as ``dfetch.yaml.backup`` before any changes.
+
+This matches the behavior of ``dfetch freeze`` and other manifest-modifying
+commands.

doc/index.rst

@@ -51,6 +51,7 @@ upstream. See :ref:`vendoring` for background on the problem this solves.
    howto/migration
    howto/adding-a-project
    howto/updating-projects
+   howto/remove-a-project
    howto/patching
    howto/check-ci
    howto/sbom

doc/reference/commands.rst

@@ -54,6 +54,20 @@ Add
 
 .. seealso:: :doc:`../howto/adding-a-project` — walks through adding a new dependency from start to finish.
 
+Remove
+------
+.. argparse::
+   :module: dfetch.__main__
+   :func: create_parser
+   :prog: dfetch
+   :path: remove
+
+.. asciinema:: ../asciicasts/remove.cast
+
+.. automodule:: dfetch.commands.remove
+
+.. seealso:: :doc:`../howto/remove-a-project` — how to remove projects from your manifest.
+
 Check
 -----
 .. argparse::