Create templates for scripting productivity

Sure! Here are some clear and versatile scripting productivity templates you can use for different types of scripts—whether for automation, batch processing, or coding projects. These templates focus on structure, readability, and maintainability to boost your scripting productivity.

1. Basic Automation Script Template (Bash/Python)

bash
CopyEdit
#!/bin/bash
# Script Name: <script_name>
# Description: <Brief description of what this script does>
# Author: <Your Name>
# Date: <Creation Date>

set -e  # Exit immediately if a command exits with a non-zero status
set -u  # Treat unset variables as an error

# Functions
function log_info() {
    echo "[INFO] $(date +'%Y-%m-%d %H:%M:%S') - $1"
}

function log_error() {
    echo "[ERROR] $(date +'%Y-%m-%d %H:%M:%S') - $1" >&2
}

# Main script
log_info "Starting the script"

# Your commands here
# Example:
# cp source_file destination_folder/

log_info "Script completed successfully"

2. Python Script Template

python
CopyEdit
#!/usr/bin/env python3
"""
Script Name: <script_name.py>
Description: <Brief description of what this script does>
Author: <Your Name>
Date: <Creation Date>
"""

import sys
import logging

logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')

def main(args):
    logging.info("Starting script")
    
    # Your code logic here
    # Example:
    # result = do_something(args)
    
    logging.info("Script finished successfully")

if __name__ == "__main__":
    main(sys.argv[1:])

3. PowerShell Script Template

powershell
CopyEdit
<#
.SYNOPSIS
    <Brief description of the script>

.DESCRIPTION
    <More detailed description>

.PARAMETER <ParameterName>
    <Description of parameters>

.EXAMPLE
    .script.ps1 -Param value

.AUTHOR
    <Your Name>
#>

[CmdletBinding()]
param(
    # Define parameters here
)

function Log-Info {
    param([string]$message)
    Write-Host "[INFO] $(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') - $message"
}

function Log-Error {
    param([string]$message)
    Write-Error "[ERROR] $(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') - $message"
}

try {
    Log-Info "Starting script"

    # Your code here

    Log-Info "Script completed successfully"
}
catch {
    Log-Error $_.Exception.Message
    exit 1
}

4. Node.js Script Template

javascript
CopyEdit
#!/usr/bin/env node

/**
 * Script Name: <script_name.js>
 * Description: <Brief description>
 * Author: <Your Name>
 * Date: <Creation Date>
 */

const fs = require('fs');

function logInfo(message) {
    console.log(`[INFO] ${new Date().toISOString()} - ${message}`);
}

function logError(message) {
    console.error(`[ERROR] ${new Date().toISOString()} - ${message}`);
}

async function main() {
    try {
        logInfo('Starting script');
        
        // Your async code here
        // Example:
        // const data = await fs.promises.readFile('file.txt', 'utf8');

        logInfo('Script completed successfully');
    } catch (err) {
        logError(err.message);
        process.exit(1);
    }
}

main();

5. General Scripting Productivity Checklist

• Add descriptive header comments with script name, author, date, and purpose.

• Use logging functions for consistent info/error output.

• Handle errors gracefully.

• Use functions for modular code.

• Validate inputs and parameters.

• Add meaningful comments inside the code.

• Follow consistent naming conventions.

• Use environment variables/config files where applicable.

• Clean exit on success or failure.

• Document usage and parameters.

If you want, I can customize a specific scripting template for your exact use case or language. Just let me know!