onepub-dev/dcli

Implement templating system

Open

#4 opened on Nov 28, 2019

View on GitHubContributor guide
 (2 comments) (0 reactions) (1 assignee)Dart (30 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (266 stars)
PR merge metrics
 (PR metrics pending)

Description

I'm interested in creating a template system. When you create a project you can start with an existing library of your own or we will generate one for you. It might be useful to have a small library of starter templates that demonstrate common techniques when using dshell.

dshell create from <template>

Templates would live in ~/.dshell/templates

Then give the user the ability to list, add and delete templates of their own.

We should have two subdirectories under templates:

  • builtin
  • user This will allow us to upgrade the builtin templates without risk of interfering with the user templates.

Should we allow a user to create a template with the same name as a builtin template?

We should could allow a user to create a template with the same name as a built in template as a way to 'override' the standard templates.

If this is the case then we should warn the user before creating the user template.

Contributor guide

Research direction
Study the dcli codebase to understand how CLI commands are structured. Look at existing commands for patterns. Design the template system using the builtin/user subdirectories. Implement subcommands for 'create from', 'list', 'add', 'delete' templates. Handle override and warning.
Tech stack
dart
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
DartGitCLI basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60