Snippet Generator

Snippet Generator

Purpose

Create production-ready code snippets that:

• Follow language best practices
• Are properly documented
• Include error handling
• Are customizable with parameters
• Save development time

When to Use

Invoke this skill when:

• User needs boilerplate code quickly
• Creating common patterns (loops, classes, functions)
• Scaffolding new components or modules
• Teaching programming patterns
• Standardizing code across a team

Instructions

Step 1: Identify the Snippet Type

Determine what kind of snippet is needed:

1. Language construct: Class, function, loop, conditional
2. Design pattern: Singleton, factory, observer, etc.
3. Framework-specific: React component, Express route, etc.
4. Utility: Common algorithm, data structure, helper
5. Test pattern: Test suite, test case, mock

Step 2: Determine the Language/Framework

Identify the target environment:

• Language: JavaScript, TypeScript, Python, Go, Rust, Java, etc.
• Framework: React, Vue, Express, Django, Spring, etc.
• Version: ES6+, TypeScript 5+, Python 3.10+, etc.

Step 3: Apply Best Practices

Ensure the snippet includes:

1. Type safety: Types/interfaces where applicable
2. Error handling: Try/catch, error checking
3. Documentation: JSDoc, docstrings, comments
4. Naming: Clear, descriptive names
5. Modern syntax: Latest language features
6. Testing: Testable structure

Step 4: Add Customization Placeholders

Include placeholders for:

• Names: ${ComponentName}, ${functionName}
• Parameters: ${param1}, ${options}
• Types: ${Type}, ${ReturnType}
• Values: ${defaultValue}, ${initialState}

Step 5: Include Usage Examples

Provide:

• Basic usage example
• Advanced usage (if applicable)
• Common variations
• Integration examples

Snippet Templates

JavaScript/TypeScript

Async Function with Error Handling

/**
 * ${description}
 * @param ${param} - ${paramDescription}
 * @returns ${returnDescription}
 * @throws ${errorDescription}
 */
async function ${functionName}(${param}: ${ParamType}): Promise<${ReturnType}> {
  try {
    // Validate input
    if (!${param}) {
      throw new Error('${param} is required');
    }

    // Main logic
    const result = await ${operation}(${param});

    return result;
  } catch (error) {
    console.error(`Error in ${functionName}:`, error);
    throw new Error(`Failed to ${operation}: ${error.message}`);
  }
}

// Usage example
try {
  const result = await ${functionName}(${exampleParam});
  console.log('Success:', result);
} catch (error) {
  console.error('Error:', error);
}