forked from AABoyles/MicrobeTrace
-
Notifications
You must be signed in to change notification settings - Fork 42
zForDevelopers – Nomenclature
Evan Moscoso edited this page Jun 6, 2025
·
2 revisions
Please note that this page is for developers and likely does not contain any information relevant to users of MicrobeTrace.
MicrobeTrace is now built with [Angular](https://angular.io/) and [TypeScript](https://www.typescriptlang.org/). The following conventions describe how names are structured across templates, styles, and code.
In general, everything should have context‑revealing names.
MicrobeTrace uses [Bootstrap 4.6](https://getbootstrap.com/) along with Angular templates. Naming for HTML elements aims to remain consistent with Bootstrap conventions.
-
id
andclass
attributes use all‑lower‑case, hyphen‑delimited names (kebab‑case). - Angular component selectors should also be kebab‑case.
- Avoid underscores or spaces within CSS classes and IDs.
- Functions, variables and object property names use [camelCase](https://lodash.com/docs#camelCase).
- Classes (including Angular components and services) use [PascalCase](https://en.wikipedia.org/wiki/Pascal_case).
- Constants intended for global use may be written in
UPPER_SNAKE_CASE
.
- Custom DOM events emitted by MicrobeTrace use kebab‑case (e.g.,
node-selected
). - Angular
EventEmitter
outputs follow camelCase to match Angular style.
Copyright 2017-2020 Centers for Disease Control and Prevention • Acknowledgements