compliance-trestle icon indicating copy to clipboard operation
compliance-trestle copied to clipboard

As a user I would like trestle to (optionally) remove plurals from name when using trestle author docs create-sample

Open butler54 opened this issue 2 years ago • 0 comments

Issue description / feature objectives

This is not high priority, however, I believe it is a nice feature, and could have a minimal implementation (or quite a sophisticated one).

  • trestle author docs setup -tn decisions
  • When I run trestle author docs create-sample -tn decisions rather than creating
    • decisions/decisions_001.md ideally it would be good to create decisions/decision_001.md
  • Similar could be true for acronyms:
    • trestle author docs setup -tn ADRs -> ADRs/ADR_001.md

Three ways this could be created:

  1. Optional (or not) behaviour for stripping trailing s from the name
  2. Using a library that can 'deplural' words (e.g. https://pypi.org/project/inflect/) -
  3. Add a stem/prepend argument to create sample (allowing flexibilty)
    1. For the top scenario that would result in trestle author docs create-sample -tn decisions --stem decision`

I would put this as a post 1.0.0 feature.

butler54 avatar Apr 06 '22 22:04 butler54