Skip to content

Add support for per-environment settings#668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DannyBen merged 2 commits into from
Aug 31, 2025
Merged

Add support for per-environment settings #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
522d2b8
- Add support for per-environment settings
DannyBen Aug 30, 2025
110450d
fix settings env var priority
DannyBen Aug 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .rubocop.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ RSpec/SpecFilePathFormat:
- 'spec/bashly/concerns/completions_command_spec.rb'
- 'spec/bashly/concerns/completions_flag_spec.rb'

# Allow longer integration examples as they are more complex by nature
# Allow longer examples in some cases
RSpec/ExampleLength:
Exclude:
- 'spec/bashly/integration/**/*'
- 'spec/bashly/libraries/render*'
- 'spec/bashly/script/command_spec.rb'
55 changes: 41 additions & 14 deletions lib/bashly/libraries/settings/settings.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
# All settings are optional (with their default values provided below), and
# can also be set with an environment variable with the same name, capitalized
# and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
#-------------------------------------------------------------------------------
# BASHLY SETTINGS
#-------------------------------------------------------------------------------
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
### Default Values
#
# All settings are optional, with their default values provided below
#
### Environment Variables
#
# Values can also be set using an environment variable with the same name,
# capitalized and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR`
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
#
# Environment variables take precedence over values in the config file.
#
### File Location:
#
# Bashly looks for the settings file in these locations.
# - The path defined in the `BASHLY_SETTINGS_PATH` environment variable.
# - A file named `bashly-settings.yml` in the working directory.
# - A file named `settings.yml` in the working directory.
#
### Environment Overrides:
#
# All options (except `env`) may be specified with an environment suffix in
# order to override its value for a given environment.
#
# For example, when defining `formatter_production: shfmt --minify`, then
# this will be the formatter used when generating the script with
# `bashly generate --env production`
#
# Since these values take precedence over the standard values, you can define
# both (i.e. `formatter: shfmt` and `formatter_production: shfmt --minify`).
#
# If you wish to change the path to this file, set the environment variable
# BASHLY_SETTINGS_PATH.


#-------------------------------------------------------------------------------
# PATH OPTIONS
Expand DownExpand Up@@ -52,12 +79,12 @@ strict: false
tab_indent: false

# Choose a post-processor for the generated script:
# formatter: internal # Use Bashly's internal formatter (compacts newlines)
# formatter: internal # Use Bashly’s built-in formatter (removes extra newlines)
# formatter: external # Run the external command `shfmt --case-indent --indent 2`
# formatter: none # Disable formatting entirely
# formatter: <string> # Use a custom shell command to format the script.
# # The command will receive the script via stdin and
# # must output the result to stdout.
# formatter: <string> # Provide a custom shell command to format the script.
# # The command receives the script via stdin and must
# # write the result to stdout.
# # Example: shfmt --minify
formatter: internal

Expand DownExpand Up@@ -102,7 +129,7 @@ usage_colors:
#-------------------------------------------------------------------------------

# Set to 'production' or 'development'.
# Determines which features are enabled in the rendered script.
# Determines which features are enabled in the generated script.
# Use the `enable_*` options below to adjust settings for each environment.
# It is recommended to leave this set to 'development' and run
# `bashly generate --env production` when the production version is needed.
Expand Down
27 changes: 19 additions & 8 deletions lib/bashly/settings.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -160,16 +160,27 @@ def var_aliases
private

def get(key)
case env_value key
when nil then config[key.to_s]
when '0', 'false', 'no' then false
when '1', 'true', 'yes' then true
else env_value key
end
ENV.has_key?(env_var_name(key)) ? value_from_env(key) : value_from_config(key)
Comment thread
DannyBen marked this conversation as resolved.
end

def env_var_name(key)
"BASHLY_#{key.upcase}"
end

def env_value(key)
ENV["BASHLY_#{key.upcase}"]
def value_from_config(key)
return config[key.to_s] if key == :env

result = config["#{key}_#{env}"]
result.nil? ? config[key.to_s] : result
end

def value_from_env(key)
result = ENV[env_var_name(key)]
case result&.strip&.downcase
Comment thread
DannyBen marked this conversation as resolved.
when '0', 'false', 'no' then false
when '1', 'true', 'yes' then true
else result
end
end

def config
Expand Down
21 changes: 21 additions & 0 deletions spec/bashly/settings_spec.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,27 @@
expect(subject.tab_indent).to eq ENV['BASHLY_TAB_INDENT']
end
end

context 'when using env suffix overrides' do
before do
reset_tmp_dir
File.write 'spec/tmp/settings.yml', 'formatter_production: shfmt --minify'
subject.formatter = nil
end

it 'returns the default value when it is not the specified environment' do
Dir.chdir 'spec/tmp' do
expect(subject.formatter).to eq 'internal'
end
end

it 'returns the config value when it is the specified environment' do
Dir.chdir 'spec/tmp' do
subject.env = :production
expect(subject.formatter).to eq 'shfmt --minify'
end
end
end
end

describe '::env' do
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add support for per-environment settings by DannyBen · Pull Request #668 · bashly-framework/bashly · GitHub
Skip to content
Add support for per-environment settings#668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 2 commits into

