Conventions Overview
Oidis enforces consistent coding standards through the Oidis Builder linter and pre-commit hooks. This section documents all rules that apply to TypeScript, SCSS, file structure, and documentation.
Pages in This Section
| Page | Purpose |
|---|---|
| Naming Conventions | Complete naming rules — classes, methods, properties, parameters, files, packages, and enums |
| TypeScript Formatting | Whitespace, punctuation, member ordering, and SCSS formatting rules enforced by the linter |
| File Headers | License header requirements for all source files (TypeScript, SCSS, JSON, HTML) |
| Vanilla vs Framework | When to use Oidis framework utilities vs vanilla TypeScript/JavaScript |
| JSDoc | JSDoc documentation rules for public APIs — approved tags, formatting, and examples |
See also: Coding Standards | Utilities Overview