|
|
|
# Coding Style Guides & Development Tools
|
|
|
|
|
|
|
|
This document governs how your code should **look** rather than how it should **function** (function is the province of the [CFML Development Guide](https://gitlab.inleague.io/content/guides-and-documents/-/wikis/CFML-Development-Guide).
|
|
|
|
|
|
|
|
The starting point for CFML style is the [Ortus Solutions Coding Standards](https://github.com/Ortus-Solutions/coding-standards), but not every "rule" is as important as every other rule, and not all of them are enforced. We'll try to break down the most important areas where we we either agree and feel that it's very important, or else where we do things differently.
|
|
|
|
|
|
|
|
## Front-end Style Guides
|
|
|
|
|
|
|
|
* [VueJS (v2) Style Guide](https://vuejs.org/v2/style-guide/)
|
|
|
|
|
|
|
|
## Development Tools
|
|
|
|
|
|
|
|
[VSCode](https://code.visualstudio.com/) is the official IDE for inLeague. We like [Sublime Text](https://www.sublimetext.com/3) as well, but Sublime (or any other editor) should be used in conjunction with VSCode. We recommend the following VSCode extensions:
|
|
|
|
|
|
|
|
* CFML (by KamasamaK)
|
|
|
|
* Bracket Pair Colorizer 2
|
|
|
|
* Docker
|
|
|
|
* Docker Compose
|
|
|
|
* Vetur
|
|
|
|
* DotENV
|
|
|
|
* GitLens
|
|
|
|
* Highlight Matching Tag
|
|
|
|
* Live Share
|
|
|
|
* SQL Server (mssql)
|
|
|
|
* Swagger Viewer
|
|
|
|
* Beautify
|
|
|
|
* vscode-coldbox
|
|
|
|
* vscode-testbox
|
|
|
|
|
|
|
|
### VSCode Keyboard Shortchuts
|
|
|
|
|
|
|
|
* [VSCode Shortcuts - Windows](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf)
|
|
|
|
* [VSCode Shortcuts - Linux](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf)
|
|
|
|
* [VSCode Shortcuts - MacOS](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf) |
|
|
|
\ No newline at end of file |