from

Aug 31, 2025
 Merged


Add support for per-environment settings
#668
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
522d2b8

- Add support for per-environment settings


DannyBen Aug 30, 2025
110450d

fix settings env var priority


DannyBen Aug 30, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.rubocop.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ RSpec/SpecFilePathFormat:
 - 'spec/bashly/concerns/completions_command_spec.rb'
 - 'spec/bashly/concerns/completions_flag_spec.rb'

# Allow longer integration examples as they are more complex by nature
# Allow longer examples in some cases
RSpec/ExampleLength:
 Exclude:
 - 'spec/bashly/integration/**/*'
 - 'spec/bashly/libraries/render*'
 - 'spec/bashly/script/command_spec.rb'

55 changes: 41 additions & 14 deletions
lib/bashly/libraries/settings/settings.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
# All settings are optional (with their default values provided below), and
# can also be set with an environment variable with the same name, capitalized
# and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
#-------------------------------------------------------------------------------
# BASHLY SETTINGS
#-------------------------------------------------------------------------------
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
### Default Values
#
# All settings are optional, with their default values provided below
#
### Environment Variables
#
# Values can also be set using an environment variable with the same name,
# capitalized and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR`
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
#
# Environment variables take precedence over values in the config file.
#
### File Location:
#
# Bashly looks for the settings file in these locations.
# - The path defined in the `BASHLY_SETTINGS_PATH` environment variable.
# - A file named `bashly-settings.yml` in the working directory.
# - A file named `settings.yml` in the working directory.
#
### Environment Overrides:
#
# All options (except `env`) may be specified with an environment suffix in 
# order to override its value for a given environment.
#
# For example, when defining `formatter_production: shfmt --minify`, then 
# this will be the formatter used when generating the script with
# `bashly generate --env production`
#
# Since these values take precedence over the standard values, you can define
# both (i.e. `formatter: shfmt` and `formatter_production: shfmt --minify`).
#
# If you wish to change the path to this file, set the environment variable
# BASHLY_SETTINGS_PATH.


#-------------------------------------------------------------------------------
# PATH OPTIONS
Expand DownExpand Up@@ -52,12 +79,12 @@ strict: false
tab_indent: false

# Choose a post-processor for the generated script:
# formatter: internal # Use Bashly's internal formatter (compacts newlines)
# formatter: internal # Use Bashly’s built-in formatter (removes extra newlines)
# formatter: external # Run the external command `shfmt --case-indent --indent 2`
# formatter: none # Disable formatting entirely
# formatter: <string> # Use a custom shell command to format the script.
# # The command will receive the script via stdin and
# # must output the result to stdout.
# formatter: <string> # Provide a custom shell command to format the script.
# # The command receives the script via stdin and must
# # write the result to stdout.
# # Example: shfmt --minify
formatter: internal

Expand DownExpand Up@@ -102,7 +129,7 @@ usage_colors:
#-------------------------------------------------------------------------------

# Set to 'production' or 'development'.
# Determines which features are enabled in the rendered script.
# Determines which features are enabled in the generated script.
# Use the `enable_*` options below to adjust settings for each environment.
# It is recommended to leave this set to 'development' and run
# `bashly generate --env production` when the production version is needed.
Expand Down

27 changes: 19 additions & 8 deletions
lib/bashly/settings.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,16 +160,27 @@ def var_aliases
 private

 def get(key)
 case env_value key
 when nil then config[key.to_s]
 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else env_value key
 end
 ENV.has_key?(env_var_name(key)) ? value_from_env(key) : value_from_config(key)
Comment thread
DannyBen marked this conversation as resolved.

 end

 def env_var_name(key)
 "BASHLY_#{key.upcase}"
 end

 def env_value(key)
 ENV["BASHLY_#{key.upcase}"]
 def value_from_config(key)
 return config[key.to_s] if key == :env

 result = config["#{key}_#{env}"]
 result.nil? ? config[key.to_s] : result
 end

 def value_from_env(key)
 result = ENV[env_var_name(key)]
 case result&.strip&.downcase
Comment thread
DannyBen marked this conversation as resolved.

 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else result
 end
 end

 def config
Expand Down

21 changes: 21 additions & 0 deletions
spec/bashly/settings_spec.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,27 @@
 expect(subject.tab_indent).to eq ENV['BASHLY_TAB_INDENT']
 end
 end

 context 'when using env suffix overrides' do
 before do
 reset_tmp_dir
 File.write 'spec/tmp/settings.yml', 'formatter_production: shfmt --minify'
 subject.formatter = nil
 end

 it 'returns the default value when it is not the specified environment' do
 Dir.chdir 'spec/tmp' do
 expect(subject.formatter).to eq 'internal'
 end
 end

 it 'returns the config value when it is the specified environment' do
 Dir.chdir 'spec/tmp' do
 subject.env = :production
 expect(subject.formatter).to eq 'shfmt --minify'
 end
 end
 end
 end

 describe '::env' do
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for per-environment settings by DannyBen · Pull Request #668 · bashly-framework/bashly · GitHub
Skip to content
Add support for per-environment settings#668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 2 commits into

