whatnext 0.2__tar.gz → 0.3__tar.gz

{whatnext-0.2 → whatnext-0.3}/.github/workflows/publish.yml

@@ -71,7 +71,7 @@ jobs:
           changelog=$(awk -v ver="$version" '
             /^## \[/ {
               if (found) exit
-              if ($0 ~ "\\[" ver "\\]") found=1
+              if ($0 ~ "\\[v" ver "\\]") found=1
               next
             }
             found { print }

{whatnext-0.2 → whatnext-0.3}/CHANGELOG.md

@@ -10,6 +10,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Nothing, yet.
 
 
+## [v0.3] — 2025-11-29
+
+Adding more states to the roster, tasks can be marked as open (unstarted),
+in progress, cancelled, blocked, and completed.
+
+Tasks can be filtered by any of these states when showing tasks or summaries.
+
+
 ## [v0.2] — 2025-11-28
 
 Filtering tasks by text/header can be helpful. And as useful as it

{whatnext-0.2 → whatnext-0.3}/Makefile

@@ -1,3 +1,9 @@
+ifndef CI
+ifndef VIRTUAL_ENV
+$(error Development has to happen inside venv, whatnext is also installed globally.)
+endif
+endif
+
 .PHONY: test flake8 bats pytest
 
 test: flake8 bats pytest

