Merge pull request #124 from ad-si/claude/implement-feature-78-vEyTT

Enable users to define their own shortcuts via the config file

Author: ad-si

.github/workflows/main.yml

@@ -72,10 +72,10 @@ jobs:
         arch: [x86_64, arm64]
         include:
           - arch: x86_64
-            runner: macos-14
+            runner: macos-15-intel
             artifact: tasklite_macos_x86_64
           - arch: arm64
-            runner: macos-latest
+            runner: macos-26
             artifact: tasklite_macos_arm64
 
     runs-on: ${{ matrix.runner }}

docs-source/cli/usage.md

@@ -40,6 +40,60 @@ It is also possible to immediately add tags when creating a task:
 tl add Improve the TaskLite manual +tasklite +pc
 ```
 
+### Built-in Shortcuts
+
+TaskLite provides several built-in shortcuts to quickly add tasks with common tags:
+
+- `tl write "Email to John"` → Adds "Write Email to John +write"
+- `tl read "Article about Haskell"` → Adds "Read Article about Haskell +read"
+- `tl idea "New feature"` → Adds "New feature +idea"
+- `tl watch "Haskell tutorial"` → Adds "Watch Haskell tutorial +watch"
+- `tl listen "Podcast episode"` → Adds "Listen Podcast episode +listen"
+- `tl buy "Groceries"` → Adds "Buy Groceries +buy"
+- `tl sell "Old laptop"` → Adds "Sell Old laptop +sell"
+- `tl pay "Electric bill"` → Adds "Pay Electric bill +pay"
+- `tl ship "Package to Mom"` → Adds "Ship Package to Mom +ship"
+
+### Custom Shortcuts
+
+You can also define your own shortcuts in the config file.
+For example, to add shortcuts for `cook`, `call`, `fix`, and `shopping`:
+
+```yaml
+shortcuts:
+  cook:
+    prefix: Cook
+    tag: cook
+  call:
+    prefix: Call
+    tag: call
+  fix:
+    tag: fix  # No prefix, just adds the tag
+  shopping:
+    prefix: Buy
+    tags: [shopping, errands]  # Multiple tags
+  quick:
+    prefix: Do
+    tags: []  # No tags, just the prefix
+```
+
+With this configuration:
+
+- `tl cook dinner` → Adds "Cook dinner +cook"
+- `tl call Mom` → Adds "Call Mom +call"
+- `tl fix login bug` → Adds "login bug +fix"
+- `tl shopping milk` → Adds "Buy milk +shopping +errands"
+- `tl quick something` → Adds "Do something"
+
+Each shortcut has the following fields:
+
+- `prefix` (optional): Text to prepend to the task body
+- `tag` (optional): Single tag to add to the task (without the `+` prefix)
+- `tags` (optional): List of tags to add to the task (without the `+` prefix)
+
+You can use either `tag` for a single tag or `tags` for multiple tags.
+If both are specified, they are combined.
+
 And even to set certain fields:
 
 ```shell

tasklite-core/example-config.yaml

@@ -44,3 +44,30 @@ progressBarWidth: 24
 #     pre:
 #       - interpreter: python3
 #         body: print('Python test')
+
+# Custom shortcuts to quickly add tasks with tags.
+# For example: `tl cook Dinner` will add a task "Cook Dinner +cook"
+# You can use either `tag` for a single tag or `tags` for multiple tags.
+# shortcuts:
+#   cook:
+#     prefix: Cook
+#     tag: cook
+#   wash:
+#     prefix: Wash
+#     tag: wash
+#   print:
+#     prefix: Print
+#     tag: print
+#   call:
+#     prefix: Call
+#     tag: call
+#   email:
+#     prefix: Email
+#     tag: email
+#   fix:
+#     tag: fix
+#   shopping:
+#     prefix: Buy
+#     tags: [shopping, errands]  # Multiple tags
+#   quick:
+#     tags: []  # No tags, just the prefix

tasklite-core/package.yaml

