planter-cli 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d811f48053b6544dc93bec282620300d673dc5524cc534e0b4fe59d194d09c19
-  data.tar.gz: 8da8c9f74029c96f7286f25c80be21a35d87237c2942db24a9864d881d04f509
+  metadata.gz: 06c272d8c938a24e24d8ad5ec220ba9100f6f35fbe6e8d9765a33c982607dbd0
+  data.tar.gz: f9a21781e985fce37c419fcf5f4e6f33cd13c951cd882468b6c90e3a19b50fdd
 SHA512:
-  metadata.gz: 73daffea9046af25fb1c1d1839eb622ca87ec43ab2d5aab4bbf6f593cb4ea24176f9f443aadf4178610d181eb4cec5276ed92cd7ca880f1d5a72ab364e397ab9
-  data.tar.gz: 104ca18f851112b4142f5ef6e5b31eb564d8e83be9de87f0cb1107a42e35f180adf23858896a599f3aeee7eff2683b90b03fe4ffc6ae8dc3945bc237ffffaf14
+  metadata.gz: ffbd475e7f56a2c96cf325cd1a681e9a7541d191c9cc9f669c06e2b3a74b4c889b2256290c5b390ea36aa408bc5e262f605ed0106e4ec409b2dece751adbbcbc
+  data.tar.gz: cc9241c6c6ac2a10ac2d5b82cdf2e6c204472c18834b113499af57e18615706a429c2900d19bdb9aa287c2d77bbe0f0a0a22c29288c10fceb292d623a23c86c3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 3.0.4
+
+2024-09-02 08:43
+
+#### FIXED
+
+- Incorrect binary name in help banner
+
 ### 3.0.3
 
 2024-09-02 08:02

data/README.md

@@ -8,10 +8,6 @@ Plant a directory structure and files using templates.
 
 If you run into errors, try `gem install --user-install planter-cli`, or as a last ditch effort, `sudo gem install planter-cli`.
 
