Awesome/awesome-copilot
1
0
Fork 0
mirror of https://github.com/github/awesome-copilot.git synced 2026-02-23 03:45:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add instructions for ColdFusion cfc and ColdFusion cfm files (#233)

Browse Source 
* Add instructions for ColdFusion cfc and cfm files

* Add ColdFusion coding standards for CFC and CFM files

* Update instructions/coldfusion-cfc-instructions.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Address Copilot AI review comments

* Fix description formatting in ColdFusion CFC and CFM instructions

* Add ColdFusion coding standards for CFC and CFM files

* Add ColdFusion coding standards for CFC and CFM files to README instructions

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: = <=>
This commit is contained in:
Nathan Stanford Sr
2025-09-10 20:18:30 -04:00
committed by GitHub
parent b469c8943d
commit 19d9a3f445
3 changed files with 60 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
instructions/coldfusion-cfc.instructions.md Normal file
View File

@@ -0,0 +1,30 @@
---
description: 'ColdFusion Coding Standards for CFC component and application patterns'
applyTo: "**/*.cfc"
---
# ColdFusion Coding Standards for CFC Files
- Use CFScript where possible for cleaner syntax.
- Avoid using deprecated tags and functions.
- Follow consistent naming conventions for variables and components.
- Use `cfqueryparam` to prevent SQL injection.
- Escape CSS hash symbols inside <cfoutput> blocks using ##
# Additional Best Practices
- Use `this` scope for component properties and methods when appropriate.
- Document all functions with purpose, parameters, and return values (use Javadoc or similar style).
- Use access modifiers (`public`, `private`, `package`, `remote`) for functions and variables.
- Prefer dependency injection for component collaboration.
- Avoid business logic in setters/getters; keep them simple.
- Validate and sanitize all input parameters in public/remote methods.
- Use `cftry`/`cfcatch` for error handling within methods as needed.
- Avoid hardcoding configuration or credentials in CFCs.
- Use consistent indentation (2 spaces, as per global standards).
- Group related methods logically within the component.
- Use meaningful, descriptive names for methods and properties.
- Avoid using `cfcomponent` attributes that are deprecated or unnecessary.
- Use ternary operators where possible
- Ensure consistent tab alignment.

28
instructions/coldfusion-cfm.instructions.md Normal file
View File

@@ -0,0 +1,28 @@
---
description: 'ColdFusion cfm files and application patterns'
applyTo: "**/*.cfm"
---
# ColdFusion Coding Standards
- Use CFScript where possible for cleaner syntax.
- Avoid using deprecated tags and functions.
- Follow consistent naming conventions for variables and components.
- Use `cfqueryparam` to prevent SQL injection.
- Escape CSS hash symbols inside <cfoutput> blocks using ##
- When using HTMX inside <cfoutput> blocks, escape hash symbols (#) by using double hashes (##) to prevent unintended variable interpolation.
- If you are in a HTMX target file then make sure the top line is: <cfsetting showDebugOutput = "false">
# Additional Best Practices
- Use `Application.cfc` for application settings and request handling.
- Organize code into reusable CFCs (components) for maintainability.
- Validate and sanitize all user input.
- Use `cftry`/`cfcatch` for error handling and logging.
- Avoid hardcoding credentials or sensitive data in source files.
- Use consistent indentation (2 spaces, as per global standards).
- Comment complex logic and document functions with purpose and parameters.
- Prefer `cfinclude` for shared templates, but avoid circular includes.
- Use ternary operators where possible
- Ensure consistent tab alignment.