bashly 1.2.8 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0ea93f1ae2d4de7347c78c66eded0c3af9a815e444efbe6450292d5808e1cd
-  data.tar.gz: f301168efb623543d51e26e433ac0935e874e1d70b5b59e9c0300e451e3e4fdd
+  metadata.gz: 835cd138c47f6519a1fc6ca21c5dfc4b3a9b276e8ea8d082104d7206cc1ed75e
+  data.tar.gz: 8688035834ceb891b28cc6b22f6f9a9a215332a674e5f900e89339862e49d993
 SHA512:
-  metadata.gz: 9ebcf92ca566a54989af2fdf2f2ba6e59d87972fc3e958cfd280205b831a77fc27fd9c2a18c2f5b3f89d7e36754a0981b84c400214f8653bfc9dd79d099e8fe7
-  data.tar.gz: 82a22bd78ed9e19d3efc2d519da526943ec38a4c4cd0456779d2bde1fc452f007fe9363a1e9fc44753d6724df0a0a1ddd615fbeebc00504846cbe6171e8934d8
+  metadata.gz: b01a2ece1903bafb37e2dcf8fd28797272ec99e226484e34bf8a4927aa9368cef31a6f21a89cc51b807d5ba3da53eaaf83fb0683a929a5e43de07899334e82c6
+  data.tar.gz: 47a1aa8c24dba99340d98f3f348b1aa24b4c2907ba6ffd37968ce6b4aa54c74dca75057397d1ba58c73934e49b63aad20a3f62b3d1e228af903fe90a8ddf6f97

data/README.md

