AI Prompts for Preventing Duplicate Function Creation

Please provide a comprehensive list of all functions currently implemented in the project. For each function, indicate its purpose and any parameters it accepts. Additionally, highlight any functions that share similarities with [FUNCTION_NAME], detailing the aspects that make them comparable. Format the output in a table for clarity, including columns for function name, description, and similarity notes.

Please search the codebase for functions that have similar names to [FUNCTION_NAME]. For each function found, provide the following details: the location within the codebase, the complete definition of the function, and any relevant comments or documentation associated with it. Additionally, include a brief analysis of how these similar names might lead to confusion or errors in the code. Format your response in a clear and organized manner, listing each function with its details separately.

Please compare the signature of [FUNCTION_NAME] with the signatures of other functions in the project. Identify any functions that match or are similar, and provide details on the similarities, including parameter types, return types, and any notable differences. Additionally, explain the potential implications of having similar function signatures in terms of code maintainability and readability. Format your findings in a clear, structured report that highlights the key comparisons and recommendations for improvement.

Please locate all instances where the function [FUNCTION_NAME] is used within the codebase. Additionally, analyze the code to identify any similar functions that may be used interchangeably with [FUNCTION_NAME]. Provide a summary of your findings, including the locations of each instance and a comparison of the similar functions, highlighting any differences in parameters or return values. Format the results in a clear, organized manner that makes it easy to review the function usages and their context.

Explain the purpose of [FUNCTION_NAME] in detail, including its intended use cases and key features. Compare it with similar functions such as [SIMILAR_FUNCTION_1] and [SIMILAR_FUNCTION_2], highlighting any similarities and differences in their functionalities. Assess whether these functions serve the same or overlapping purposes, and provide examples of scenarios where each function would be most appropriately used. Summarize your findings in a structured format that clearly outlines the distinctions and relationships among these functions.

Please rename the function currently called [FUNCTION_NAME] to avoid any conflicts with existing functions in the codebase. Provide a new name that clearly reflects the unique purpose and functionality of this function. Additionally, explain the reasoning behind your suggested name and how it differentiates from other functions. Ensure the new name adheres to common naming conventions and is easy to understand for future developers.

Please merge the functions [FUNCTION_NAME] and [EXISTING_FUNCTION] if they serve the same purpose. Analyze the code of both functions to identify overlapping logic and determine how they can be combined effectively. Provide the complete code for the merged function, ensuring that it maintains the original functionality while eliminating redundancy. Include comments to explain any changes made during the merging process.

Identify and remove the redundant function named [FUNCTION_NAME] from the codebase. First, check all instances where this function is called and update those references to use the existing function instead. Provide a summary of the changes made, including the locations of the updated references and any potential impacts on the overall functionality of the code. Additionally, ensure that the code is tested to confirm that it operates correctly after the removal of the redundant function.

Refactor the function named [FUNCTION_NAME] to incorporate the unique logic from the existing function [EXISTING_FUNCTION]. Ensure that the new implementation maintains the original functionality while improving efficiency or readability. Provide the complete refactored code along with comments explaining the changes made and the rationale behind them. Additionally, include any relevant test cases to validate that the refactored function behaves as expected.

Please update the documentation for the function named [FUNCTION_NAME]. Clearly explain its purpose, including the specific inputs and outputs it handles, and provide examples of how it can be used effectively. Additionally, distinguish this function from similar functions by highlighting key differences in functionality, use cases, and performance considerations. Ensure the documentation is structured in a way that is easy to read, with headings for each section and bullet points for clarity.

Please verify that the function named [FUNCTION_NAME] is unique within the codebase. Provide a detailed comparison of any remaining similar functions, including their names, parameters, return types, and any key differences in their implementations. Additionally, explain how these differences may affect functionality or performance. Format your response in a clear table for easy reference.

Please execute functionality tests for the following functions: [FUNCTION_NAME] and [EXISTING_FUNCTION]. Ensure that both functions operate correctly after the recent changes made to the code. Provide a detailed report of the test results, including any errors encountered, the expected outcomes versus actual outcomes, and any recommendations for further improvements or fixes needed. Format the results in a clear and organized manner, highlighting any critical issues that need immediate attention.

Review the codebase for consistency regarding all references to [FUNCTION_NAME]. Ensure that each instance is correctly implemented and follows the same naming conventions and logic throughout the code. Identify any discrepancies or errors you find, and provide a detailed summary of the changes needed to achieve consistency. Include specific examples of where inconsistencies occur and suggest corrections to improve the overall quality of the codebase.

Please validate the success of the merged function by confirming that it performs as expected. I need you to run a series of tests on the merged function using the following test cases: [LIST TEST CASES HERE]. For each test case, provide the expected output and the actual output generated by the merged function. Additionally, summarize any discrepancies found and suggest potential adjustments to ensure the function meets the desired performance criteria.

Please review the documentation updates for [FUNCTION_NAME] and ensure that they are complete and accurate. Summarize any changes made and highlight key updates that are essential for understanding the function's purpose and usage. Additionally, provide the revised documentation text, ensuring it is clear, concise, and formatted for easy reference. Include any relevant examples or notes that may assist users in understanding the updates better.

Draft a rule for enforcing unique function naming conventions in CLAUDE.md. The rule should specify the criteria for naming functions, including guidelines on prefixes, suffixes, and any required patterns to ensure clarity and prevent duplication. Additionally, include examples of acceptable and unacceptable function names to illustrate the rule effectively. Format the rule in a clear and concise manner, suitable for direct inclusion in the documentation.

Create a comprehensive checklist to follow before adding new functions in a programming project. The checklist should include specific steps to identify and review any existing similar functions to prevent duplication. Additionally, outline steps for evaluating the necessity of the new function, ensuring it aligns with project goals, and confirming it adheres to coding standards. Format the checklist in bullet points for easy reference and include at least five key items to cover.

Please insert a comment above the function named [FUNCTION_NAME] that warns about potential duplication issues. The comment should clearly state the risks associated with duplicate functions, such as confusion in code maintenance and potential bugs. Additionally, include a suggestion to review the function's implementation to ensure it is necessary and not replicating existing functionality. Format the comment in a way that is consistent with standard coding practices for readability.

Help me establish a comprehensive code review protocol focused on identifying and preventing duplicate functions in our codebase. The protocol should include specific steps such as: defining criteria for what constitutes a duplicate function, outlining the review process for each code submission, and detailing how to document findings and communicate them to the development team. Additionally, suggest best practices for maintaining clean code and ensuring that all team members are trained on this protocol. Format the protocol as a clear, step-by-step guide that can be easily referenced during code reviews.

Help me create a comprehensive session opener checklist for auditing functions before adding new ones. The checklist should include specific steps to verify the uniqueness of each function, such as reviewing existing functions for overlap, assessing naming conventions to avoid duplication, and confirming the intended purpose of each function. Additionally, include guidelines for documenting findings and decisions made during the audit process. Format this checklist in a clear, organized manner with bullet points for easy reference.