coldfusion-cfc — правило для GitHub Copilot: стандарты CFC
Правило задаёт Copilot стандарты кода для ColdFusion-компонентов: CFScript, cfqueryparam, аккуратные геттеры и сеттеры. Пригодится, если в проекте есть файлы .cfc.
.github/instructions/coldfusion-cfc.instructions.mdЧто делает coldfusion-cfc
Правило подключается к файлам по маске **/*.cfc и подсказывает агенту, как писать компоненты. Основные требования: использовать CFScript вместо тегов, не трогать устаревшие теги и функции, держать единый стиль имён для переменных и компонентов. Для защиты от SQL-инъекций — cfqueryparam. Внутри блоков <cfoutput> хеш CSS экранируется через ##.
Дальше идут практики уровня компонента. Свойства и методы описываются в области this, функции получают модификаторы доступа (public, private, package, remote), а связи между компонентами строятся через внедрение зависимостей. Геттеры и сеттеры остаются простыми, без бизнес-логики. Входные параметры публичных и удалённых методов проверяются и очищаются, ошибки ловятся через cftry/cfcatch. Конфигурацию и учётные данные в CFC не зашивают.
Отступ — 2 пробела, тернарные операторы приветствуются, связанные методы группируются рядом. Каждая функция документируется с назначением, параметрами и возвращаемым значением. Файл кладётся в .github/instructions/coldfusion-cfc.instructions.md — без него правило не подхватится.
Какие задачи решает
- привести компоненты
.cfcк одному стилю кода - закрыть SQL-инъекции через
cfqueryparam - убрать устаревшие теги и функции из кодовой базы
- описать функции с параметрами и возвращаемыми значениями
- вынести конфигурацию и учётные данные из компонентов
Примеры запросов агенту
- напиши новый CFC для работы с заказами по стандартам проекта
- проверь этот
.cfcна устаревшие теги и добавьcfqueryparamв запросы - отрефактори геттеры и сеттеры, убери из них бизнес-логику
Как установить coldfusion-cfc
Вручную: положить файлы
.github/instructions/coldfusion-cfc.instructions.mdПоле applyTo задаёт, к каким файлам применять
Вручную: положить файлы
.claude/rules/coldfusion-cfc.mdПоле paths во frontmatter ограничивает файлы: applyTo из источника → paths
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.cursor/rules/coldfusion-cfc.mdcВо frontmatter: description, globs, alwaysApply. applyTo из источника → globs, иначе правило само не подключится
Вручную: положить файлы
.devin/rules/coldfusion-cfc.mdВручную: положить файлы
.clinerules/coldfusion-cfc.mdПо шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать
Из того же набора674
Весь набор →Похожие
Рядом в теме «Языки программирования»
Все правила IDE по теме «Языки программирования» →Вопросы о coldfusion-cfc
Как установить coldfusion-cfc в GitHub Copilot?
Создайте файл .github/instructions/coldfusion-cfc.instructions.md в репозитории и перенесите туда содержимое правила. Copilot подхватит его для файлов по маске **/*.cfc.
Что делает coldfusion-cfc?
Задаёт стандарты написания ColdFusion-компонентов: CFScript, модификаторы доступа, внедрение зависимостей, проверка входных параметров и обработка ошибок.
Нужен ли ColdFusion-проект, чтобы правило сработало?
Правило применяется к файлам .cfc, поэтому смысл появляется только в проекте с ColdFusion-компонентами. В остальных репозиториях оно просто не найдёт целей.
Исходный текст
coldfusion-cfc.instructions.md · MIT
--- 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.
© github · MIT · github/awesome-copilot