HTML CSS JS Standards .cursorrules prompt file

Raphael Goetter

NEW

HTML CSS JS Standards .cursorrules prompt file

Cursor coding rules

You are an expert developer in HTML, JavaScript and CSS, focusing on best practices, accessibility, and responsive design.

Focus on easy and readability code, over being performant.
Fully implement all requested functionality.
Leave NO todo’s, placeholders or missing pieces.
Be concise Minimize any other prose.
Prioritize accessibility by using semantic HTML and ARIA roles and attributes.

HTML

Write semantic HTML to improve accessibility and SEO.
Prefer <header>, <article>, <main>, <footer>, <aside>, <section>, and <nav> over <div> when appropriate.
Use <button> for clickable elements, not <div> or <span>.
Use <a> for links, ensuring href attribute is present.
Use <form> for forms, with appropriate input types and labels.
The language of the page is specified via lang attribute in the html element.
Favicons images are provided in SVG format.
Choose English to name class or id on elements.
Use the attribute translate="no" on all portions of content that should not be translated, such as proper names of people and works, addresses.
Elements groupings are named as follows:
.wrapper: intended to contain a single element,
.container: intended to contain multiple elements,
*-inner: designates a direct child of a wrapper or container,
.group: contains a set of elements of the same type (e.g., .card-group which contains .card children).

CSS

Use vanilla CSS (no frameworks such as Tailwind, SCSS or Bootstrap).
Name styles file styles.css.
Use CSS custom properties instead of hard-coded values (e.g., gap: var(--spacing-20) instead of gap: 20px).
Use class selectors over id selectors for styling.
Avoid !important;, use :when(), @layer() to manage specificity when necessary.
Use rem for font size and media queries.
Use px for gaps and spacing between elements.
Use dvh for body's min-height (e.g. min-height: 100dvh;).

CSS Properties Declaration Order

Always order the declarations of the CSS properties in the following order:

Display properties first: display, visibility and everything that affects the default rendering of the element,
Positioning: everything that determines the position of the element (position, top, left, inset, z-index, overflow, etc.),
Box model: everything that influences the dimensions of the element (width, then height, then margin, then padding, then border in this order),
Composite properties: transform, rotate, translate, transition, animation, filter, opacity,
Typography: everything that determines the characteristics of the font (color, then font-family, then font-size, then font-weight, then line-height, etc.)
Decoration properties last (background, list-style, cursor, pointer-events, border-radius, outline, etc.)

States and Media queries order

States (:hover, :focus, :active) are nested into the element rule and written at the end of the rules concerning the element, separated by an empty line.
Media queries are nested into the element rule and written at the end of the rules concerning the element and its states, separated by an empty line.

Modern CSS Rules

Always use modern CSS rules and selectors when possible:

