From 518d90a6e0925e5e725551fbf4f5120978491566 Mon Sep 17 00:00:00 2001
From: Alexander Foremny <aforemny@posteo.de>
Date: Fri, 8 Dec 2023 07:55:39 +0100
Subject: issue: add future enhancements
---
app/Main.hs | 37 +++++++++++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
diff --git a/app/Main.hs b/app/Main.hs
index 46f6e77..61fbe07 100644
--- a/app/Main.hs
+++ b/app/Main.hs
@@ -1,3 +1,29 @@
+-- TODO Add `anissue format`
+--
+-- `anissue format` should format all open issues according to the formatting rules.
+--
+-- The formatting rules are given implicitly through the `Render (Detailed Issue)` instance.
+--
+-- The formatting width should be configurable through `Settings`, but should be unlimited by default.
+--
+-- @topic formatting
+
+-- TODO Add `anissue review`
+--
+-- `anissue review` should provide helpful tips in order to increase the qualify of issues.
+--
+-- Reported issues should be able to be automatically `--fix`ed, if possible.
+--
+-- Firstly, I would like `anissue review` to report on the following:
+--
+-- - Referencing issues through misspelled ids\*
+-- - Defining tags outside of tag paragraphs
+-- - Having tags not sorted alphabetically
+--
+-- \* We might have to have for this a notion what tags are referencing issue ids. This should eventually be configurable through `Settings`, but we can hardcode `@references`, `@supersedes` and `@related` for now.
+--
+-- @topic linting
+
-- TODO Tag improvements (OR-filtering)
--
-- Currently it is not possible to filter for an issue satisfying one filter or another. We could add the following syntax allowing it:
@@ -456,6 +482,17 @@ data Command
}
| Show
{ id :: String,
+ -- TODO Extend `--edit` to `List` command
+ --
+ -- Similarly to `anissue show --edit`, `anisuse list --edit` should open all selected (ie. through `--filter`) issues an `$EDITOR`.
+ --
+ -- This would allow for instance for triaging issues once a week:
+ --
+ -- ```
+ -- anissue list --filter '@createdAt <1w' --edit
+ -- ```
+ --
+ -- \*Note that `<1w` is hypothetical syntax, currenlty.*
edit :: Bool
}
| Tags
--
cgit v1.2.3