v1.0.0-rc.1

This release breaks compatibility with v0.2.0-alpha and v0.1.0-alpha.

Breaking Changes:

• the notation for adding a priority has changed from:

  opus add "title ,,,"

  to:

  opus add "title .5"

• reworked opus export interface:

  • before

    # exports all tasks in the data.json file
    opus export json data
    # export all tasks in the mycsvfile.csv file
    opus export csv mycsvfile
    # data.tsv
    opus export tsv data

  • after

     # exports all tasks in the data.json file
    opus export --format="json" --output="data.json"
    # export all tasks in the data.csv file
    opus export --format="csv" --output="data.csv"
    # export all tasks in the data.tsv file
    opus export --format="tsv" --output="data.csv"

New Features:

• help page for all subcommands and toplevel:

  Manage tasks with ease
  
  Usage: opus <COMMAND>
  
  Commands:
    add     create a new task [aliases: a]
    delete  delete a task with the given id [aliases: del, d]
    clear   remove all tasks from the database
    finish  mark the task with the given id as finished [aliases: fin, f]
    list    list tasks matching the given query [aliases: ls, l]
    export  export all tasks
    help    Print this message or the help of the given subcommand(s)
  
  Options:
    -h, --help     Print help information
    -V, --version  Print version information
  

• list tasks marked as finished using opus list --finished
• sort the opus list output using --sort-by and --sort-order, read more here
• improved displaying tasks:
  • finished tasks are now marked with FINISHED
  • priority changed for [,,,] to .3
  • before:

    [2]: 'update excel sheet' (2022-10-13) #work [,,,]
    

  • after:

    [2]: 'update excel sheet' (2022-10-13) #work .3 FINISHED
    

Pull Requests

• test: use sqlite in-memory db when running tests by @daniel0611 in #15
• Feat/migrate to clap by @xNaCly in #17
• test: add missing asserts to task.compare_content() calls by @daniel0611 in #18
• Feat/list sort by @xNaCly in #19
• fix: get add task content as owned string by @daniel0611 in #20

New Contributors

• @daniel0611 made their first contribution in #15

Full Changelog: v0.2.0-alpha...v1.0.0-rc.1

v0.2.0-alpha

v0.2.0-alpha

Features

• Change OPUS_PATH env var handling (ba12097)

Chore

• Add all database files to the gitignore (db81820)

Full Changelog: v0.1.0-alpha...v0.2.0-alpha

v0.1.0-alpha

Features

• Init
  • add project structure
  • add cli parser
  • add types for arguments and argument types (6d14563)
• Implement command shorthands readded readme to source tree (8f0aaad)
• Implemented parsing cli args (b0b25ce)
• Add list command (9c266a4)
• Add other argumentTypes to match (cee1eba)
• Replace @today and @tomorrow (513ff5f)
• Unit test parse_args
  • removed InputTask
  • removed Task.id
  • add database wrapper WIP
  • add get_config_path
  • add does_config_exist
  • renamed parse_cli to parse_args (035eef6)
• Finish get_config_path implementation
  • add more tests (74ba4c5)
• Implement 'opus list' WIP (dfd74cf)
• WIP create_new_db (3af8c6f)
• Add 'rusqlite' to project (6f4f2dc)
• Implemented 'create_file' (3a6708b)
• db: Implement db connection (2e105ca)
• Implement database methods (a38552d)
• Implement 'opus list' (0374ad5)
• Introduce 'finished' task value (5478c58)
• Implement 'opus list' (a6e047f)
• Implemented 'opus clear' (0e10a8a)
• util: Only create missing dirs (c5b4803)
• Implemented opus export (#8)
• Add match arm for ArgumentType::Delete (244009d)
• Implement #9 (opus delete) (#9)
• Task view implementation #5 (#5)
• Add help command #11 (#11)

Bug-Fixes

• Index out of bounds thread 'main' panicked at 'index out of bounds: the len is 1 but the index is 1', src/cli.rs:16:11 (a2fa1ea)
• #1 - add 'macos' to 'linux' match arm (#1)
• util: Fix return type util::create_dir_if_not_exist (d7c8819)

Refactors

• Update ArgumentType (2dc7383)
• Wrapped task in option to allow query (e59d25d)
• Remove unused imports - add allow dead code and unused variables to main.rs (8262763)
• Db wrapper refactor (switch to sqlite) (653ce33)
• Move db functions to util module (434ff92)
• Changes required by db changes
  • removed imports in cli
  • removed outdated function calls in cli
  • updated function calls in tests
  • removed hard coded path to config in util
  • updated hard coded 'CONFIG_PATH' from text
  • & filebased database to a relational database (5615ab6)
• util: Remove redundant methods (a7ffc0f)
• Open db conn and close db after use (8b1b03c)
• Made changes suggested by @daniel0611 (6b77bb8)
• util: Replaced default arm with panic (201590d)
• Renamed commands (again)
  • renamed:
    • ls -> list
    • del -> delete
    • fin -> finish
    • update usage.md to reflect the above changes (3deb221)

Chore

• Remove target folder (90890d6)
• Renamed 'opus_cli' -> 'opus' (e4b3c0c)

Tests

• db: Add database connection tests (f02ff77)
• #4 added tests new tests:
  • util::create_dir_if_not_exist
  • util::get_db_path (#4)
• #4 add more tests
  • now test if all ArgumentType enum values are correct
  • move tests to correct module
  • add task.finished check to parse_args (#4)
• Remove outdated test
  • this test became outdated due to the addition of running opus list if opus was called without any arguments, see c0df4ba (00fdbfc)

CI

• Restrict test runs to src and workflow dirs (bcf9bee)

Contributors

• @AntoniosBarotsis