Add instructions for ColdFusion cfc and ColdFusion cfm files (#233)
* 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
GitHub
parent
b469c8943d
commit
19d9a3f445
@ -26,6 +26,8 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
||||
| [Blazor](instructions/blazor.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fblazor.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fblazor.instructions.md) | Blazor component and application patterns |
|
||||
| [Clojure Memory](instructions/clojure-memory.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fclojure-memory.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fclojure-memory.instructions.md) | Things agents tend to forget or get wrong when they are working with Clojure projects. |
|
||||
| [Cmake Vcpkg](instructions/cmake-vcpkg.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcmake-vcpkg.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcmake-vcpkg.instructions.md) | C++ project configuration and package management |
|
||||
| [ColdFusion Coding Standards for CFC Files](instructions/coldfusion-cfc.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcoldfusion-cfc.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcoldfusion-cfc.instructions.md) | ColdFusion Coding Standards for CFC component and application patterns |
|
||||
| [ColdFusion Coding Standards](instructions/coldfusion-cfm.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcoldfusion-cfm.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcoldfusion-cfm.instructions.md) | ColdFusion cfm files and application patterns |
|
||||
| [Containerization & Docker Best Practices](instructions/containerization-docker-best-practices.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcontainerization-docker-best-practices.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcontainerization-docker-best-practices.instructions.md) | Comprehensive best practices for creating optimized, secure, and efficient Docker images and managing containers. Covers multi-stage builds, image layer optimization, security scanning, and runtime best practices. |
|
||||
| [Conventional Commit](instructions/conventional-commit.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md) | Prompt and workflow for generating conventional commit messages using a structured XML format. Guides users to create standardized, descriptive commit messages in line with the Conventional Commits specification, including instructions, examples, and validation. |
|
||||
| [Convert Spring JPA project to Spring Data Cosmos](instructions/convert-jpa-to-spring-data-cosmos.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md) | Step-by-step guide for converting Spring Boot JPA applications to use Azure Cosmos DB with Spring Data Cosmos |
|
||||
|
||||
30
instructions/coldfusion-cfc.instructions.md
Normal file
30
instructions/coldfusion-cfc.instructions.md
Normal 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
28
instructions/coldfusion-cfm.instructions.md
Normal 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.
|
||||
Loading…
x
Reference in New Issue
Block a user