matthewchivers / dodl

A cli tool that automates the creation and organisation of structured documents using custom templates; Focus on writing, not setup.
MIT License
1 stars 0 forks source link

[Feature] Aliases for Document Types and Commands #52

Open matthewchivers opened 1 week ago

matthewchivers commented 1 week ago

Summary

Introduce aliases for commands (and ability to specify aliases for document types) to streamline usage and reduce typing effort, making dodl quicker and easier to use.

Motivation

As dodl grows, users may frequently rely on certain commands and document types. Providing shorthand aliases allows users to interact with dodl more efficiently, improving the overall experience by reducing repetitive typing and making commands more intuitive.

Proposed Solution

Implement commonly used aliases for:

The aliases should be easy to remember and ideally configurable by users in their settings (in cases like doctypes). Aliases should appear in help documentation to ensure visibility.

Alternatives Considered

  1. Full Command/Document Names Only: Keeping full names might maintain clarity but would lack the convenience that aliases bring, especially for repetitive or long commands.
  2. Doctype inheritance: Potentially the doctype inheritance issue will cover aliases for doctypes - in some way - but it might also be good to have doctypes inherit other aliases, even?

Additional Context

Implementing aliases will also support consistency with future autocompletion features, helping users quickly locate common commands and document types.

Checklist