from

Aug 31, 2025
 Merged


Add support for per-environment settings
#668
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
522d2b8

- Add support for per-environment settings


DannyBen Aug 30, 2025
110450d

fix settings env var priority


DannyBen Aug 30, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.rubocop.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ RSpec/SpecFilePathFormat:
 - 'spec/bashly/concerns/completions_command_spec.rb'
 - 'spec/bashly/concerns/completions_flag_spec.rb'

# Allow longer integration examples as they are more complex by nature
# Allow longer examples in some cases
RSpec/ExampleLength:
 Exclude:
 - 'spec/bashly/integration/**/*'
 - 'spec/bashly/libraries/render*'
 - 'spec/bashly/script/command_spec.rb'

55 changes: 41 additions & 14 deletions
lib/bashly/libraries/settings/settings.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
# All settings are optional (with their default values provided below), and
# can also be set with an environment variable with the same name, capitalized
# and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
#-------------------------------------------------------------------------------
# BASHLY SETTINGS
#-------------------------------------------------------------------------------
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
### Default Values
#
# All settings are optional, with their default values provided below
#
### Environment Variables
#
# Values can also be set using an environment variable with the same name,
# capitalized and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR`
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
#
# Environment variables take precedence over values in the config file.
#
### File Location:
#
# Bashly looks for the settings file in these locations.
# - The path defined in the `BASHLY_SETTINGS_PATH` environment variable.
# - A file named `bashly-settings.yml` in the working directory.
# - A file named `settings.yml` in the working directory.
#
### Environment Overrides:
#
# All options (except `env`) may be specified with an environment suffix in 
# order to override its value for a given environment.
#
# For example, when defining `formatter_production: shfmt --minify`, then 
# this will be the formatter used when generating the script with
# `bashly generate --env production`
#
# Since these values take precedence over the standard values, you can define
# both (i.e. `formatter: shfmt` and `formatter_production: shfmt --minify`).
#
# If you wish to change the path to this file, set the environment variable
# BASHLY_SETTINGS_PATH.


#-------------------------------------------------------------------------------
# PATH OPTIONS
Expand DownExpand Up@@ -52,12 +79,12 @@ strict: false
tab_indent: false

# Choose a post-processor for the generated script:
# formatter: internal # Use Bashly's internal formatter (compacts newlines)
# formatter: internal # Use Bashly’s built-in formatter (removes extra newlines)
# formatter: external # Run the external command `shfmt --case-indent --indent 2`
# formatter: none # Disable formatting entirely
# formatter: <string> # Use a custom shell command to format the script.
# # The command will receive the script via stdin and
# # must output the result to stdout.
# formatter: <string> # Provide a custom shell command to format the script.
# # The command receives the script via stdin and must
# # write the result to stdout.
# # Example: shfmt --minify
formatter: internal

Expand DownExpand Up@@ -102,7 +129,7 @@ usage_colors:
#-------------------------------------------------------------------------------

# Set to 'production' or 'development'.
# Determines which features are enabled in the rendered script.
# Determines which features are enabled in the generated script.
# Use the `enable_*` options below to adjust settings for each environment.
# It is recommended to leave this set to 'development' and run
# `bashly generate --env production` when the production version is needed.
Expand Down

27 changes: 19 additions & 8 deletions
lib/bashly/settings.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,16 +160,27 @@ def var_aliases
 private

 def get(key)
 case env_value key
 when nil then config[key.to_s]
 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else env_value key
 end
 ENV.has_key?(env_var_name(key)) ? value_from_env(key) : value_from_config(key)
Comment thread
DannyBen marked this conversation as resolved.

 end

 def env_var_name(key)
 "BASHLY_#{key.upcase}"
 end

 def env_value(key)
 ENV["BASHLY_#{key.upcase}"]
 def value_from_config(key)
 return config[key.to_s] if key == :env

 result = config["#{key}_#{env}"]
 result.nil? ? config[key.to_s] : result
 end

 def value_from_env(key)
 result = ENV[env_var_name(key)]
 case result&.strip&.downcase
Comment thread
DannyBen marked this conversation as resolved.

 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else result
 end
 end

 def config
Expand Down

21 changes: 21 additions & 0 deletions
spec/bashly/settings_spec.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,27 @@
 expect(subject.tab_indent).to eq ENV['BASHLY_TAB_INDENT']
 end
 end

 context 'when using env suffix overrides' do
 before do
 reset_tmp_dir
 File.write 'spec/tmp/settings.yml', 'formatter_production: shfmt --minify'
 subject.formatter = nil
 end

 it 'returns the default value when it is not the specified environment' do
 Dir.chdir 'spec/tmp' do
 expect(subject.formatter).to eq 'internal'
 end
 end

 it 'returns the config value when it is the specified environment' do
 Dir.chdir 'spec/tmp' do
 subject.env = :production
 expect(subject.formatter).to eq 'shfmt --minify'
 end
 end
 end
 end

 describe '::env' do
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for per-environment settings by DannyBen · Pull Request #668 · bashly-framework/bashly · GitHub
Skip to content
Add support for per-environment settings#668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 2 commits into

