Dev Patterns
Developmentdev-patternsDev Patterns is an Agent Skill for development published in the GetStream/stream-chat-react repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Styling and structure conventions for stream-chat-react. Use when adding or editing components, SCSS, or icons in this repo—file layout, styling folder structure, SCSS imports, and icon placement.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/GetStream/stream-chat-react/blob/HEAD/.cursor/skills/dev-patterns/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/dev-patterns, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
stream-chat-react Development Patterns
Apply when generating or modifying UI code in this repo.
Styling
File and folder structure
- Format:
.scssonly. - Location:
src/components/<ComponentName>/styling/. - Required: Each component styling folder has an
index.scss. - Registration: Each
src/components/<ComponentName>/styling/index.scssis imported insrc/styling/index.scsswith an alias. - Specificity: Each component has own
.scssfile in thesrc/components/<ComponentName>/stylingfolder
Import order in src/styling/index.scss:
- Three groups; within each group, alphabetical order.
- Group 1: imports from
src/styling/. - Group 2: general components (Button, Dialog, etc.).
- Group 3: chat components (MessageList, etc.).
SCSS practices
- Use full class names instead of only
&__suffixso selectors are easy to search. - Avoid duplicate blocks for the same resolved CSS selector (after nesting).
Icons
- Icons live in
src/components/Icons. - Do not move icons out of SCSS into
src/components/Icons; keep existing icon placement unless explicitly refactoring icons.
Source: .ai/DEV_PATTERNS.md.
Translating quantities (plurals)
- Use plural suffixes only:
_one,_other, and_few,_manywhere the locale requires them. - Do not add a standalone key (e.g.
"{{count}} new messages"). Only add quantified variants:"{{count}} new messages_one","{{count}} new messages_other", etc. - Follow existing patterns in
src/i18n/(e.g.{{count}} unread_one,unreadMessagesSeparatorText_other). - Locale plural rules (CLDR):
en,de,nl,tr,hi,ko,jause_one+_other;es,fr,it,ptadd_many;ruuses_one,_few,_many,_other.
Imports
When importing from 'stream-chat' library, always import by library name (from 'stream-chat'), not relative path (from '..path/to/from 'stream-chat-js/src').
React components
Try to avoid inline style attribute and prefer adding styles to .scss files.
How a plugin works in stream-chat-react
A "plugin" is just a separate build entry point that ships as a subpath export (e.g. stream-chat-react/emojis, stream-chat-react/mp3-encoder). Concretely, each plugin is wired in 4 places:
- Source folder — src/plugins// with an index.ts re-exporting its public API (see src/plugins/Emojis/index.ts).
- Vite entry — a new key in build.lib.entry in vite.config.ts:20.
- package.json — an exports subpath + a typesVersions entry (package.json:18,44).
- Styling (optional) — a styling/index.scss added as a separate sass target in the build-styling script (package.json:185), producing its own CSS file like dist/css/emoji-picker.css.