format-bash-source

Apply deterministic style rules to Bash source files.

62|156|Updated Aug 10, 2018

Search Tags:#automation #linting #formatting #bash #shell #code-style

Ready to run

npx skills add https://github.com/liferay/liferay-docker --skill format-bash-source

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: format-bash-source
Source: https://github.com/liferay/liferay-docker/tree/main/.claude/skills/format-bash-source
Command: npx skills add https://github.com/liferay/liferay-docker --skill format-bash-source

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates inconsistencies in shell script formatting, ensuring that all Bash files in the repository adhere strictly to the established code style guide.

Core Features & Use Cases

Automated Formatting: Applies rules for function definitions, variable naming, quoting, and command syntax as defined in the repository's style guide.
Targeted or Batch Processing: Automatically detects modified files on the current branch or processes specific files and directories provided as arguments.
Use Case: Use this skill before committing changes to ensure your new or modified shell scripts pass the repository's style requirements without manual cleanup.

Quick Start

Invoke the format-bash-source skill to automatically reformat all locally modified shell scripts in the repository.

Frequently Asked Questions about format-bash-source

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automatically format Bash scripts to match a repository style guide?▼

Automated Bash script formatting applies deterministic style rules to shell source files, standardizing function definitions, variable quoting, and command syntax to ensure strict compliance with the repository's authoritative code style.

When do I need to standardize shell script formatting in my project?▼

You need to standardize shell script formatting when locally modified files introduce inconsistencies, ensuring that new or updated Bash scripts pass repository style requirements before committing changes without manual cleanup.

Can I format specific shell files or does it only process modified files?▼

You can format specific shell files or directories provided as arguments, or you can automatically detect and process only the locally modified Bash scripts on the current branch.

Does Bash code formatting change the logic of my shell scripts?▼

Bash code formatting does not change script logic, as it applies deterministic style rules to enforce consistent syntax for functions and variables while maintaining script idempotency and original execution behavior.

What is the best way to enforce consistent variable quoting and function syntax in Bash?▼

The best way to enforce consistent variable quoting and function syntax in Bash is to use an automated formatting tool that applies deterministic repository style rules to shell source files before commit.

Are there limitations to automated Bash script formatting for complex command execution?▼

Automated Bash script formatting focuses on syntax and style rules for functions, variables, and quoting, maintaining script logic and idempotency without altering the semantic execution of complex commands.