from

Aug 31, 2025
 Merged


Add support for per-environment settings
#668
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
522d2b8

- Add support for per-environment settings


DannyBen Aug 30, 2025
110450d

fix settings env var priority


DannyBen Aug 30, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.rubocop.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ RSpec/SpecFilePathFormat:
 - 'spec/bashly/concerns/completions_command_spec.rb'
 - 'spec/bashly/concerns/completions_flag_spec.rb'

# Allow longer integration examples as they are more complex by nature
# Allow longer examples in some cases
RSpec/ExampleLength:
 Exclude:
 - 'spec/bashly/integration/**/*'
 - 'spec/bashly/libraries/render*'
 - 'spec/bashly/script/command_spec.rb'

55 changes: 41 additions & 14 deletions
lib/bashly/libraries/settings/settings.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
# All settings are optional (with their default values provided below), and
# can also be set with an environment variable with the same name, capitalized
# and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
#-------------------------------------------------------------------------------
# BASHLY SETTINGS
#-------------------------------------------------------------------------------
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
### Default Values
#
# All settings are optional, with their default values provided below
#
### Environment Variables
#
# Values can also be set using an environment variable with the same name,
# capitalized and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR`
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
#
# Environment variables take precedence over values in the config file.
#
### File Location:
#
# Bashly looks for the settings file in these locations.
# - The path defined in the `BASHLY_SETTINGS_PATH` environment variable.
# - A file named `bashly-settings.yml` in the working directory.
# - A file named `settings.yml` in the working directory.
#
### Environment Overrides:
#
# All options (except `env`) may be specified with an environment suffix in 
# order to override its value for a given environment.
#
# For example, when defining `formatter_production: shfmt --minify`, then 
# this will be the formatter used when generating the script with
# `bashly generate --env production`
#
# Since these values take precedence over the standard values, you can define
# both (i.e. `formatter: shfmt` and `formatter_production: shfmt --minify`).
#
# If you wish to change the path to this file, set the environment variable
# BASHLY_SETTINGS_PATH.


#-------------------------------------------------------------------------------
# PATH OPTIONS
Expand DownExpand Up@@ -52,12 +79,12 @@ strict: false
tab_indent: false

# Choose a post-processor for the generated script:
# formatter: internal # Use Bashly's internal formatter (compacts newlines)
# formatter: internal # Use Bashly’s built-in formatter (removes extra newlines)
# formatter: external # Run the external command `shfmt --case-indent --indent 2`
# formatter: none # Disable formatting entirely
# formatter: <string> # Use a custom shell command to format the script.
# # The command will receive the script via stdin and
# # must output the result to stdout.
# formatter: <string> # Provide a custom shell command to format the script.
# # The command receives the script via stdin and must
# # write the result to stdout.
# # Example: shfmt --minify
formatter: internal

Expand DownExpand Up@@ -102,7 +129,7 @@ usage_colors:
#-------------------------------------------------------------------------------

# Set to 'production' or 'development'.
# Determines which features are enabled in the rendered script.
# Determines which features are enabled in the generated script.
# Use the `enable_*` options below to adjust settings for each environment.
# It is recommended to leave this set to 'development' and run
# `bashly generate --env production` when the production version is needed.
Expand Down

27 changes: 19 additions & 8 deletions
lib/bashly/settings.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,16 +160,27 @@ def var_aliases
 private

 def get(key)
 case env_value key
 when nil then config[key.to_s]
 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else env_value key
 end
 ENV.has_key?(env_var_name(key)) ? value_from_env(key) : value_from_config(key)
Comment thread
DannyBen marked this conversation as resolved.

 end

 def env_var_name(key)
 "BASHLY_#{key.upcase}"
 end

 def env_value(key)
 ENV["BASHLY_#{key.upcase}"]
 def value_from_config(key)
 return config[key.to_s] if key == :env

 result = config["#{key}_#{env}"]
 result.nil? ? config[key.to_s] : result
 end

 def value_from_env(key)
 result = ENV[env_var_name(key)]
 case result&.strip&.downcase
Comment thread
DannyBen marked this conversation as resolved.

 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else result
 end
 end

 def config
Expand Down

21 changes: 21 additions & 0 deletions
spec/bashly/settings_spec.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,27 @@
 expect(subject.tab_indent).to eq ENV['BASHLY_TAB_INDENT']
 end
 end

 context 'when using env suffix overrides' do
 before do
 reset_tmp_dir
 File.write 'spec/tmp/settings.yml', 'formatter_production: shfmt --minify'
 subject.formatter = nil
 end

 it 'returns the default value when it is not the specified environment' do
 Dir.chdir 'spec/tmp' do
 expect(subject.formatter).to eq 'internal'
 end
 end

 it 'returns the config value when it is the specified environment' do
 Dir.chdir 'spec/tmp' do
 subject.env = :production
 expect(subject.formatter).to eq 'shfmt --minify'
 end
 end
 end
 end

 describe '::env' do
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add support for per-environment settings by DannyBen · Pull Request #668 · bashly-framework/bashly · GitHub
Skip to content
Add support for per-environment settings#668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 2 commits into

