Header Maker

Header Maker is a versatile header generation tool for your source code files. It supports multiple languages and provides customizable options like timestamps, footers, custom alignment, multiline titles, and dynamic templates to make your code headers both informative and consistent.

Features

• Multi-Language Support:
  Generate headers for Python, SQL, HTML, JavaScript, C, Java, Shell, CSS, PHP, Go, Rust, Lua, Solidity, and more.

• Custom Border:
  Specify any character for your header's border using the --char option.

• Timestamp Integration:
  Automatically include the current date and time in the header borders with the --timestamp flag.

• Footer Block:
  Append a footer to your header using the --footer option for additional notes or end-of-script markers.

• Custom Alignment:
  Align your header text to the left, center, or right with the --align option.

• Multiline Titles:
  Provide multiple title lines—each non-flag argument is treated as a separate line in your header.

• Template Support:
  Dynamically insert shell variables and command outputs (e.g., user name, date) into your header using the --template option.

Installation

Via npm (Recommended)

Header Maker is available as an npm package. To install it globally, run:

npm install -g @kmean/header-maker

Manual Installation from GitHub

Clone the repository and make the script executable:

git clone https://github.com/KMean/header-maker.git
cd header-maker
chmod +x bin/header.sh

Then run the script directly:

./bin/header.sh --py "My Header Title"

Installation via install.sh Script

You can also install Header Maker into /usr/local/bin using the provided install.sh script:

curl -o install.sh https://raw.githubusercontent.com/KMean/header-maker/master/install.sh
chmod +x install.sh
sudo ./install.sh

This downloads the header script and places it as header in /usr/local/bin, allowing you to run:

header --py "My Header Title"

Note: Installing to /usr/local/bin requires sudo privileges.

Usage

check what options you have by running

header -h

Usage: header [--py | --html | --sql | --js | --c | --java | --sh | --css | --php | --go | --rs | --lua | --sol] [options] <title lines>

Options:
  --py                 Python header (#)
  --sql                SQL header (--)
  --html               HTML header (<!-- -->)
  --js                 JavaScript header (//)
  --c                  C/C++ header (//)
  --java               Java header (//)
  --sh                 Shell/Bash header (#)
  --css                CSS header (/* */)
  --php                PHP header (//)
  --go                 Go header (//)
  --rs                 Rust header (//)
  --lua                Lua header (--)
  --sol                Solidity header (// or /* */)
  --width              Set custom total width (default: 74)
  --padding            Set custom padding width (default: auto)
  --char               Set custom border character (default: '-')
  --align              Set alignment: left, center, or right (default: center)
  --timestamp          Insert current timestamp in the border lines
  --template           Add a template line (supports shell variables, e.g. $USER, $(date))
  --footer             Add a footer block below the header
  --uppercase or --uc  Convert title (and template/footer) to uppercase
  --help or -h         Show this help message

Run the script with your desired options. Here are a few examples:

Basic Usage

Generate a simple Solidity header with a centered title:

header --sol "My Header Title"

Example Output:

//----------------------------------------------------------------------//
//                           My Header Title                            //
//----------------------------------------------------------------------//

Generate a simple Python header with right aligned title:

header --py --align right "My Header Title"

Example Output:

#------------------------------------------------------------------------#
#                                                        My Header Title #
#------------------------------------------------------------------------#

Generate a simple HTML Header with centered Uppercase title

header --html --uc  "My Header Title"

Example Output:

<!-- ----------------------------------------------------------------- -->
<!--                          MY HEADER TITLE                          -->
<!-- ----------------------------------------------------------------- -->

Advanced Usage

Generate a Solidity header with a timestamp in the border, center-aligned title, dynamic template, and a footer:

header --sol --timestamp --template "Author: \$USER, Date: \$(date '+%Y-%m-%d')" --footer "END OF SCRIPT" "Custom Header Title" "Additional Info"

Example Output:

//------------------------ 2025-02-14 19:51:19 -------------------------//
//                         Custom Header Title                          //
//                           Additional Info                            //
//                   Author: kmean, Date: 2025-02-14                    //
//------------------------ 2025-02-14 19:51:19 -------------------------//

//----------------------------------------------------------------------//
//                            END OF SCRIPT                             //
//----------------------------------------------------------------------//

Custom Border Example

Generate an HTML header with a custom border character (+):

header --html --char "+" "My Header Title"

Example Output:

<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!--                          My Header Title                          -->
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->

Contributing

Contributions are welcome! Feel free to fork the repository, open issues, and submit pull requests for improvements or additional features.