hypercodec / cltemplate

A small CLI for quickly creating and using templates

CLTemplate

Small commandline tool to create and use templates quickly

Installation

Simply run cargo install cltemplate to install the tool.

Using Templates

To use a template, do the following:

1. CD into the folder of the template (your terminal should be running at path/to/template)
2. Run template path/to/output and check the directory you provided

Optionally, you can use the --template-path param instead of CDing to the the template folder

Writing Templates

To write a template that others can use with this tool, you must:

1. Create a folder for the template

2. In the root directory of the folder, create a template.txt file. In this file, there should be the name of each replaceable item, separated by newlines (ex:

   foo
   bar
   buz
   qux
   quux
   corge
   grault
   garply
   waldo
   fred
   plugh
   xyzzy
   thud
   

   )

3. Fill in the rest of the folder with the files provided in the template. Anything defined in template.txt that has % around it (ex: %foo%) will be replaced by whatever the user inputs. Anything surrounded by % that is not included in template.txt will remain unchanged.

4. Share your template and usage instructions via your preferred method.

License

This tool is licensed under the MIT license.

Roadmap

• Initial prototype
• Complete rework
• Asynchronous file IO
• Indicatif progress bar
• Dynamic filepaths

cltemplate's Issues

Dialoguer messages copy when wrapping

Dialoguer uses a clearline char to clear the latest line, but if the response wraps to another line, it only deletes the part that wraps instead of the full prompt.

Infinitely recursing templates

If the target directory is a subset of the template directory, the engine will keep adding folders for a long time until the exploration outperforms the async task.

Likely will be solved by entirely disabling targets inside of templates.

[ROADMAP] implement template args in initial command

Essentially just allows the user to append --key value to their command to skip the dialogue prompts. If not all args are provided, only skip the ones that were.

[ROADMAP] replace template.txt with template.toml

• input types
• ability to ignore certain files/folders (similar to rust's exclude)

[ROADMAP] indicatif support

plan to replace info spam with indicatif tasks for cleaner cli

Mutex Poisoning

When working with a lot of files, it can break because the handles vec is being consumed before actually joining them.

Non-UTF-8 files crash during template use

Any file that does not contain valid UTF-8 will cause the following:

thread 'main' panicked at 'Unable to read file: Error { kind: InvalidData, message: "stream did not contain valid UTF-8" }',  src/main.rs:55:61
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace