Naming Conventions
File Naming Conventions
Aquiry follows a consistent file naming convention to keep the project clean, scalable, and easy to navigate. These conventions apply across ejs, SCSS, JavaScript, and asset files.
General Guidelines :
- Use lowercase letters for all file and folder names.
- Separate words with hyphens (-), not underscores (_).
- Keep names short but descriptive (avoid generic names like
new.js). - Match file names to their purpose or module for easy identification.
- For partial SCSS files, always start with an
_underscore.
| File Type | Convention | Example |
|---|---|---|
| Nodejs | Lowercase with hyphens. Pages follow the module or feature name. | dashboard-analytics.ejs, auth-login.ejs |
| SCSS / CSS | Use underscores for partials and hyphens for main files. | _variables.scss, app.scss |
| JavaScript | Lowercase with hyphens for init files, camelCase for plugin configs. | scroll-top.init.js, progressBar.js |
| Images | Use descriptive lowercase names with hyphens. | user-profile.jpg, bg-pattern.png |
| Fonts | Keep original vendor names or font family names. | Roboto-Regular.woff, remixicon.ttf |
| Config / Root Files | Always lowercase with hyphens where needed. | package.json, webpack.config.js |
Following naming conventions ensures consistency across the project, makes searching easier,
and avoids conflicts when scaling.