{whatnext-0.2 → whatnext-0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: whatnext
-Version: 0.2
+Version: 0.3
 Summary: A lister of tasks found in Markdown files
 Project-URL: Homepage, https://github.com/norm/whatnext
 Project-URL: Repository, https://github.com/norm/whatnext
@@ -26,8 +26,11 @@ Description-Content-Type: text/markdown
 Document your tasks in Markdown files, using ["standard"][sn] notation:
 
 ```markdown
-- [ ] empty, this task is outstanding
-- [X] crossed, this task has been completed
+- [ ] open, this task is outstanding
+- [/] in progress, this task is partially complete
+- [X] complete, this task has been finished
+- [#] cancelled, this task has been scratched
+- [<] blocked, this task needs more input
 ```
 
 Then install `whatnext`:

{whatnext-0.2 → whatnext-0.3}/README.md

@@ -3,8 +3,11 @@
 Document your tasks in Markdown files, using ["standard"][sn] notation:
 
 ```markdown
-- [ ] empty, this task is outstanding
-- [X] crossed, this task has been completed
+- [ ] open, this task is outstanding
+- [/] in progress, this task is partially complete
+- [X] complete, this task has been finished
+- [#] cancelled, this task has been scratched
+- [<] blocked, this task needs more input
 ```
 
 Then install `whatnext`:

{whatnext-0.2 → whatnext-0.3}/docs/basics.md

@@ -3,16 +3,27 @@
 Tasks have states, which are indicated as such:
 
 ```markdown
-- [ ] empty, this task is outstanding
-- [X] crossed, this task has been completed
+- [ ] open, this task is outstanding
+- [/] in progress, this task is partially complete
+- [X] complete, this task has been finished
+- [#] cancelled, this task has been scratched
+- [<] blocked, this task needs more input
+
+- [@] no idea what this means
 ```
 
-Completed tasks are not listed by `whatnext`.
+By default, `whatnext` lists open, in progress, and blocked tasks. In progress
+tasks are shown first, blocked tasks are shown last. Completed and cancelled
+tasks are not listed unless `--all` is used.
 
 Headers are used in grouping tasks. The second-level header that comes next
 shows these tasks are a part of the main header. This does not indicate
 a lower priority, only grouping.
 
+An unknown state marker will generate a warning, but they can be suppressed
+if you are using other states for a purpose.
+
+
 ## Multiline tasks and indentation
 
 Tasks can be indented, and their text can continue across lines:

{whatnext-0.2 → whatnext-0.3}/docs/usage.md

@@ -1,7 +1,7 @@
 # Usage
 
-Without arguments, `whatnext` will show all incomplete tasks listed
-in any Markdown file:
+Without arguments, `whatnext` will show all outstanding tasks (open,
+in progress, and blocked) listed in any Markdown file:
 
 ```bash
 (computer)% whatnext
@@ -10,7 +10,9 @@ sample.md:
     - [ ] Do something for the sake of it
 docs/basics.md:
     # Indicating the state of a task
-    - [ ] empty, this task is outstanding
+    - [/] in progress, this task is partially complete
+    - [ ] open, this task is outstanding
+    - [<] blocked, this task needs more input
     # Indicating the state of a task / Multiline tasks and indentation
     - [ ] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
           eiusmod tempor incididunt ut labore et dolore magna aliqua.
@@ -19,9 +21,9 @@ docs/basics.md:
 
 They will be arranged:
 
-    - by file, depth-last, in alphabetical order
-    - grouped under the heading within the file (includes any parental
-      headings)
+- by file, depth-last, in alphabetical order
+- grouped under the heading within the file (includes any parental
+  headings)
 
 
 ## Matching
@@ -37,10 +39,10 @@ Any argument(s) can be used to filter the output:
     names like "doc", this could be ambiguous, use "./doc" to clarify)
 
 ```bash
-(computer)% whatnext empty
+(computer)% whatnext open
 docs/basics.md:
     # Indicating the state of a task
-    - [ ] empty, this task is outstanding
+    - [ ] open, this task is outstanding
 ```
 
 
@@ -61,18 +63,30 @@ docs/basics.md:
 -   `--config` — path to the [config file](dotwhatnext.md), defaults
     to `.whatnext` or `WHATNEXT_CONFIG`.
 
+-   `-q` / `--quiet` — suppress warnings (or `WHATNEXT_QUIET=1`).
+
+-   `-o` / `--open` — show only open tasks.
+
+-   `-p` / `--partial` — show only in progress tasks.
+
+-   `-b` / `--blocked` — show only blocked tasks.
+
+-   `-d` / `--done` — show only completed tasks.
+
+-   `-c` / `--cancelled` — show only cancelled tasks.
+
 -   `-s` / `--summary` — summarise the tasks found in files,
     rather than listing the tasks within:
 
     ```bash
     ░░░░░░░░░░░░░░                                             0/1  sample.md
-    ██████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░  1/4  docs/basics.md
+    ██████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░  1/7  docs/basics.md
     ```
 
     When there are multiple files, the progress bars are sized relative to the
     task file with the most tasks.
 
--   `-a` / `--all` — show all tasks, not just incomplete ones:
+-   `-a` / `--all` — show all tasks, not just outstanding ones:
 
     ```bash
     sample.md:
@@ -80,8 +94,11 @@ docs/basics.md:
         - [ ] Do something for the sake of it
     docs/basics.md:
         # Indicating the state of a task
-        - [ ] empty, this task is outstanding
-        - [X] crossed, this task has been completed
+        - [/] in progress, this task is partially complete
+        - [ ] open, this task is outstanding
+        - [X] complete, this task has been finished
+        - [#] cancelled, this task has been scratched
+        - [<] blocked, this task needs more input
         # Indicating the state of a task / Multiline tasks and indentation
         - [ ] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
               eiusmod tempor incididunt ut labore et dolore magna aliqua.
@@ -98,8 +115,8 @@ docs/basics.md:
     ```bash
     (computer)% whatnext --summary --all
     ░░░░░░░░░░░░                                        0/1  sample.md
-    ████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░  1/4  docs/basics.md
-    ██████████████████████████████████████              3/3  archive/done/tasks.md
+    ████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░  1/7  docs/basics.md
+    ██████████████████████████████████████████████████  3/3  archive/done/tasks.md
     ```
 
 

{whatnext-0.2 → whatnext-0.3}/tasks.md

@@ -27,10 +27,16 @@ which will start to fail if it is removed.)
 
 # version 0.3 - new statuses
 
-- [ ] decide upon and implement "in progress"
-- [ ] decide upon and implement "cancelled"
-- [ ] decide upon and implement "blocked"
-- [ ] warnings for unknown formats
+- [X] decide upon and implement "in progress"
+- [X] decide upon and implement "cancelled"
+- [X] decide upon and implement "blocked"
+- [X] warnings for unknown formats
+- [X] filter on incomplete
+- [X] filter on in progress
+- [X] filter on cancelled
+- [X] filter on blocked
+- [X] filter on complete
+- [X] summarise individual states, but not combos
 
 
 # version 0.4 - priorities
@@ -38,10 +44,19 @@ which will start to fail if it is removed.)
 - [ ] mark a single task as _medium_ priority
 - [ ] mark a single task **high** priority
 - [ ] mark a block of tasks via the header