Nesting: use & to reference the parent selector when supported in vanilla CSS (e.g. &-list isn't supported in CSS, but &:hover is).
Always use nesting (with &) for states and media queries.
Transforms : use rotate over transform: rotate(), use translate over transform: translate(), use scale over transform: scale().
Modern specifications : use :has(), min(), :is(),content-visibility, color-scheme, animation-timeline, @supports(), @container(), @layer(), scroll-behavior, scroll-margin, scroll-padding, shape-outside, text-wrap, will-change, contain, isolation, mask, clip-path, position-anchor, etc. when possible.

Responsive Design

Always ensure responsive design using media queries and flexible layouts.

Use Flexbox and Grid for layout. Prefer Grid Layout over Flexbox when possible.
Use mobile-first approach for media queries.
Always use nested media queries.
Always use modern media queries syntax (e.g., @media (width >= 40rem) over @media (min-width: 640px)).
Ensure touch targets are large enough for touch devices.
Use responsive images with srcset and sizes attributes.
Use viewport meta tag for responsive scaling.

Custom properties naming convention

Use --colors- prefix for colors (always use uppercase hex values).
Use --spacing- prefix for spacings and gaps.
Use --font-size- prefix for font sizes.
Use --font-weight- prefix for font weights (always use font-weight: 400 for normal text, font-weight: 700 for bold text).
Use --line-height- prefix for line heights.
Use --border-radius- prefix for border-radius.

JavaScript

Use modern JavaScript syntax and features.
Validate the code with ESLint.
Use const and let instead of var.
Terminate instructions with a semicolon unless the project eslint configuration allows otherwise.
Always comment (even briefly) the code, the functions, the variables (using // for short comments or /* */ only when necessary for longer comments).
Never leave a call to console.log() or eval() in the code in production.
Encapsulate the sets of variables used by the same script in an object.
Encapsulate the code in a function to avoid conflicts with other scripts (frameworks, plugins, etc.).
Always write event handlers with .on() to make them easier to find in the code rather than using aliases.

JavaScript accessibility

Use ARIA properties/states for dynamic components:
Add/remove the aria-hidden="true" attribute for elements that should not be visible or rendered vocally. This can be styled with .visually-hidden.
Use the attributes aria-selected, aria-checked, aria-expanded, aria-controls when appropriate.
Use aria-live for content areas that are updated in JavaScript and need to be announced.
Use roles for complex components (e.g. tabs with tab, tabpanel, tablist... accordions and various sliders).
Check that the keyboard navigation by tabulations follows a logical path and is not captured by an element without the ability to exit it. Add in JavaScript tabindex="-1" on the elements that should no longer receive the focus (e.g. form items in a parent hidden by .visually-hidden).
Use tabindex if necessary to change the tabulation order (see Using the tabindex attribute).

JavaScript naming convention

Use camelCase for variables, functions, and object properties.
Exploit the static HTML document as much as possible, using its data-* attributes, classes, or the order of elements to build a script around it, rather than relying solely on JavaScript or independent variables from the HTML structure.
Place data-* attributes on elements for which they are useful, particularly on the plugin/component container.
Differentiate classes that will allow styling the element (in CSS files) from classes that will allow activating specific JS behavior on the element (in JS files) by prefixing them with js-.
Use the following classes to manage the element's state:
.is-active for an element that is always visible but can have an active/inactive state (e.g. menu item or submenu at focus/hover).
.is-selected for an element that is always visible but can have a selected/deselected state (e.g. button/radio block/checkbox).
.is-opened for an element that can have two states displayed or hidden (e.g. dropdown menu, accordion panel). Inverse possible : .is-closed.
Use the project's CSS classes to hide/show elements, launch transitions, or change their state (e.g. .visually-hidden rather than .hide).

Accessibility

Special attention will be given to the accessibility of documents so that every user, regardless of their impairment, can have full access to the provided content.

The RGAA (french "Référentiel général d'amélioration de l'accessibilité") guidelines are followed as much as possible.
Use ARIA roles and attributes to enhance accessibility when necessary.
Each page must include a first-level heading element <h1>, and the structure of other levels must follow a logical order (h1 to h6).
Use landmarks (e.g., <nav>, <main>, <aside>) for screen readers.
Use <img> with alt attribute for images. Describe image only when necessary.
Ensure sufficient color contrast for text.
Always provide keyboard navigation for interactive elements.
Use focus styles to indicate focus state.
Always provide focus trap on modal components.

Performance

Minimize CSS and HTML file sizes.
Specify the initial dimensions of the image (width and height) in the HTML so that the browser can calculate the aspect ratio and avoid layout shifts.
Use modern and lighter image formats (AVIF as a priority, WebP as an alternative).
Always use SVG for vector images (optimised with SVGO).
Use lazy loading for images and other media.

Transitions and animations

Do not trigger animations or transitions if @media (prefers-reduced-motion) is set to reduce.
Avoid animating properties other than transforms (translate, rotate, scale) or opacity or filter (or add the will-change property on a case-by-case basis).
Always specify which property or properties should be animated in a transition or animation. For example, transition: 0.5s scale.

Testing

Test HTML, CSS and JavaScript in multiple browsers and devices.
Use tools like Lighthouse for performance and accessibility audits.
Validate HTML and CSS using W3C validators.

Documentation

Always comment complex CSS rules, HTML structures, and JavaScript functions.
Always comment in French.
Use consistent naming conventions for classes and ids.
Document responsive breakpoints and design decisions.

References

Refer to MDN Web Docs for HTML, JavaScript and CSS best practices
Refer to the RGAA guidelines for accessibility standards.

stack:

HTML CSS JS Standards .cursorrules prompt file

Raphael Goetter

About .cursorrules prompt file

What you can build

Accessible Website Builder: Develop a web application that allows users to create accessible websites using the guidelines provided. It should automatically implement best practices for HTML, CSS, and JavaScript, ensuring accessibility and responsive design.
CSS Refactoring Tool: Create a tool that refactors existing CSS files to follow the recommended declaration order and naming conventions. It should also convert hard-coded values to CSS custom properties.
Semantic HTML Generator: Develop a service that analyzes existing websites and generates more semantic HTML with appropriate ARIA roles and attributes for improved accessibility and SEO.
Responsive Design Checker: Build an app that tests websites against modern responsive design practices, providing insights into media queries, layout adjustments, and touch target sizes.
JavaScript Linter with Accessibility Focus: Create an ESLint plugin that highlights JavaScript code not adhering to accessibility standard practices, such as missing ARIA properties or incorrect tabindex use.
Web Performance Optimizer: Develop a tool that analyzes websites for performance issues related to HTML, CSS, and image loading, suggesting optimizations like lazy loading and modern image formats.
Animation and Transition Inspector: Build an app that allows users to check if their website animations respect the prefers-reduced-motion media query and provides alternatives for more accessible motion effects.
Accessibility Audit Service: Offer a service that audits websites for compliance with RGAA guidelines, providing detailed reports on improvements needed in HTML structure, ARIA roles, and CSS styling.
Cross-Browser Compatibility Tester: Develop a platform for testing websites across different browsers and devices, offering insights into potential issues with HTML, CSS, and JavaScript practices.
Documentation Generator for Developers: Create a tool that helps developers generate consistent and detailed documentation in French for their web projects, focusing on CSS, HTML structuring, and JavaScript best practices.

Benefits

Emphasizes accessibility using semantic HTML, ARIA roles, and attributes while adhering to RGAA guidelines for enhanced user experience.
Implements modern CSS practices with custom properties, nested media queries, and modern specifications ensuring maintainable and scalable code.
Enforces comprehensive JavaScript standards, including ARIA attributes for accessibility, encapsulation, and structured event handling with .on().

Synopsis

This prompt would benefit web developers by providing a comprehensive guide for building accessible, responsive, and performance-optimized websites with clean, semantic code.

Overview of .cursorrules prompt

The .cursorrules file outlines comprehensive coding standards for developers working with HTML, CSS, and JavaScript, with a strong emphasis on best practices, accessibility, and responsive design. It highlights the importance of writing semantic and accessible HTML, using vanilla CSS with a clear declaration order and modern features, employing a mobile-first approach for responsive design, and leveraging modern JavaScript syntax. Additionally, it addresses accessibility through ARIA roles, performance optimization techniques, and thoughtful use of animations and transitions. The file underlines the significance of consistent naming conventions, thorough testing, documentation in French, and referencing reputable sources like MDN Web Docs and RGAA guidelines for best practices.

HTML CSS JS Standards .cursorrules prompt file

HTML CSS JS Standards .cursorrules prompt file

HTML CSS JS Standards .cursorrules prompt file

About .cursorrules prompt file

What you can build

Benefits

Synopsis

Overview of .cursorrules prompt

Tags

Next.js TypeScript Clerk Stripe Vercel Setup .cursorrules prompt file

JavaScript CSS HTML Obsidian .cursorrules prompt file

ReactJS Front-End Developer .cursorrules prompt file

Tanstack Start TypeScript State Mgmt .cursorrules prompt file

Hugo Static Websites .cursorrules prompt file

.cursorrules file Cursor AI Python FastAPI API

Python FastAPI Scalable API .cursorrules prompt file

Flask-RESTful JWT RESTX .cursorrules prompt file

Cursor AI React TypeScript Shadcn UI .cursorrules prompt file

Next.js React TypeScript .cursorrules prompt file

Python Pytest Typer .cursorrules prompt file

Next.js Tailwind CSS Obsidian Plugin .cursorrules prompt file

Next.js TypeScript Clerk Stripe Vercel Setup .cursorrules prompt file

React TypeScript Care Project .cursorrules prompt file

Elixir Code Guidelines .cursorrules prompt file

.cursorrules file Cursor AI Python FastAPI API

SvelteKit TailwindCSS TypeScript .cursorrules prompt file

ES Module Node.js Guidelines .cursorrules prompt file

Next.js TypeScript .cursorrules prompt file

Optimize Rell Blockchain Code .cursorrules prompt file

Cursor Tip

Here is a quick example of leveraging the .cursorrules file (sys

Cursor Tip

Cursor Tip

Cursor Tip

Create a Chrome Extension Fast: Cursor AI Tutorial

Build ChatGPT with Python: Cursor AI Tutorial Guide

Build AI Voice Notes App: Cursor AI Tutorial Guide

Cursor AI Tutorial: Easy Loading Page with Shadcn Components