naming

Analyze and improve code naming conventions across programming languages.

Updated Jun 19, 2023
One-click install
npx skills add https://github.com/JeroenJochems/modelwise --skill naming-jeroenjochems
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: naming
Source: https://github.com/JeroenJochems/modelwise/tree/main/.claude/skills/naming
Command: npx skills add https://github.com/JeroenJochems/modelwise --skill naming-jeroenjochems

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating and maintaining clear, descriptive, and maintainable names for code elements, which is crucial for readability and reducing bugs.

Core Features & Use Cases

  • Code Naming Analysis: Analyzes code to identify unclear, misleading, or overly generic names.
  • Convention Enforcement: Adapts naming suggestions to project-specific languages and conventions (e.g., PSR-12 for PHP, camelCase/PascalCase for TypeScript).
  • Refactoring Guidance: Provides patterns and checklists for improving names during code reviews and refactoring.
  • Use Case: When writing a new function, use this Skill to ensure its name accurately reflects its purpose, making the code easier for others (and your future self) to understand.

Quick Start

Use the naming skill to suggest a better name for the function Proc in the provided Go code snippet.

Frequently Asked Questions about naming

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

FAQPage Schema
How do I fix unclear variable and function names during a code review?

To fix unclear names during a code review, analyze your code elements to identify cryptic abbreviations, noise words, and incorrect parts of speech, then apply refactoring patterns to reveal true intent and improve readability.

What are the best practices for code naming in TypeScript and PHP?

Best practices for code naming in TypeScript and PHP involve adapting to project-specific conventions like camelCase or PSR-12, eliminating disinformation, and ensuring scope-length matches to create clear, maintainable names.

Why does my function name not accurately reflect its implementation?

Your function name may not reflect its implementation due to scope-length mismatches or disinformation, where the name implies a broader or narrower behavior than the actual code logic executes.

Can I enforce custom naming conventions for different programming languages?

Yes, you can enforce custom naming conventions by adapting analysis to your project-specific stacks, ensuring naming suggestions respect the distinct conventions and rules of your chosen programming languages.

What is a noise word in code naming and how do I eliminate it?

A noise word in code naming is a redundant term that adds no meaningful context, which you eliminate using specific refactoring checklists to strip unnecessary vocabulary and reveal the element's true intent.