@@ -59,6 +59,7 @@ library:
     - ansi-terminal >= 0.11 && < 1.2
     - bytestring >= 0.11 && < 0.13
     - cassava >= 0.5.2 && < 0.6
+    - containers >= 0.6 && < 0.8
     - colour >= 2.3 && < 2.4
     - directory >= 1.3 && < 1.4
     - editor-open >= 0.4 && < 0.7

tasklite-core/source/Cli.hs

@@ -152,8 +152,10 @@ import Config (
   Config (..),
   HookSet (..),
   HooksConfig (..),
+  Shortcut (..),
   addHookFilesToConfig,
  )
+import Data.Map.Strict qualified as Map
 import Control.Arrow ((>>>))
 import Hooks (executeHooks, formatHookResult)
 import ImportExport (
@@ -385,6 +387,8 @@ data Command
   | Gui
   | UlidToUtc Text
   | ExternalCommand Text (Maybe [Text])
+  | AddCustomShortcut Shortcut [Text]
+  -- ^ Custom shortcut command from config
   deriving (Show, Eq)
 
 
@@ -448,6 +452,23 @@ getCommand (alias, commandName) =
       (progDesc $ T.unpack $ alias <> "-> " <> commandName)
 
 
+-- | Create a parser for a custom shortcut from config
+getShortcutCommand :: (Text, Shortcut) -> Mod CommandFields Command
+getShortcutCommand (cmdName, shortcut) =
+  command (T.unpack cmdName) $
+    info
+      (AddCustomShortcut shortcut <$> some (strArgument
+        (metavar "BODY" <> help "Body of the task")))
+      (progDesc $ T.unpack $ description)
+  where
+    description = case shortcut.prefix of
+      Just pfx -> pfx <> " something (custom shortcut)"
+      Nothing -> case shortcut.tags of
+        [] -> "Add task (custom shortcut)"
+        [t] -> "Add task with +" <> t <> " tag (custom shortcut)"
+        ts -> "Add task with " <> T.intercalate ", " (fmap ("+" <>) ts) <> " tags (custom shortcut)"
+
+
 toParserInfo :: Parser a -> Text -> ParserInfo a
 toParserInfo parser description =
   info parser (fullDesc <> progDesc (T.unpack description))
@@ -472,6 +493,7 @@ idsVar =
 -- | Help Sections
 basic_sec
   , shortcut_sec
+  , custom_shortcut_sec
   , list_sec
   , vis_sec
   , i_o_sec
@@ -482,6 +504,7 @@ basic_sec
     (Text, Text)
 basic_sec = ("{{basic_sec}}", "Basic Commands")
 shortcut_sec = ("{{shortcut_sec}}", "Shortcuts to Add a Task")
+custom_shortcut_sec = ("{{custom_shortcut_sec}}", "Custom Shortcuts")
 list_sec = ("{{list_sec}}", "List Commands")
 vis_sec = ("{{vis_sec}}", "Visualizations")
 i_o_sec = ("{{i_o_sec}}", "I/O Commands")
@@ -730,6 +753,16 @@ commandParser conf =
         "Ship an item to someone")
     )
 