from

Aug 31, 2025
 Merged


Add support for per-environment settings
#668
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
522d2b8

- Add support for per-environment settings


DannyBen Aug 30, 2025
110450d

fix settings env var priority


DannyBen Aug 30, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.rubocop.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ RSpec/SpecFilePathFormat:
 - 'spec/bashly/concerns/completions_command_spec.rb'
 - 'spec/bashly/concerns/completions_flag_spec.rb'

# Allow longer integration examples as they are more complex by nature
# Allow longer examples in some cases
RSpec/ExampleLength:
 Exclude:
 - 'spec/bashly/integration/**/*'
 - 'spec/bashly/libraries/render*'
 - 'spec/bashly/script/command_spec.rb'

55 changes: 41 additions & 14 deletions
lib/bashly/libraries/settings/settings.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
# All settings are optional (with their default values provided below), and
# can also be set with an environment variable with the same name, capitalized
# and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
#-------------------------------------------------------------------------------
# BASHLY SETTINGS
#-------------------------------------------------------------------------------
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
### Default Values
#
# All settings are optional, with their default values provided below
#
### Environment Variables
#
# Values can also be set using an environment variable with the same name,
# capitalized and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR`
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
#
# Environment variables take precedence over values in the config file.
#
### File Location:
#
# Bashly looks for the settings file in these locations.
# - The path defined in the `BASHLY_SETTINGS_PATH` environment variable.
# - A file named `bashly-settings.yml` in the working directory.
# - A file named `settings.yml` in the working directory.
#
### Environment Overrides:
#
# All options (except `env`) may be specified with an environment suffix in 
# order to override its value for a given environment.
#
# For example, when defining `formatter_production: shfmt --minify`, then 
# this will be the formatter used when generating the script with
# `bashly generate --env production`
#
# Since these values take precedence over the standard values, you can define
# both (i.e. `formatter: shfmt` and `formatter_production: shfmt --minify`).
#
# If you wish to change the path to this file, set the environment variable
# BASHLY_SETTINGS_PATH.


#-------------------------------------------------------------------------------
# PATH OPTIONS
Expand DownExpand Up@@ -52,12 +79,12 @@ strict: false
tab_indent: false

# Choose a post-processor for the generated script:
# formatter: internal # Use Bashly's internal formatter (compacts newlines)
# formatter: internal # Use Bashly’s built-in formatter (removes extra newlines)
# formatter: external # Run the external command `shfmt --case-indent --indent 2`
# formatter: none # Disable formatting entirely
# formatter: <string> # Use a custom shell command to format the script.
# # The command will receive the script via stdin and
# # must output the result to stdout.
# formatter: <string> # Provide a custom shell command to format the script.
# # The command receives the script via stdin and must
# # write the result to stdout.
# # Example: shfmt --minify
formatter: internal

Expand DownExpand Up@@ -102,7 +129,7 @@ usage_colors:
#-------------------------------------------------------------------------------

# Set to 'production' or 'development'.
# Determines which features are enabled in the rendered script.
# Determines which features are enabled in the generated script.
# Use the `enable_*` options below to adjust settings for each environment.
# It is recommended to leave this set to 'development' and run
# `bashly generate --env production` when the production version is needed.
Expand Down

27 changes: 19 additions & 8 deletions
lib/bashly/settings.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,16 +160,27 @@ def var_aliases
 private

 def get(key)
 case env_value key
 when nil then config[key.to_s]
 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else env_value key
 end
 ENV.has_key?(env_var_name(key)) ? value_from_env(key) : value_from_config(key)
Comment thread
DannyBen marked this conversation as resolved.

 end

 def env_var_name(key)
 "BASHLY_#{key.upcase}"
 end

 def env_value(key)
 ENV["BASHLY_#{key.upcase}"]
 def value_from_config(key)
 return config[key.to_s] if key == :env

 result = config["#{key}_#{env}"]
 result.nil? ? config[key.to_s] : result
 end

 def value_from_env(key)
 result = ENV[env_var_name(key)]
 case result&.strip&.downcase
Comment thread
DannyBen marked this conversation as resolved.

 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else result
 end
 end

 def config
Expand Down

21 changes: 21 additions & 0 deletions
spec/bashly/settings_spec.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,27 @@
 expect(subject.tab_indent).to eq ENV['BASHLY_TAB_INDENT']
 end
 end

 context 'when using env suffix overrides' do
 before do
 reset_tmp_dir
 File.write 'spec/tmp/settings.yml', 'formatter_production: shfmt --minify'
 subject.formatter = nil
 end

 it 'returns the default value when it is not the specified environment' do
 Dir.chdir 'spec/tmp' do
 expect(subject.formatter).to eq 'internal'
 end
 end

 it 'returns the config value when it is the specified environment' do
 Dir.chdir 'spec/tmp' do
 subject.env = :production
 expect(subject.formatter).to eq 'shfmt --minify'
 end
 end
 end
 end

 describe '::env' do
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for per-environment settings by DannyBen · Pull Request #668 · bashly-framework/bashly · GitHub
Skip to content
Add support for per-environment settings#668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 2 commits into

from

