Update docs

Author: spoorcc

dfetch/commands/filter.py

@@ -2,6 +2,9 @@
 
 It can either accept no input to list all files. A list of files can be piped in (such as through ``find``)
 or it can be used as a wrapper around a certain tool to block or allow files under control by dfetch.
+
+.. scenario-include:: ../features/filter-projects.feature
+
 """
 
 import argparse

doc/asciicasts/filter.cast

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+source ./demo-magic/demo-magic.sh
+
+PROMPT_TIMEOUT=1
+
+# Copy example manifest
+mkdir filter
+pushd filter
+
+cp -r ../update/* .
+clear
+
+# Run the command
+pe "cat dfetch.yaml"
+pe "dfetch filter"
+pe "find . | dfetch filter"
+pe "find . | dfetch filter echo"
+
+
+PROMPT_TIMEOUT=3
+wait
+
+pei ""
+
+popd
+rm -rf filter

doc/generate-casts/filter-demo.sh

@@ -17,6 +17,7 @@ asciinema rec --overwrite -c "./update-demo.sh" ../asciicasts/update.cast
 asciinema rec --overwrite -c "./report-demo.sh" ../asciicasts/report.cast
 asciinema rec --overwrite -c "./report-sbom-demo.sh" ../asciicasts/sbom.cast
 asciinema rec --overwrite -c "./freeze-demo.sh" ../asciicasts/freeze.cast
+asciinema rec --overwrite -c "./filter-demo.sh" ../asciicasts/filter.cast
 asciinema rec --overwrite -c "./diff-demo.sh" ../asciicasts/diff.cast
 
 rm -rf update

doc/generate-casts/generate-casts.sh

@@ -115,6 +115,19 @@ Freeze
 
 .. automodule:: dfetch.commands.freeze
 
+
+Filter
+------
+.. argparse::
+   :module: dfetch.__main__
+   :func: create_parser
+   :prog: dfetch
+   :path: filter
+
+.. asciinema:: asciicasts/filter.cast
+
+.. automodule:: dfetch.commands.filter
+
 Environment
 -----------
 .. argparse::

doc/manual.rst

@@ -19,7 +19,7 @@ Feature: Filtering file paths before executing a tool
                     url: some-remote-server/SomeProject.git
             """
 
-    Scenario: Tool receives only managed files
+    Scenario: Tool shows all files under dfetch control
         When I run "dfetch filter"
         Then the output shows
             """