-- [ ] sort higher priority tasks to the top -- decide if within files only or entire project
+- [ ] sort higher priority tasks to the top -- decide if within files
+      only or entire project
 
 
 # version 0.5 - deadlines
 
 - [ ] mark a single task as having a deadline
 - [ ] embellish deadlines with custom urgency windows
+
+
+# version 0.6 - enhancements
+
+- [ ] colour-code the output
+- [ ] pick tasks at random
+- [ ] some way to mark a section of Markdown for inclusion in the default
+      output

{whatnext-0.2 → whatnext-0.3}/tests/config.bats

@@ -1,3 +1,5 @@
+bats_require_minimum_version 1.5.0
+
 setup() {
     mkdir -p "$BATS_TEST_TMPDIR/project"
     echo "- [ ] task one" > "$BATS_TEST_TMPDIR/project/one.md"

whatnext-0.3/tests/list.bats

@@ -0,0 +1,279 @@
+bats_require_minimum_version 1.5.0
+
+@test "list tasks" {
+    run --separate-stderr whatnext
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        sample.md:
+            # Sample task file
+            - [ ] Do something for the sake of it
+        docs/basics.md:
+            # Indicating the state of a task
+            - [/] in progress, this task is partially complete
+            - [ ] open, this task is outstanding
+            - [<] blocked, this task needs more input
+            # Indicating the state of a task / Multiline tasks and indentation
+            - [ ] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+                  eiusmod tempor incididunt ut labore et dolore magna aliqua.
+            - [ ] Ut enim ad minim veniam,
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+
+    expected_stderr="WARNING: ignoring invalid state '@' in 'no idea what this means',"
+    expected_stderr+=" docs/basics.md line 12"
+    diff -u <(echo "$expected_stderr") <(echo "$stderr")
+
+    [ $status -eq 0 ]
+}
+
+@test "list tasks, changes width" {
+    COLUMNS=40 run --separate-stderr whatnext
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        sample.md:
+            # Sample task file
+            - [ ] Do something for the sake of
+                  it
+        docs/basics.md:
+            # Indicating the state of a task
+            - [/] in progress, this task is
+                  partially complete
+            - [ ] open, this task is outstanding
+            - [<] blocked, this task needs more
+                  input
+            # Indicating the state of a task /
+              Multiline tasks and indentation
+            - [ ] Lorem ipsum dolor sit amet,
+                  consectetur adipisicing elit,
+                  sed do eiusmod tempor
+                  incididunt ut labore et dolore
+                  magna aliqua.
+            - [ ] Ut enim ad minim veniam,
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+}
+
+@test "list all tasks" {
+    run --separate-stderr whatnext -a
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        sample.md:
+            # Sample task file
+            - [ ] Do something for the sake of it
+        docs/basics.md:
+            # Indicating the state of a task
+            - [/] in progress, this task is partially complete
+            - [ ] open, this task is outstanding
+            - [<] blocked, this task needs more input
+            - [X] complete, this task has been finished
+            - [#] cancelled, this task has been scratched
+            # Indicating the state of a task / Multiline tasks and indentation
+            - [ ] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+                  eiusmod tempor incididunt ut labore et dolore magna aliqua.
+            - [ ] Ut enim ad minim veniam,
+        archive/done/tasks.md:
+            # Some old stuff
+            - [X] Do the first thing
+            - [X] Do the second thing
+            - [x] do the last thing all lowercase
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+}
+
+@test "list tasks with --dir" {
+    cp -r . "$BATS_TEST_TMPDIR/project"
+
+    run --separate-stderr whatnext --dir "$BATS_TEST_TMPDIR/project"
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        sample.md:
+            # Sample task file
+            - [ ] Do something for the sake of it
+        docs/basics.md:
+            # Indicating the state of a task
+            - [/] in progress, this task is partially complete
+            - [ ] open, this task is outstanding
+            - [<] blocked, this task needs more input
+            # Indicating the state of a task / Multiline tasks and indentation
+            - [ ] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+                  eiusmod tempor incididunt ut labore et dolore magna aliqua.
+            - [ ] Ut enim ad minim veniam,
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+}
+
+@test "warnings suppressed with --quiet" {
+    run --separate-stderr whatnext --quiet
+    [ $status -eq 0 ]
+    [ -z "$stderr" ]
+}
+
+@test "warnings suppressed with WHATNEXT_QUIET=1" {
+    WHATNEXT_QUIET=1 run --separate-stderr whatnext
+    [ $status -eq 0 ]
+    [ -z "$stderr" ]
+}
+
+@test "--open filters to open tasks" {
+    run --separate-stderr whatnext --open docs/basics.md
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        docs/basics.md:
+            # Indicating the state of a task
+            - [ ] open, this task is outstanding
+            # Indicating the state of a task / Multiline tasks and indentation
+            - [ ] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+                  eiusmod tempor incididunt ut labore et dolore magna aliqua.
+            - [ ] Ut enim ad minim veniam,
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+
+    # short flag
+    run --separate-stderr whatnext -o docs/basics.md
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+}
+
+@test "--partial filters to in progress tasks" {
+    run --separate-stderr whatnext --partial docs/basics.md
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        docs/basics.md:
+            # Indicating the state of a task
+            - [/] in progress, this task is partially complete
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+
+    # short flag
+    run --separate-stderr whatnext -p docs/basics.md
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+}
+
+@test "--blocked filters to blocked tasks" {
+    run --separate-stderr whatnext --blocked docs/basics.md
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        docs/basics.md:
+            # Indicating the state of a task
+            - [<] blocked, this task needs more input
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+
+    # short flag
+    run --separate-stderr whatnext -b docs/basics.md
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+}
+
+@test "--done filters to completed tasks" {
+    run --separate-stderr whatnext --done docs/basics.md
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        docs/basics.md:
+            # Indicating the state of a task
+            - [X] complete, this task has been finished
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+
+    # short flag
+    run --separate-stderr whatnext -d docs/basics.md
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+}
+
+@test "--cancelled filters to cancelled tasks" {
+    run --separate-stderr whatnext --cancelled docs/basics.md
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        docs/basics.md:
+            # Indicating the state of a task
+            - [#] cancelled, this task has been scratched
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+
+    # short flag
+    run --separate-stderr whatnext -c docs/basics.md
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+}
+
+@test "state filters can be combined" {
+    run --separate-stderr whatnext -bc docs/basics.md
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        docs/basics.md:
+            # Indicating the state of a task
+            - [<] blocked, this task needs more input
+            - [#] cancelled, this task has been scratched
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+
+    run --separate-stderr whatnext -op docs/basics.md
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        docs/basics.md:
+            # Indicating the state of a task
+            - [/] in progress, this task is partially complete
+            - [ ] open, this task is outstanding
+            # Indicating the state of a task / Multiline tasks and indentation
+            - [ ] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+                  eiusmod tempor incididunt ut labore et dolore magna aliqua.
+            - [ ] Ut enim ad minim veniam,
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+
+    run --separate-stderr whatnext -bcdop docs/basics.md
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        docs/basics.md:
+            # Indicating the state of a task
+            - [/] in progress, this task is partially complete
+            - [ ] open, this task is outstanding
+            - [<] blocked, this task needs more input
+            - [X] complete, this task has been finished
+            - [#] cancelled, this task has been scratched
+            # Indicating the state of a task / Multiline tasks and indentation
+            - [ ] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+                  eiusmod tempor incididunt ut labore et dolore magna aliqua.
+            - [ ] Ut enim ad minim veniam,
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+}
+
+@test "state filter combines with search" {
+    run --separate-stderr whatnext --open lorem docs/basics.md
+
+    expected_output=$(sed -e 's/^        //' <<"        EOF"
+        docs/basics.md:
+            # Indicating the state of a task / Multiline tasks and indentation
+            - [ ] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+                  eiusmod tempor incididunt ut labore et dolore magna aliqua.
+        EOF
+    )
+    diff -u <(echo "$expected_output") <(echo "$output")
+    [ $status -eq 0 ]
+}