Aug 31, 2025
 Merged


Add support for per-environment settings
#668
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
522d2b8

- Add support for per-environment settings


DannyBen Aug 30, 2025
110450d

fix settings env var priority


DannyBen Aug 30, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.rubocop.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ RSpec/SpecFilePathFormat:
 - 'spec/bashly/concerns/completions_command_spec.rb'
 - 'spec/bashly/concerns/completions_flag_spec.rb'

# Allow longer integration examples as they are more complex by nature
# Allow longer examples in some cases
RSpec/ExampleLength:
 Exclude:
 - 'spec/bashly/integration/**/*'
 - 'spec/bashly/libraries/render*'
 - 'spec/bashly/script/command_spec.rb'

55 changes: 41 additions & 14 deletions
lib/bashly/libraries/settings/settings.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
# All settings are optional (with their default values provided below), and
# can also be set with an environment variable with the same name, capitalized
# and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
#-------------------------------------------------------------------------------
# BASHLY SETTINGS
#-------------------------------------------------------------------------------
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
### Default Values
#
# All settings are optional, with their default values provided below
#
### Environment Variables
#
# Values can also be set using an environment variable with the same name,
# capitalized and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR`
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
#
# Environment variables take precedence over values in the config file.
#
### File Location:
#
# Bashly looks for the settings file in these locations.
# - The path defined in the `BASHLY_SETTINGS_PATH` environment variable.
# - A file named `bashly-settings.yml` in the working directory.
# - A file named `settings.yml` in the working directory.
#
### Environment Overrides:
#
# All options (except `env`) may be specified with an environment suffix in 
# order to override its value for a given environment.
#
# For example, when defining `formatter_production: shfmt --minify`, then 
# this will be the formatter used when generating the script with
# `bashly generate --env production`
#
# Since these values take precedence over the standard values, you can define
# both (i.e. `formatter: shfmt` and `formatter_production: shfmt --minify`).
#
# If you wish to change the path to this file, set the environment variable
# BASHLY_SETTINGS_PATH.


#-------------------------------------------------------------------------------
# PATH OPTIONS
Expand DownExpand Up@@ -52,12 +79,12 @@ strict: false
tab_indent: false

# Choose a post-processor for the generated script:
# formatter: internal # Use Bashly's internal formatter (compacts newlines)
# formatter: internal # Use Bashly’s built-in formatter (removes extra newlines)
# formatter: external # Run the external command `shfmt --case-indent --indent 2`
# formatter: none # Disable formatting entirely
# formatter: <string> # Use a custom shell command to format the script.
# # The command will receive the script via stdin and
# # must output the result to stdout.
# formatter: <string> # Provide a custom shell command to format the script.
# # The command receives the script via stdin and must
# # write the result to stdout.
# # Example: shfmt --minify
formatter: internal

Expand DownExpand Up@@ -102,7 +129,7 @@ usage_colors:
#-------------------------------------------------------------------------------

# Set to 'production' or 'development'.
# Determines which features are enabled in the rendered script.
# Determines which features are enabled in the generated script.
# Use the `enable_*` options below to adjust settings for each environment.
# It is recommended to leave this set to 'development' and run
# `bashly generate --env production` when the production version is needed.
Expand Down

27 changes: 19 additions & 8 deletions
lib/bashly/settings.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,16 +160,27 @@ def var_aliases
 private

 def get(key)
 case env_value key
 when nil then config[key.to_s]
 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else env_value key
 end
 ENV.has_key?(env_var_name(key)) ? value_from_env(key) : value_from_config(key)
Comment thread
DannyBen marked this conversation as resolved.

 end

 def env_var_name(key)
 "BASHLY_#{key.upcase}"
 end

 def env_value(key)
 ENV["BASHLY_#{key.upcase}"]
 def value_from_config(key)
 return config[key.to_s] if key == :env

 result = config["#{key}_#{env}"]
 result.nil? ? config[key.to_s] : result
 end

 def value_from_env(key)
 result = ENV[env_var_name(key)]
 case result&.strip&.downcase
Comment thread
DannyBen marked this conversation as resolved.

 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else result
 end
 end

 def config
Expand Down

21 changes: 21 additions & 0 deletions
spec/bashly/settings_spec.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,27 @@
 expect(subject.tab_indent).to eq ENV['BASHLY_TAB_INDENT']
 end
 end

 context 'when using env suffix overrides' do
 before do
 reset_tmp_dir
 File.write 'spec/tmp/settings.yml', 'formatter_production: shfmt --minify'
 subject.formatter = nil
 end

 it 'returns the default value when it is not the specified environment' do
 Dir.chdir 'spec/tmp' do
 expect(subject.formatter).to eq 'internal'
 end
 end

 it 'returns the config value when it is the specified environment' do
 Dir.chdir 'spec/tmp' do
 subject.env = :production
 expect(subject.formatter).to eq 'shfmt --minify'
 end
 end
 end
 end

 describe '::env' do
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for per-environment settings by DannyBen · Pull Request #668 · bashly-framework/bashly · GitHub
Skip to content
Add support for per-environment settings#668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 2 commits into

from

