conffee-maker 0.1.0

Conffee can guide your to make your config files.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

# Conffee-maker

`$cm` or Confee Maker is a command terminal interface **TUI**
to generate configuration files for different applications based on templates.

Have you ever tried to configure `nvim`, `tmux`, `alacritty` or any other
dotfiles based application config?

What if you can tell `cm` to guide throught the process?

```bash
$ cargo install cm
```

> **IMPORTANT**: `cm` doesn't simply generate the config file for you
> it will instead guide you step by step allowing the selection of each
> option one by one, including an explanation of each config it will
> **never** allow you to set some config value without agreeing with its
> purpose.

Example:

```bash
$ cm --update-templates

[1%..... downloading community templates ..... 100%]

Updated Global templates:

- nvim
- tmux
- alacritty
...
```

Pass the template name to use global or pass the location for a custom template.

e.g:

`$ cm nvim`

or

`$ cm github.com/foo/bar:nvim`

With any of above the `cm` TUI will open and guide you on the process

```bash

Welcome to Conffee Maker press [enter] to start
brewing your conffeeguration files for `nvim`
     ______________________
    (___________           |
      [XXXXX]   |          |
 __  /~~~~~~~\  |          |
/  \|@@@@@@@@@\ |   nvim   |
\   |@@@@@@@@@@||          |
    \@@@@@@@@@@||  ______  |
     \@@@@@@@@/ | |on|off| |
    __\@@@@@@/__|  ~~~~~~  |
   (____________|__________|
   |_______________________|


```

Then in the next steps each screen will guide you

each screen is a guide for a line or a section of the config file.


```bash
###########################################################
#
#        Cursor Line and Column
#
#   set cursorline    [x]    - use space bar to select
#   set cursorcolumn  [x]
#
#  Please choose which cursor lines you want to be ren-
#  derred.
#
#  Cursor lines are special markers on screen as shown
#  in ....
#                                 [enter or -> for next]
#
#  Stats:
#    - 56% of users set this options to `true`
#    - This option is popular among Python developers
#    - This is useful for selections in Visual Column Mode
#
###########################################################
```

`cm` is going to show a screen for each section of the
config file and at the end will generate the file
and ask the user if wants to change its save location.

`cm` will always backup existing file if found.

## Templates

Templates are YAML files containing global variables
and templates for each option `also called drops`.


`nvim.yaml`
```yaml
---
cm: 0.1.0
defaults:
  output_path: "$XDG_HOME/.config/nvim/init.vim"
drops:
  - name: Cursor Line and Column
    spaced: true
    options:
      - "set cursorline   {flag}"
      - "set cursorcolumn {flag}"
    outputs:
      - "set cursorline"
      - "set cursorcolumn"
    help: Cursor lines are special markers on screen as shown in ...

  - name: Allow hidden buffers
    spaced: false
    options:
      - "set hidden {flag}"
    outputs:
      - "set hidden"
    help: Enables the closing of buffers without saving it.

```

Multiple templates can be merged and composed.