+  -- Custom shortcuts from config (only show section if there are shortcuts)
+  <|> (if null (Map.toList conf.shortcuts)
+      then P.empty
+      else hsubparser
+        (  metavar (T.unpack $ snd custom_shortcut_sec)
+        <> commandGroup (T.unpack $ fst custom_shortcut_sec)
+        <> foldMap getShortcutCommand (Map.toList conf.shortcuts)
+        )
+      )
+
   <|> hsubparser
     (  metavar (T.unpack $ snd list_sec)
     <> commandGroup (T.unpack $ fst list_sec)
@@ -1158,6 +1191,7 @@ helpReplacements :: Config -> [(Text, Doc AnsiStyle)]
 helpReplacements conf =
   [ basic_sec
   , shortcut_sec
+  , custom_shortcut_sec
   , list_sec
   , vis_sec
   , i_o_sec
@@ -1340,6 +1374,14 @@ executeCLiCommand config now connection progName args availableLinesMb = do
         AddSell bodyWords -> addTaskC $ ["Sell"] <> bodyWords <> ["+sell"]
         AddPay bodyWords -> addTaskC $ ["Pay"] <> bodyWords <> ["+pay"]
         AddShip bodyWords -> addTaskC $ ["Ship"] <> bodyWords <> ["+ship"]
+        AddCustomShortcut shortcut bodyWords ->
+          let
+            prefixWords = case shortcut.prefix of
+              Just pfx -> [pfx]
+              Nothing -> []
+            tagWords = fmap ("+" <>) shortcut.tags
+          in
+            addTaskC $ prefixWords <> bodyWords <> tagWords
         LogTask bodyWords -> logTask conf connection bodyWords
         EnterTask -> enterTask conf connection
         ReadyOn datetime ids -> setReadyUtc conf connection datetime ids

tasklite-core/source/Config.hs

@@ -29,6 +29,9 @@ import Protolude (
  )
 import Protolude qualified as P
 
+import Data.Map.Strict (Map)
+import Data.Map.Strict qualified as Map
+
 import Data.Aeson (
   FromJSON (parseJSON),
   ToJSON (toJSON),
@@ -107,6 +110,33 @@ data HooksConfig = HooksConfig
   deriving (Generic, Show)
 
 
+-- | Custom shortcut for adding tasks with predefined prefix and tags
+data Shortcut = Shortcut
+  { prefix :: Maybe Text
+  -- ^ Optional prefix to prepend to task body (e.g., "Cook")
+  , tags :: [Text]
+  -- ^ Tags to add to the task (without the + prefix)
+  }
+  deriving (Eq, Generic, Show)
+
+
+instance ToJSON Shortcut
+
+
+instance FromJSON Shortcut where
+  parseJSON = withObject "shortcut" $ \o -> do
+    prefix <- o .:? "prefix"
+    -- Support both "tag: xxx" (single) and "tags: [xxx, yyy]" (multiple)
+    tagSingle <- o .:? "tag" .!= ""
+    tagsList <- o .:? "tags" .!= []
+    let tags = case (tagSingle, tagsList) of
+          ("", []) -> []
+          ("", ts) -> ts
+          (t, []) -> [t]
+          (t, ts) -> t : ts -- If both specified, combine them
+    pure $ Shortcut{..}
+
+
 instance ToJSON HooksConfig
 
 
@@ -285,6 +315,8 @@ data Config = Config
   , maxWidth :: Maybe Int -- Automatically uses terminal width if not set
   , progressBarWidth :: Int
   , hooks :: HooksConfig
+  , shortcuts :: Map Text Shortcut
+  -- ^ Custom shortcuts for adding tasks (e.g., "cook" -> adds "Cook" prefix and "+cook" tag)
   , noColor :: Bool
   }
   deriving (Generic, Show)
@@ -318,6 +350,7 @@ instance FromJSON Config where
     progressBarWidth <- o .:? "progressBarWidth"
                                 .!= defaultConfig.progressBarWidth
     hooks           <- o .:? "hooks" .!= defaultConfig.hooks
+    shortcuts       <- o .:? "shortcuts" .!= defaultConfig.shortcuts
     noColor         <- o .:? "noColor" .!= defaultConfig.noColor
 
     let maxWidth = maxWidthMb >>=
@@ -423,5 +456,6 @@ defaultConfig =
           , modify = emptyHookSet
           , exit = emptyHookSet
           }
+    , shortcuts = Map.empty
     , noColor = False
     }

tasklite-core/tasklite-core.cabal

@@ -80,6 +80,7 @@ library
     , bytestring >=0.11 && <0.13
     , cassava >=0.5.2 && <0.6
     , colour ==2.3.*
+    , containers >=0.6 && <0.8
     , directory ==1.3.*
     , editor-open >=0.4 && <0.7
     , exceptions ==0.10.*