Aug 31, 2025
 Merged


Add support for per-environment settings
#668
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
522d2b8

- Add support for per-environment settings


DannyBen Aug 30, 2025
110450d

fix settings env var priority


DannyBen Aug 30, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.rubocop.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ RSpec/SpecFilePathFormat:
 - 'spec/bashly/concerns/completions_command_spec.rb'
 - 'spec/bashly/concerns/completions_flag_spec.rb'

# Allow longer integration examples as they are more complex by nature
# Allow longer examples in some cases
RSpec/ExampleLength:
 Exclude:
 - 'spec/bashly/integration/**/*'
 - 'spec/bashly/libraries/render*'
 - 'spec/bashly/script/command_spec.rb'

55 changes: 41 additions & 14 deletions
lib/bashly/libraries/settings/settings.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
# All settings are optional (with their default values provided below), and
# can also be set with an environment variable with the same name, capitalized
# and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
#-------------------------------------------------------------------------------
# BASHLY SETTINGS
#-------------------------------------------------------------------------------
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
### Default Values
#
# All settings are optional, with their default values provided below
#
### Environment Variables
#
# Values can also be set using an environment variable with the same name,
# capitalized and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR`
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
#
# Environment variables take precedence over values in the config file.
#
### File Location:
#
# Bashly looks for the settings file in these locations.
# - The path defined in the `BASHLY_SETTINGS_PATH` environment variable.
# - A file named `bashly-settings.yml` in the working directory.
# - A file named `settings.yml` in the working directory.
#
### Environment Overrides:
#
# All options (except `env`) may be specified with an environment suffix in 
# order to override its value for a given environment.
#
# For example, when defining `formatter_production: shfmt --minify`, then 
# this will be the formatter used when generating the script with
# `bashly generate --env production`
#
# Since these values take precedence over the standard values, you can define
# both (i.e. `formatter: shfmt` and `formatter_production: shfmt --minify`).
#
# If you wish to change the path to this file, set the environment variable
# BASHLY_SETTINGS_PATH.


#-------------------------------------------------------------------------------
# PATH OPTIONS
Expand DownExpand Up@@ -52,12 +79,12 @@ strict: false
tab_indent: false

# Choose a post-processor for the generated script:
# formatter: internal # Use Bashly's internal formatter (compacts newlines)
# formatter: internal # Use Bashly’s built-in formatter (removes extra newlines)
# formatter: external # Run the external command `shfmt --case-indent --indent 2`
# formatter: none # Disable formatting entirely
# formatter: <string> # Use a custom shell command to format the script.
# # The command will receive the script via stdin and
# # must output the result to stdout.
# formatter: <string> # Provide a custom shell command to format the script.
# # The command receives the script via stdin and must
# # write the result to stdout.
# # Example: shfmt --minify
formatter: internal

Expand DownExpand Up@@ -102,7 +129,7 @@ usage_colors:
#-------------------------------------------------------------------------------

# Set to 'production' or 'development'.
# Determines which features are enabled in the rendered script.
# Determines which features are enabled in the generated script.
# Use the `enable_*` options below to adjust settings for each environment.
# It is recommended to leave this set to 'development' and run
# `bashly generate --env production` when the production version is needed.
Expand Down

27 changes: 19 additions & 8 deletions
lib/bashly/settings.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,16 +160,27 @@ def var_aliases
 private

 def get(key)
 case env_value key
 when nil then config[key.to_s]
 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else env_value key
 end
 ENV.has_key?(env_var_name(key)) ? value_from_env(key) : value_from_config(key)
Comment thread
DannyBen marked this conversation as resolved.

 end

 def env_var_name(key)
 "BASHLY_#{key.upcase}"
 end

 def env_value(key)
 ENV["BASHLY_#{key.upcase}"]
 def value_from_config(key)
 return config[key.to_s] if key == :env

 result = config["#{key}_#{env}"]
 result.nil? ? config[key.to_s] : result
 end

 def value_from_env(key)
 result = ENV[env_var_name(key)]
 case result&.strip&.downcase
Comment thread
DannyBen marked this conversation as resolved.

 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else result
 end
 end

 def config
Expand Down

21 changes: 21 additions & 0 deletions
spec/bashly/settings_spec.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,27 @@
 expect(subject.tab_indent).to eq ENV['BASHLY_TAB_INDENT']
 end
 end

 context 'when using env suffix overrides' do
 before do
 reset_tmp_dir
 File.write 'spec/tmp/settings.yml', 'formatter_production: shfmt --minify'
 subject.formatter = nil
 end

 it 'returns the default value when it is not the specified environment' do
 Dir.chdir 'spec/tmp' do
 expect(subject.formatter).to eq 'internal'
 end
 end

 it 'returns the config value when it is the specified environment' do
 Dir.chdir 'spec/tmp' do
 subject.env = :production
 expect(subject.formatter).to eq 'shfmt --minify'
 end
 end
 end
 end

 describe '::env' do
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add support for per-environment settings by DannyBen · Pull Request #668 · bashly-framework/bashly · GitHub
Skip to content
Add support for per-environment settings#668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 2 commits into

from

Aug 31, 2025
 Merged