-### Optional
-
-If [Gum](https://github.com/charmbracelet/gum) is available it will be used for command line input.
-
 ## Configuration
 
 Planter's base configuration is in `~/.config/planter/planter.yml`. This file can contain any of the keys used in templates (see below) and will serve as a base configuration for all templates. Any key defined in this file will be overridden if it exists in a template.
@@ -37,7 +33,7 @@ Scripts can be executable files in any language, and receive the template direct
 
 Templates are directories found in `~/.config/planter/templates/[TEMPLATE_NAME]`. All files and directories inside of these template directories are copied when that template is called. Filenames, directory names, and file contents can all use template placeholders.
 
-Template placeholders are defined with `%%KEY%%`, where key is the key defined in the `variables` section of the configuration. %%KEY%% placeholders can be used in directory/file names, and in the file contents. These work in any plain text or RTF format document, including XML, so they can be used in things like Scrivener templates and MindNode files as well.
+Template placeholders are defined with `%%KEY%%`, where key is the key defined in the `variables` section of the configuration. `%%KEY%%` placeholders can be used in directory/file names, and in the file contents. These work in any plain text or RTF format document, including XML, so they can be used in things like Scrivener templates and MindNode files as well.
 
 Each template contains a `_planter.yml` file that defines variables and other configuration options. The file format for all configuration files is [YAML](https://yaml.org/spec/1.2.2/).
 
@@ -52,23 +48,28 @@ variables:
     default: Untitled
     min: 1
     max: 5
+```
+
+A configuration can include additional keys:
+
+```yaml
 script: # array of scripts, args passed as [script and args] TEMPLATE_DIR PWD
   - process.py
 git_init: false # if true, initialize a git repository in the newly-planted directory
 files: # Dictionary for file handling (see [File-specific handling](#file-specific-handling))
 replacements: # Dictionary of pattern/replacments for regex substitution, see [Regex replacements](#regex-replacements)
-repo: # If a repository URL is provided, it will be pulled and duplicated instead of copying a file structure
+repo: # If a repository URL is provided, it will be pulled and duplicated instead of copying an existing file structure
 ```
 
 #### Default values in template strings
 
-In a template you can add a default value for a placholder by adding `%default value` to it. For example, `%%project%Default Project%%` will set the placeholder to `Default Project` if the variable value matches the default value in the configuration. This allows you to accept the default on the command line but have a different value inserted in the template. To use another variable in its place, use `$KEY` in the placeholder, e.g. `%%project%$title%%` will replace the `project` key with the value of `title` if the default is selected. Modifiers can be used on either side of the `%`, e.g. `%%project%$title:snake%%`.
+In a template you can add a default value for a placholder by adding `%default value` to it. For example, `%%project%Default Project%%` will set the placeholder to `Default Project` if the variable value matches the default value in the configuration (or doesn't exist). This allows you to accept the default on the command line but have a different value inserted in the template. To use another variable in its place, use `$KEY` in the placeholder, e.g. `%%project%$title%%` will replace the `project` key with the value of `title` if the default is selected. Modifiers can be used on either side of the `%`, e.g. `%%project%$title:snake%%`.
 
 #### Multiple choice type
 
 If the `type` is set to `choice`, then the key `choices` can contain a hash or array of choices. The key that accepts the choice should be surrounded with parenthesis (required for each choice).
 
-If a Hash is defined, each choice can have a result string:
+If a Hash/Dictionary is defined, each choice can have a result string:
 
 ```yaml
 variables:
@@ -84,7 +85,9 @@ variables:
       (z)sh: "#! /bin/zsh"
 ```
 
-If an array is defined, the string of the choice will also be its result:
+When a choice is selected from a dictionary, the result string will be inserted instead of the choice title.
+
+If an array is defined, the string of the choice will also be its result (minus any parenthesis):
 
 ```yaml
 variables:
@@ -100,7 +103,7 @@ variables:
       - 1. zsh
 ```
 
-If the choice starts with a number (as above), then a numeric list will be generated and typing the associated index number will accept that choice. Numeric lists are automatically numbered, so the preceding digit doesn't matter, as long as it's a digit. In this case a default can be defined with an integer for its placement in the list (starting with 1), and parenthesis aren't required.
+If the choice starts with a number (as above), then a numeric list will be generated and typing the associated index number will accept that choice. Numeric lists are automatically numbered, so the preceding digit doesn't matter, as long as it's a digit. In this case a default can be defined with an integer (in the `defaults:` key) for its placement in the list (starting with 1), and parenthesis aren't required.
 
 #### If/then logic
 
@@ -196,7 +199,7 @@ If `preserve_tags` is set to `true` in the config (either base or template), the
 The executable for Planter is `plant`. You can run `plant TEMPLATE` in any directory and TEMPLATE will be planted in the current directory. You can also use `--in PATH` to plant in another directory.
 
 ```
-Usage: planter [options] TEMPLATE
+Usage: plant [options] TEMPLATE
     --defaults                       Accept default values for all variables
     -i, --in TARGET                  Plant in TARGET instead of current directory
     -o, --overwrite                  Overwrite existing files

data/bin/plant

@@ -26,7 +26,7 @@ Planter.base_dir = ENV['PLANTER_DIR'] || File.expand_path('~/.config/planter')
 Planter::Color.coloring = $stdout.isatty
 
 opts = OptionParser.new
-opts.banner = 'Usage: planter [options] TEMPLATE'
+opts.banner = 'Usage: plant [options] TEMPLATE'
 
 Planter.accept_defaults = false
 opts.on('--defaults', 'Accept default values for all variables') do

data/lib/planter/version.rb

@@ -3,5 +3,5 @@
 # Primary module for this gem.
 module Planter
   # Current Planter version.
-  VERSION = '3.0.3'
+  VERSION = '3.0.4'
 end

data/src/_README.md

@@ -13,10 +13,6 @@ Plant a directory structure and files using templates.
 
 If you run into errors, try `gem install --user-install planter-cli`, or as a last ditch effort, `sudo gem install planter-cli`.
 
-### Optional
-
-If [Gum](https://github.com/charmbracelet/gum) is available it will be used for command line input.
-
 ## Configuration
 
 Planter's base configuration is in `~/.config/planter/planter.yml`. This file can contain any of the keys used in templates (see below) and will serve as a base configuration for all templates. Any key defined in this file will be overridden if it exists in a template.
@@ -42,7 +38,7 @@ Scripts can be executable files in any language, and receive the template direct
 
 Templates are directories found in `~/.config/planter/templates/[TEMPLATE_NAME]`. All files and directories inside of these template directories are copied when that template is called. Filenames, directory names, and file contents can all use template placeholders.
 
-Template placeholders are defined with `%%KEY%%`, where key is the key defined in the `variables` section of the configuration. %%KEY%% placeholders can be used in directory/file names, and in the file contents. These work in any plain text or RTF format document, including XML, so they can be used in things like Scrivener templates and MindNode files as well.
+Template placeholders are defined with `%%KEY%%`, where key is the key defined in the `variables` section of the configuration. `%%KEY%%` placeholders can be used in directory/file names, and in the file contents. These work in any plain text or RTF format document, including XML, so they can be used in things like Scrivener templates and MindNode files as well.
 
 Each template contains a `_planter.yml` file that defines variables and other configuration options. The file format for all configuration files is [YAML](https://yaml.org/spec/1.2.2/).
 
@@ -57,23 +53,28 @@ variables:
     default: Untitled
     min: 1
     max: 5
+```
+
+A configuration can include additional keys:
+
+```yaml
 script: # array of scripts, args passed as [script and args] TEMPLATE_DIR PWD
   - process.py
 git_init: false # if true, initialize a git repository in the newly-planted directory
 files: # Dictionary for file handling (see [File-specific handling](#file-specific-handling))
 replacements: # Dictionary of pattern/replacments for regex substitution, see [Regex replacements](#regex-replacements)
-repo: # If a repository URL is provided, it will be pulled and duplicated instead of copying a file structure
+repo: # If a repository URL is provided, it will be pulled and duplicated instead of copying an existing file structure
 ```
 
 #### Default values in template strings
 
-In a template you can add a default value for a placholder by adding `%default value` to it. For example, `%%project%Default Project%%` will set the placeholder to `Default Project` if the variable value matches the default value in the configuration. This allows you to accept the default on the command line but have a different value inserted in the template. To use another variable in its place, use `$KEY` in the placeholder, e.g. `%%project%$title%%` will replace the `project` key with the value of `title` if the default is selected. Modifiers can be used on either side of the `%`, e.g. `%%project%$title:snake%%`.
+In a template you can add a default value for a placholder by adding `%default value` to it. For example, `%%project%Default Project%%` will set the placeholder to `Default Project` if the variable value matches the default value in the configuration (or doesn't exist). This allows you to accept the default on the command line but have a different value inserted in the template. To use another variable in its place, use `$KEY` in the placeholder, e.g. `%%project%$title%%` will replace the `project` key with the value of `title` if the default is selected. Modifiers can be used on either side of the `%`, e.g. `%%project%$title:snake%%`.
 
 #### Multiple choice type
 
 If the `type` is set to `choice`, then the key `choices` can contain a hash or array of choices. The key that accepts the choice should be surrounded with parenthesis (required for each choice).
 
-If a Hash is defined, each choice can have a result string:
+If a Hash/Dictionary is defined, each choice can have a result string:
 
 ```yaml
 variables:
@@ -89,7 +90,9 @@ variables:
       (z)sh: "#! /bin/zsh"
 ```
 
-If an array is defined, the string of the choice will also be its result:
+When a choice is selected from a dictionary, the result string will be inserted instead of the choice title.
+
+If an array is defined, the string of the choice will also be its result (minus any parenthesis):
 
 ```yaml
 variables:
@@ -105,7 +108,7 @@ variables:
       - 1. zsh
 ```
 
-If the choice starts with a number (as above), then a numeric list will be generated and typing the associated index number will accept that choice. Numeric lists are automatically numbered, so the preceding digit doesn't matter, as long as it's a digit. In this case a default can be defined with an integer for its placement in the list (starting with 1), and parenthesis aren't required.
+If the choice starts with a number (as above), then a numeric list will be generated and typing the associated index number will accept that choice. Numeric lists are automatically numbered, so the preceding digit doesn't matter, as long as it's a digit. In this case a default can be defined with an integer (in the `defaults:` key) for its placement in the list (starting with 1), and parenthesis aren't required.
 
 #### If/then logic
 
@@ -201,7 +204,7 @@ If `preserve_tags` is set to `true` in the config (either base or template), the
 The executable for Planter is `plant`. You can run `plant TEMPLATE` in any directory and TEMPLATE will be planted in the current directory. You can also use `--in PATH` to plant in another directory.
 
 ```
-Usage: planter [options] TEMPLATE
+Usage: plant [options] TEMPLATE
     --defaults                       Accept default values for all variables
     -i, --in TARGET                  Plant in TARGET instead of current directory
     -o, --overwrite                  Overwrite existing files

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planter-cli
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Brett Terpstra