@@ -9,7 +9,7 @@ Create feature-rich bash scripts using simple YAML configuration
 [![Build Status](https://github.com/DannyBen/bashly/workflows/Test/badge.svg)](https://github.com/DannyBen/bashly/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/8cf89047e50ca601e431/maintainability)](https://codeclimate.com/github/DannyBen/bashly/maintainability)
 
-## [bashly.dannyb.co](https://bashly.dannyb.co)
+## [bashly.dev](https://bashly.dev)
 
 ---
 
@@ -76,6 +76,6 @@ Visit the *[How to contribute][contributing]* page for more information.
 
 [issues]: https://github.com/DannyBen/bashly/issues
 [discussions]: https://github.com/DannyBen/bashly/discussions
-[docs]: https://bashly.dannyb.co/
+[docs]: https://bashly.dev/
 [examples]: https://github.com/DannyBen/bashly/tree/master/examples#bashly-examples
 [contributing]: https://github.com/DannyBen/bashly/blob/master/CONTRIBUTING.md#how-to-contribute

data/lib/bashly/cli.rb

@@ -7,7 +7,7 @@ module Bashly
     def self.runner
       runner = MisterBin::Runner.new version: Bashly::VERSION,
         header: 'Bashly - Bash CLI Generator',
-        footer: "Help: m`bashly COMMAND --help`\nDocs: bu`https://bashly.dannyb.co`"
+        footer: "Help: m`bashly COMMAND --help`\nDocs: bu`https://bashly.dev`"
 
       runner.route 'init',             to: Commands::Init
       runner.route 'preview',          to: Commands::Preview

data/lib/bashly/commands/add.rb

@@ -3,7 +3,7 @@ module Bashly
     class Add < Base
       help 'Add extra features and customization to your script'
 
-      usage 'bashly add [--source NAME] LIBRARY [ARGS...] [--force]'
+      usage 'bashly add [--source NAME] LIBRARY [ARGS...] [--force --quiet]'
       usage 'bashly add [--source NAME] --list'
       usage 'bashly add (-h|--help)'
 
@@ -17,6 +17,7 @@ module Bashly
       USAGE
       option '-f --force', 'Overwrite existing files'
       option '-l --list', 'Show available libraries'
+      option '-q --quiet', 'Do not show post-install messages'
 
       attr_reader :skip_src_check
 
@@ -70,7 +71,9 @@ module Bashly
         end
 
         message = library.post_install_message
-        say "\n#{message}" if message && files_created.positive?
+        return if !message || files_created.zero? || args['--quiet']
+
+        say "\n#{message}"
       end
 
       def safe_write(path, content)

data/lib/bashly/docs/arg.yml

@@ -1,6 +1,6 @@
 arg:
   help: Define positional arguments.
-  url: https://bashly.dannyb.co/configuration/argument/
+  url: https://bashly.dev/configuration/argument/
   example: |-
     args:
     - name: user
@@ -16,7 +16,7 @@ arg:
 
 arg.allowed:
   help: Specify a list of allowed values. Can be used in conjunction with `default` and `required`.
-  url: https://bashly.dannyb.co/configuration/argument/#allowed
+  url: https://bashly.dev/configuration/argument/#allowed
   example: |-
     args:
     - name: region
@@ -35,7 +35,7 @@ arg.allowed:
 
 arg.default:
   help: Specify the value to apply when not provided by the user.
-  url: https://bashly.dannyb.co/configuration/argument/#default
+  url: https://bashly.dev/configuration/argument/#default
   example: |-
     args:
     - name: images
@@ -44,7 +44,7 @@ arg.default:
 
 arg.help:
   help: Specify the help message for this argument.
-  url: https://bashly.dannyb.co/configuration/argument/#help
+  url: https://bashly.dev/configuration/argument/#help
   example: |-
     args:
     - name: user
@@ -53,7 +53,7 @@ arg.help:
 
 arg.name:
   help: Specify the lowercase name of the argument.
-  url: https://bashly.dannyb.co/configuration/argument/#name
+  url: https://bashly.dev/configuration/argument/#name
   example: |-
     args:
     - name: user
@@ -67,7 +67,7 @@ arg.repeatable:
     The argument below will be received as a space-delimited string which needs to be converted to an array with:
     `eval "data=(${args[file]})"`
 
-  url: https://bashly.dannyb.co/configuration/argument/#repeatable
+  url: https://bashly.dev/configuration/argument/#repeatable
   example: |-
     args:
     - name: file
@@ -77,7 +77,7 @@ arg.repeatable:
 
 arg.required:
   help: Specify that this argument is required.
-  url: https://bashly.dannyb.co/configuration/argument/#required
+  url: https://bashly.dev/configuration/argument/#required
   example: |-
     args:
     - name: region
@@ -87,7 +87,7 @@ arg.required:
 arg.validate:
   help: Apply custom validation functions.
 
-  url: https://bashly.dannyb.co/configuration/argument/#validate
+  url: https://bashly.dev/configuration/argument/#validate
   example: |-
     args:
     - name: path

data/lib/bashly/docs/command.yml

@@ -1,6 +1,6 @@
 command:
   help: Define the root command, or any sub-command.
-  url: https://bashly.dannyb.co/configuration/command/
+  url: https://bashly.dev/configuration/command/
   example: |-
     name: rush
     help: Personal package manager
@@ -17,7 +17,7 @@ command:
 
 command.alias:
   help: Specify one or more aliases for this sub-command.
-  url: https://bashly.dannyb.co/configuration/command/#alias
+  url: https://bashly.dev/configuration/command/#alias
   example: |-
     # Define a single alias
     command:
@@ -36,7 +36,7 @@ command.alias:
 
 command.args:
   help: Define a list of positional arguments. See `arg` for reference.
-  url: https://bashly.dannyb.co/configuration/command/#args
+  url: https://bashly.dev/configuration/command/#args
   example: |-
     args:
     - name: repo
@@ -45,7 +45,7 @@ command.args:
 
 command.catch_all:
   help: Specify that this command should allow for additional arbitrary arguments or flags.
-  url: https://bashly.dannyb.co/configuration/command/#catch_all
+  url: https://bashly.dev/configuration/command/#catch_all
   example: |-
     commands:
     - name: download
@@ -67,7 +67,7 @@ command.catch_all:
 
 command.commands:
   help: Define a list of sub-commands. See `command` for reference.
-  url: https://bashly.dannyb.co/configuration/command/#commands
+  url: https://bashly.dev/configuration/command/#commands
   example: |-
     commands:
     - name: add
@@ -76,7 +76,7 @@ command.commands:
 
 command.completions:
   help: Specify a list of additional completion suggestions when used in conjunction with `bashly add completions`.
-  url: https://bashly.dannyb.co/configuration/command/#completions
+  url: https://bashly.dev/configuration/command/#completions
   example: |-
     commands:
     - name: view
@@ -88,7 +88,7 @@ command.completions:
 
 command.default:
   help: Specify that this sub-command will be executed implicitly.
-  url: https://bashly.dannyb.co/configuration/command/#default
+  url: https://bashly.dev/configuration/command/#default
   example: |-
     # This command will execute when the command line is not
     # recognized.
@@ -106,7 +106,7 @@ command.default:
 
 command.dependencies:
   help: Specify a list of required external commands that are needed to run this command.
-  url: https://bashly.dannyb.co/configuration/command/#dependencies
+  url: https://bashly.dev/configuration/command/#dependencies
   example: |-
     # Array syntax
     dependencies:
@@ -128,7 +128,7 @@ command.dependencies:
   
 command.environment_variables:
   help: Define a list of environment variables. See `environment_variable` for reference.
-  url: https://bashly.dannyb.co/configuration/command/#environment_variables
+  url: https://bashly.dev/configuration/command/#environment_variables
   example: |-
     environment_variables:
     - name: config_path
@@ -140,7 +140,7 @@ command.environment_variables:
 
 command.examples:
   help: Define one or more example messages. 
-  url: https://bashly.dannyb.co/configuration/command/#examples
+  url: https://bashly.dev/configuration/command/#examples
   example: |-
     # Use an array of examples for simple one-liners.
     examples:
@@ -159,7 +159,7 @@ command.examples:
 
 command.expose:
   help: Specify that the sub-commands of this command should be visible when showing the usage of its parent.
-  url: https://bashly.dannyb.co/configuration/command/#expose
+  url: https://bashly.dev/configuration/command/#expose
   example: |-
     name: cli
     commands:
@@ -190,7 +190,7 @@ command.expose:
 
 command.extensible:
   help: Specify that this command can be extended by external means.
-  url: https://bashly.dannyb.co/configuration/command/#extensible
+  url: https://bashly.dev/configuration/command/#extensible
   example: |-
     name: mygit
     help: Wrapper for git
@@ -206,7 +206,7 @@ command.extensible:
 
 command.filename:
   help: Specify the path (relative to src) to the partial source code file.
-  url: https://bashly.dannyb.co/configuration/command/#filename
+  url: https://bashly.dev/configuration/command/#filename
   example: |-
     commands:
     - name: connect
@@ -215,7 +215,7 @@ command.filename:
 
 command.filters:
   help: Specify a list of custom filter functions that will prevent the command from running unless certain conditions are met.
-  url: https://bashly.dannyb.co/configuration/command/#filters
+  url: https://bashly.dev/configuration/command/#filters
   example: |-
     commands:
     - name: container
@@ -235,7 +235,7 @@ command.filters:
 
 command.flags:
   help: Define a list of option flags. See `flag` for reference.
-  url: https://bashly.dannyb.co/configuration/command/#flags
+  url: https://bashly.dev/configuration/command/#flags
   example: |-
     flags:
     - long: --purge
@@ -244,13 +244,13 @@ command.flags:
 
 command.footer:
   help: Specify a message to show at the bottom of the help text.
-  url: https://bashly.dannyb.co/configuration/command/#footer
+  url: https://bashly.dev/configuration/command/#footer
   example: |-
     footer: For further help visit https://my.docs-site.com
 
 command.function:
   help: Specify a different base function name for this command.
-  url: https://bashly.dannyb.co/configuration/command/#function
+  url: https://bashly.dev/configuration/command/#function
   example: |-
     commands:
     - name: container-start
@@ -271,7 +271,7 @@ command.function:
 
 command.group:
   help: Specify the group that this command belongs to.
-  url: https://bashly.dannyb.co/configuration/command/#group
+  url: https://bashly.dev/configuration/command/#group
   example: |-
     command:
       name: start
@@ -280,7 +280,7 @@ command.group:
 
 command.help:
   help: Specify the help text to show when displaying usage.
-  url: https://bashly.dannyb.co/configuration/command/#help
+  url: https://bashly.dev/configuration/command/#help
   example: |-
     name: docker
     help: Runtime for containers
@@ -291,7 +291,7 @@ command.help:
 
 command.name:
   help: Specify the name of the command. This option is required.
-  url: https://bashly.dannyb.co/configuration/command/#name
+  url: https://bashly.dev/configuration/command/#name
   example: |-
     name: docker
     help: Runtime for containers
@@ -302,7 +302,7 @@ command.name:
 
 command.private:
   help: Specify that this command should not be displayed in the help text.
-  url: https://bashly.dannyb.co/configuration/command/#private
+  url: https://bashly.dev/configuration/command/#private
   example: |-
     commands:
     - name: completions
@@ -311,7 +311,7 @@ command.private:
 
 command.variables:
   help: Define a list of global bash variables. See `variable` for reference.
-  url: https://bashly.dannyb.co/configuration/command/#variables
+  url: https://bashly.dev/configuration/command/#variables
   example: |-
     variables:
     # Simple value
@@ -332,7 +332,7 @@ command.variables:
 
 command.version:
   help: Specify the version to show when running with `--version`.
-  url: https://bashly.dannyb.co/configuration/command/#version
+  url: https://bashly.dev/configuration/command/#version
   example: |-
     name: rush
     help: Personal package manager

data/lib/bashly/docs/env.yml

@@ -1,6 +1,6 @@
 environment_variable:
   help: Define environment variables that will be in use in your script.
-  url: https://bashly.dannyb.co/configuration/environment-variable/
+  url: https://bashly.dev/configuration/environment-variable/
   example: |-
     environment_variables:
     - name: config_path
@@ -12,7 +12,7 @@ environment_variable:
 
 environment_variable.default:
   help: Specify the value to apply when not provided by the user.
-  url: https://bashly.dannyb.co/configuration/environment-variable/#default
+  url: https://bashly.dev/configuration/environment-variable/#default
   example: |-
     environment_variables:
     - name: config_path
@@ -21,7 +21,7 @@ environment_variable.default:
 
 environment_variable.help:
   help: Specify the help message for this variable.
-  url: https://bashly.dannyb.co/configuration/environment-variable/#help
+  url: https://bashly.dev/configuration/environment-variable/#help
   example: |-
     environment_variables:
     - name: api_key
@@ -29,7 +29,7 @@ environment_variable.help:
 
 environment_variable.name:
   help: Specify the lowercase name of the variable.
-  url: https://bashly.dannyb.co/configuration/environment-variable/#name
+  url: https://bashly.dev/configuration/environment-variable/#name
   example: |-
     environment_variables:
     - name: api_key
@@ -37,7 +37,7 @@ environment_variable.name:
 
 environment_variable.private:
   help: Specify that this environment variable should not be advertised in the usage text.
-  url: https://bashly.dannyb.co/configuration/environment-variable/#private
+  url: https://bashly.dev/configuration/environment-variable/#private
   example: |-
     environment_variables:
     - name: editor
@@ -47,7 +47,7 @@ environment_variable.private:
 
 environment_variable.required:
   help: Specify that this variable is required.
-  url: https://bashly.dannyb.co/configuration/environment-variable/#required
+  url: https://bashly.dev/configuration/environment-variable/#required
   example: |-
     environment_variables:
     - name: api_key
@@ -57,7 +57,7 @@ environment_variable.required:
 environment_variable.validate:
   help: Apply custom validation functions.
 
-  url: https://bashly.dannyb.co/configuration/environment-variable/#validate
+  url: https://bashly.dev/configuration/environment-variable/#validate
   example: |-
     environment_variables:
     - name: build_dir

data/lib/bashly/docs/flag.yml

@@ -1,6 +1,6 @@
 flag:
   help: Define option flags.
-  url: https://bashly.dannyb.co/configuration/flag/
+  url: https://bashly.dev/configuration/flag/
   example: |-
     flags:
     - long: --ssh
@@ -15,7 +15,7 @@ flag:
 
 flag.allowed:
   help: Specify a list of allowed values. Can be used in conjunction with `default` and `required`, and must be accompanied by `arg`.
-  url: https://bashly.dannyb.co/configuration/flag/#allowed
+  url: https://bashly.dev/configuration/flag/#allowed
   example: |-
     flags:
     - long: --user
@@ -38,7 +38,7 @@ flag.allowed:
 
 flag.arg:
   help: Specify the name of the argument for this flag, in case it requires any.
-  url: https://bashly.dannyb.co/configuration/flag/#arg
+  url: https://bashly.dev/configuration/flag/#arg
   example: |-
     flags:
     - long: --user
@@ -48,7 +48,7 @@ flag.arg:
 
 flag.completions:
   help: Specify a list of additional completion suggestions when used in conjunction with `bashly add completions`. Must be accompanied by `arg`.
-  url: https://bashly.dannyb.co/configuration/flag/#completions
+  url: https://bashly.dev/configuration/flag/#completions
   example: |-
     flags:
     - long: --user
@@ -65,7 +65,7 @@ flag.completions:
 
 flag.conflicts:
   help: Specify that this flag is mutually exclusive with one or more other flags. Use the long name of these conflicting flags.
-  url: https://bashly.dannyb.co/configuration/flag/#conflicts
+  url: https://bashly.dev/configuration/flag/#conflicts
   example: |-
     flags:
     - long: --cache
@@ -88,7 +88,7 @@ flag.conflicts:
 
 flag.default:
   help: Specify the value to apply when not provided by the user.
-  url: https://bashly.dannyb.co/configuration/flag/#default
+  url: https://bashly.dev/configuration/flag/#default
   example: |-
     flags:
     - long: --environment
@@ -98,7 +98,7 @@ flag.default:
 
 flag.help:
   help: Specify the help message for this flag.
-  url: https://bashly.dannyb.co/configuration/flag/#help
+  url: https://bashly.dev/configuration/flag/#help
   example: |-
     flags:
     - long: --cache
@@ -106,7 +106,7 @@ flag.help:
 
 flag.long:
   help: Specify the long form of the flag, including the -- prefix. Either `long` or `short` is required.
-  url: https://bashly.dannyb.co/configuration/flag/#long
+  url: https://bashly.dev/configuration/flag/#long
   example: |-
     flags:
     - long: --ssh
@@ -115,7 +115,7 @@ flag.long:
 
 flag.needs:
   help: Specify that this flag needs one or more additional flags. Use the long name of these needed flags.
-  url: https://bashly.dannyb.co/configuration/flag/#needs
+  url: https://bashly.dev/configuration/flag/#needs
   example: |-
     flags:
     - long: --add
@@ -138,7 +138,7 @@ flag.needs:
 
 flag.private:
   help: Specify that this flag should not be displayed in the help text.
-  url: https://bashly.dannyb.co/configuration/flag/#private
+  url: https://bashly.dev/configuration/flag/#private
   example: |-
     flags:
     - long: --legacy
@@ -151,7 +151,7 @@ flag.repeatable:
     Specify that this flag can be provided multiple times. When used on a flag with an argument, it will be received as a space-delimited string, which needs to be converted to an array with:
     `eval "data=(${args[--data]})"`
 
-  url: https://bashly.dannyb.co/configuration/flag/#repeatable
+  url: https://bashly.dev/configuration/flag/#repeatable
   example: |-
     flags:
     - long: --data
@@ -168,7 +168,7 @@ flag.repeatable:
 
 flag.required:
   help: Specify that this flag is required.
-  url: https://bashly.dannyb.co/configuration/flag/#required
+  url: https://bashly.dev/configuration/flag/#required
   example: |-
     args:
     - long: --user
@@ -178,7 +178,7 @@ flag.required:
 
 flag.short:
   help: Specify the short form of the flag, including the - prefix. Either `long` or `short` is required.
-  url: https://bashly.dannyb.co/configuration/flag/#short
+  url: https://bashly.dev/configuration/flag/#short
   example: |-
     - long: --user
       short: -u
@@ -187,7 +187,7 @@ flag.short:
 
 flag.unique:
   help: Specify that the arguments provided by this repeatable flag must be unique. When this is set to `true`, non-unique values will be ignored.
-  url: https://bashly.dannyb.co/configuration/flag/#unique
+  url: https://bashly.dev/configuration/flag/#unique
   example: |-
     flags:
     - long: --path
@@ -199,7 +199,7 @@ flag.unique:
 flag.validate:
   help: Apply custom validation functions. Must be accompanied by `arg`.
 
-  url: https://bashly.dannyb.co/configuration/flag/#validate
+  url: https://bashly.dev/configuration/flag/#validate
   example: |-
    flags:
    - long: --config

data/lib/bashly/docs/var.yml

@@ -1,6 +1,6 @@
 variable:
   help: Define variables that will be available to your script.
-  url: https://bashly.dannyb.co/configuration/variable/
+  url: https://bashly.dev/configuration/variable/
   example: |-
     variables:
     # Simple value
@@ -21,7 +21,7 @@ variable:
 
 variable.name:
   help: Specify the name of the variable.
-  url: https://bashly.dannyb.co/configuration/variable/#name
+  url: https://bashly.dev/configuration/variable/#name
   example: |-
     variables:
     - name: output_folder
@@ -31,7 +31,7 @@ variable.value:
   help: |-
     Specify the value for this variable.
     This can be any value type, including array and hash (associative array).
-  url: https://bashly.dannyb.co/configuration/variable/#value
+  url: https://bashly.dev/configuration/variable/#value
   example: |-
     variables:
     # Simple value

data/lib/bashly/libraries/colors/colors.sh

@@ -10,10 +10,21 @@
 ## Color output will be disabled if `NO_COLOR` environment variable is set
 ## in compliance with https://no-color.org/
 ##
+## In case you wish to enable auto detection for color output based on the
+## terminal being interactive (TTY), call `enable_auto_colors` in your 
+## `src/initialize.sh` (Run `bashly add hooks` to add this file).
+##
+enable_auto_colors() {
+  ## If NO_COLOR has not been set and stdout is not a TTY, disable colors
+  if [[ -z ${NO_COLOR+x} && ! -t 1 ]]; then
+    NO_COLOR=1
+  fi
+}
+
 print_in_color() {
   local color="$1"
   shift
-  if [[ -z ${NO_COLOR+x} ]]; then
+  if [[ "${NO_COLOR:-}" == "" ]]; then
     printf "$color%b\e[0m\n" "$*"
   else
     printf "%b\n" "$*"

data/lib/bashly/libraries/libraries.yml

@@ -3,6 +3,14 @@ colors:
   files:
     - source: "colors/colors.sh"
       target: "%{user_lib_dir}/colors.%{user_ext}"
+  post_install_message: |
+    The colors library supports the g`NO_COLOR` standard out of the box.
+
+    In case you wish to also enable automatic output of colors based on the
+    terminal being interactive (TTY), call g`enable_auto_colors` in your 
+    g`src/initialize.sh`. You may run the following command to add this file:
+
+      m`$ bashly add hooks`
 
 completions: 
   help: Generate a bash completions function.

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.2.8'
+  VERSION = '1.2.9'
 end

data/lib/bashly/views/wrapper/header.gtx

@@ -1,6 +1,6 @@
 > #!/usr/bin/env bash
 if Settings.enabled? :header_comment
-  > # This script was generated by bashly {{ Bashly::VERSION }} (https://bashly.dannyb.co)
+  > # This script was generated by bashly {{ Bashly::VERSION }} (https://bashly.dev)
   > # Modifying it manually is not recommended
 end
 > 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
 platform: ruby
 authors:
 - Danny Ben Shitrit
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -345,7 +345,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/DannyBen/bashly/issues
   changelog_uri: https://github.com/DannyBen/bashly/blob/master/CHANGELOG.md
-  homepage_uri: https://bashly.dannyb.co/
+  homepage_uri: https://bashly.dev/
   source_code_uri: https://github.com/DannyBen/bashly
   rubygems_mfa_required: 'true'
 rdoc_options: []