Add support for per-environment settings
#668
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
522d2b8

- Add support for per-environment settings


DannyBen Aug 30, 2025
110450d

fix settings env var priority


DannyBen Aug 30, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
.rubocop.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ RSpec/SpecFilePathFormat:
 - 'spec/bashly/concerns/completions_command_spec.rb'
 - 'spec/bashly/concerns/completions_flag_spec.rb'

# Allow longer integration examples as they are more complex by nature
# Allow longer examples in some cases
RSpec/ExampleLength:
 Exclude:
 - 'spec/bashly/integration/**/*'
 - 'spec/bashly/libraries/render*'
 - 'spec/bashly/script/command_spec.rb'

55 changes: 41 additions & 14 deletions
lib/bashly/libraries/settings/settings.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
# All settings are optional (with their default values provided below), and
# can also be set with an environment variable with the same name, capitalized
# and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
#-------------------------------------------------------------------------------
# BASHLY SETTINGS
#-------------------------------------------------------------------------------
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
### Default Values
#
# All settings are optional, with their default values provided below
#
### Environment Variables
#
# Values can also be set using an environment variable with the same name,
# capitalized and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR`
#
# When setting environment variables, you can use:
# - "0", "false" or "no" to represent false
# - "1", "true" or "yes" to represent true
#
# Environment variables take precedence over values in the config file.
#
### File Location:
#
# Bashly looks for the settings file in these locations.
# - The path defined in the `BASHLY_SETTINGS_PATH` environment variable.
# - A file named `bashly-settings.yml` in the working directory.
# - A file named `settings.yml` in the working directory.
#
### Environment Overrides:
#
# All options (except `env`) may be specified with an environment suffix in 
# order to override its value for a given environment.
#
# For example, when defining `formatter_production: shfmt --minify`, then 
# this will be the formatter used when generating the script with
# `bashly generate --env production`
#
# Since these values take precedence over the standard values, you can define
# both (i.e. `formatter: shfmt` and `formatter_production: shfmt --minify`).
#
# If you wish to change the path to this file, set the environment variable
# BASHLY_SETTINGS_PATH.


#-------------------------------------------------------------------------------
# PATH OPTIONS
Expand DownExpand Up@@ -52,12 +79,12 @@ strict: false
tab_indent: false

# Choose a post-processor for the generated script:
# formatter: internal # Use Bashly's internal formatter (compacts newlines)
# formatter: internal # Use Bashly’s built-in formatter (removes extra newlines)
# formatter: external # Run the external command `shfmt --case-indent --indent 2`
# formatter: none # Disable formatting entirely
# formatter: <string> # Use a custom shell command to format the script.
# # The command will receive the script via stdin and
# # must output the result to stdout.
# formatter: <string> # Provide a custom shell command to format the script.
# # The command receives the script via stdin and must
# # write the result to stdout.
# # Example: shfmt --minify
formatter: internal

Expand DownExpand Up@@ -102,7 +129,7 @@ usage_colors:
#-------------------------------------------------------------------------------

# Set to 'production' or 'development'.
# Determines which features are enabled in the rendered script.
# Determines which features are enabled in the generated script.
# Use the `enable_*` options below to adjust settings for each environment.
# It is recommended to leave this set to 'development' and run
# `bashly generate --env production` when the production version is needed.
Expand Down

27 changes: 19 additions & 8 deletions
lib/bashly/settings.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,16 +160,27 @@ def var_aliases
 private

 def get(key)
 case env_value key
 when nil then config[key.to_s]
 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else env_value key
 end
 ENV.has_key?(env_var_name(key)) ? value_from_env(key) : value_from_config(key)
Comment thread
DannyBen marked this conversation as resolved.

 end

 def env_var_name(key)
 "BASHLY_#{key.upcase}"
 end

 def env_value(key)
 ENV["BASHLY_#{key.upcase}"]
 def value_from_config(key)
 return config[key.to_s] if key == :env

 result = config["#{key}_#{env}"]
 result.nil? ? config[key.to_s] : result
 end

 def value_from_env(key)
 result = ENV[env_var_name(key)]
 case result&.strip&.downcase
Comment thread
DannyBen marked this conversation as resolved.

 when '0', 'false', 'no' then false
 when '1', 'true', 'yes' then true
 else result
 end
 end

 def config
Expand Down

21 changes: 21 additions & 0 deletions
spec/bashly/settings_spec.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,27 @@
 expect(subject.tab_indent).to eq ENV['BASHLY_TAB_INDENT']
 end
 end

 context 'when using env suffix overrides' do
 before do
 reset_tmp_dir
 File.write 'spec/tmp/settings.yml', 'formatter_production: shfmt --minify'
 subject.formatter = nil
 end

 it 'returns the default value when it is not the specified environment' do
 Dir.chdir 'spec/tmp' do
 expect(subject.formatter).to eq 'internal'
 end
 end

 it 'returns the config value when it is the specified environment' do
 Dir.chdir 'spec/tmp' do
 subject.env = :production
 expect(subject.formatter).to eq 'shfmt --minify'
 end
 end
 end
 end

 describe '::env' do
Expand Down