EDS GitHub Guide .cursorrules prompt file
About .cursorrules prompt file
What you can build
Block Code Generator: A web application that automatically generates boilerplate code for Franklin blocks, including README.md, EXAMPLE.md, JavaScript, CSS, example JSON, and CSV files, adhering to outlined best practices.
Automated README.md Creator: A tool that creates detailed and structured READMEs for Franklin projects, ensuring compliance with the guidelines for description, usage, authoring, styling, behavior, dependencies, and accessibility.
EDS Project Linter: A code linter specifically tailored for EDS projects that checks adherence to the rules, such as the Airbnb JavaScript Style Guide, async/await usage, and named exports.
Lazy Loading Performance Analyzer: An online tool that evaluates EDS projects for efficient use of lazy loading, infinite scrolling, and other performance optimization aspects, providing targeted improvement suggestions.
JSON to CSV Converter for EDS: A service that converts JSON data into CSV format with the necessary structure for EDS blocks, ensuring smooth workflow integration.
Accessibility Checker: A browser extension that analyzes EDS block pages for accessibility compliance, checking for ARIA attributes, keyboard navigation, and screen reader friendliness.
Responsive Design Tester: A mobile-first testing application for verifying the responsiveness of CSS designs within EDS blocks across various device screens and resolutions.
Franklin Metadata Manager: A GUI-based tool that allows developers to edit and manage metadata in markdown files efficiently, ensuring adherence to EDS-specific metadata rules.
Block Variation Manager: A utility to assist in identifying and implementing block variations, encouraging reuse and efficiency by adjusting existing styles and functionality.
JS Code Comments Wizard: An AI-powered tool that scans JavaScript code and automatically adds insightful comments to explain purpose, logic, variables, and error handling for human or AI comprehension.
Benefits
- Prioritize modular block development with a clear file structure, ensuring reusability and enhanced content authoring by avoiding overload.
- Employ modern web technologies favoring vanilla JavaScript and responsive design principles, emphasizing performance, accessibility, and SEO.
- Provide comprehensive documentation and examples, including README.md and example.md files for clarity in usage and customization.
Synopsis
Developers working with Adobe Edge Delivery Services will use this prompt to create scalable, efficient Franklin projects adhering to best practices for performance and accessibility.
Overview of .cursorrules prompt
1. The .cursorrules file provides comprehensive guidelines for developers working with Adobe Edge Delivery Services (EDS) for Document Authoring, focusing on best practices for creating, optimizing, and explaining EDS projects. It covers core concepts like document-based authoring, serverless architecture, GitHub integration, and block-based development. Detailed instructions for block development are included, emphasizing a mobile-first approach, accessibility, SEO, and performance optimization. The file also provides specific structures for file organization, JavaScript, CSS, JSON, and CSV, outlines advanced features, and suggests best practices for modularity, consistent naming conventions, and more. It aims to help developers produce efficient, accessible, and high-performance websites using EDS.