Adorable 2BR in the sunny Mission
146 |
147 |
149 | Vestibulum id ligula porta felis euismod semper.
148 || 896 | ✅ DO THIS 897 | | 898 |899 | ❌ NOT THIS 900 | | 901 |
|---|---|
906 |
907 | stuff = myCFC.getStuff();
908 | myCFC.setStuff( stuff );
909 |
910 | |
911 |
912 |
913 |
914 | stuff = myCFC.stuff;
915 | myCFC.stuff = stuff;
916 |
917 | |
918 |
919 |
| 961 | ✅ DO THIS 962 | | 963 |964 | ❌ NOT THIS 965 | | 966 |
|---|---|
971 |
972 | <cffunction name="myFunction" access="public" returntype="void" output="false" hint="This methods does nothing">
973 | <cfset var i = 0>
974 | <cfset var qGet = "">
975 | <cfquery name="qGet">
976 | </cfquery>
977 | <cfloop from="1" to ="20" index="i">
978 | </cfloop>
979 | </cffunction>
980 |
981 | |
982 |
983 |
984 |
985 | <cffunction name="myFunction" access="public" returntype="void" output="false" hint="This methods does nothing">
986 | <cfquery name="qGet">
987 | </cfquery>
988 | <cfloop from="1" to ="20" index="i">
989 | </cfloop>
990 | </cffunction>
991 |
994 | |
995 |
996 |
| 1082 | ✅ DO THIS 1083 | | 1084 |1085 | ❌ NOT THIS 1086 | | 1087 |
|---|---|
1092 |
1093 | <cflock name="FileOperation" timeout="20" throwOnTimeout="true">
1094 | <cffile action="write" file="#filePath#" output="#content#">
1095 | </cflock>
1096 |
1097 | <cflock type="readonly" scope="application" timeout="10" throwOnTimeout="true">
1098 | <cfset myVar = application.cache.getValue("x")>
1099 | </cflock>
1100 | <cfquery name="variables.qUser" datasource="#request.dsn#">
1101 | SELECT FirstName, LastName
1102 | FROM Users
1103 | WHERE UserID = #request.UserID#
1104 | </cfquery>
1105 | <cflock scope="application" timeout="2" type="exclusive">
1106 | <cfset application.qUser=variables.qUser>
1107 | </cflock>
1108 |
1109 | |
1110 |
1111 |
1112 |
1113 | <cflock name="FileOperation" >
1114 | <cffile action="write" file="#filePath#" output="#content#">
1115 | </cflock>
1116 | <cfset myVar = application.cache.getValue("x")>
1117 | <cflock scope="application" timeout="2" type="exclusive">
1118 | <cfquery name="application.qUser" datasource="#request.dsn#">
1119 | SELECT FirstName, LastName
1120 | FROM Users
1121 | WHERE UserID = #request.UserID#
1122 | </cfquery>
1123 | </cflock>
1124 |
1127 | |
1128 |
1129 |
| 1142 | ✅ DO THIS 1143 | | 1144 |1145 | ❌ NOT THIS 1146 | | 1147 |
|---|---|
1152 |
1153 | <cfif not structKeyExists(application,"controller")>
1154 | <cflock name="mainControllerCreation" timeout="20" throwOnTimeout="true" type="exclusive">
1155 | <cfif not structKeyExists(application,"controller")>
1156 | <cfset application.controller = createObject("component","coldbox.MainController").init()>
1157 | </cfif>
1158 | </cflock>
1159 | </cfif>
1160 |
1161 | |
1162 |
1163 |
1164 |
1165 | <cfif not structKeyExists(application,"controller")>
1166 | <cflock name="mainControllerCreation" timeout="20" throwOnTimeout="true" type="exclusive">
1167 | <cfset application.controller = createObject("component","coldbox.MainController").init()>
1168 | </cflock>
1169 | </cfif>
1170 |
1173 | |
1174 |
1175 |
| 1189 | ✅ DO THIS 1190 | | 1191 |1192 | ❌ NOT THIS 1193 | | 1194 |
|---|---|
1199 |
1200 | <cfset name = request.firstname>
1201 | <cfif isValid></cfif>
1202 | <cfset SomeVar = Var1 + Max(Var2, 10* Var3) + Var4>
1203 |
1204 | |
1205 |
1206 |
1207 |
1208 | <cfset name = #request.firstname#>
1209 | <cfif #isValid#></cfif>
1210 | <cfset #SomeVar# = #Var1# + #Max(Var2, 10* Var3)# + #Var4#>
1211 |
1212 | |
1213 |
1214 |
| 1236 | ✅ DO THIS 1237 | | 1238 |1239 | ❌ NOT THIS 1240 | | 1241 |
|---|---|
1246 |
1247 | if( structKeyExists( arguments, "car" ) )
1248 | if( arguments.exists( "car" ) )
1249 |
1250 | |
1251 |
1252 |
1253 |
1254 | if( isDefined("arguments.car") )
1255 |
1257 | |
1258 |
1259 |
| 1271 | ✅ DO THIS 1272 | | 1273 |1274 | ❌ NOT THIS 1275 | | 1276 |
|---|---|
1281 |
1282 | <cfset value = form[ "field#i#" ]>
1283 |
1284 | |
1285 |
1286 |
1287 |
1288 | <cfset value = evaluate("form.field#i#")>
1289 |
1290 | |
1291 |
1292 |
| 1302 | ✅ DO THIS 1303 | | 1304 |1305 | ❌ NOT THIS 1306 | | 1307 |
|---|---|
1312 |
1313 | <cfif len(firstName)></cfif>
1314 | <cfif NOT obj.isEmpty()></cfif>
1315 | <cfif query.recordcount></cfif>
1316 | <cfif arrayLen(myArray)></cfif>
1317 |
1318 | |
1319 |
1320 |
1321 |
1322 | <cfif firstName eq ""></cfif>
1323 | <cfif obj.isEmpty() eq false></cfif>
1324 | <cfif query.recordcount gt 0></cfif>
1325 | <cfif arrayLen(myArray) gt 0></cfif>
1326 |
1327 | |
1328 |
1329 |
| 1339 | ✅ DO THIS 1340 | | 1341 |1342 | ❌ NOT THIS 1343 | | 1344 |
|---|---|
1349 |
1350 | <cfoutput>
1351 | <html>
1352 | <head>
1353 | #head#
1354 | </head>
1355 | <body>
1356 | #leftBar#
1357 | #content#
1358 | #footer#
1359 | </body>
1360 | </html>
1361 | </cfoutput>
1362 |
1363 | |
1364 |
1365 |
1366 |
1367 | <html>
1368 | <head>
1369 | <cfoutput>#head#</cfoutput>
1370 | </head>
1371 | <body>
1372 | <cfoutput>#leftBar#</cfoutput>
1373 | <cfoutput>#body#</cfoutput>
1374 | <cfoutput>#footer#</cfoutput>
1375 | </body>
1376 | </html>
1377 |
1380 | |
1381 |
1382 |
| 4 | ✅ DO THIS 5 | | 6 |7 | ❌ NOT THIS 8 | | 9 |
|---|---|
14 |
15 |
16 |
17 | |
18 |
19 |
20 |
21 |
22 |
23 | |
24 |
25 |
26 | "Idempotent operation means that it can be repeated without causing any errors or inconsistencies if the operation is carried out once or many times". 27 |28 | 29 | Thanks to Roger Benningfield: 30 | 31 |
32 | "Allowing GET requests to change the state of server resources can be a very dangerous game, without so much as a whiff of malicious behavior. An app that allows clients to change or delete data just by fetching a URI is asking for trouble in 2020." 33 | 34 |35 | 36 | There is a time for using `GET` and a time for using `POST,PUT,DELETE` and **NONE OF THEM should trust the client data**. 37 | 38 | **[[⬆]](#TOC)** 39 | 40 | ## Protecting Your Code 41 | 42 | As for security, FORM variables are just as easy to modify as URL variables. However, there are several ways to protect from attacks, SQL injection or plain mischief: 43 | 44 | * `
4 |
5 | This repository includes all of the Ortus coding style guides, linter and formatting configurations. Read, collaborate and enjoy.
6 |
7 | ## Guides
8 |
9 | * [ColdFusion](guides/coldfusion.md)
10 | * [CSS-SASS](guides/css-sass.md)
11 | * [Database](guides/database.md)
12 | * [JavaScript](guides/javascript.md)
13 | * [Security](guides/security.md)
14 |
15 |
16 | ## Linters
17 |
18 | * [CFlint](linters/.cflintrc) - Leverages the cflint project (`box install commandbox-cflint`)
19 | * [CFlint ColdBox Handlers](linters/.cflintrc-handlers) - Specific linting of ColdBox Handlers
20 | * [Editorconfig](linters/.editorconfig) - Leverages the EditorConfig Plugins for your IDE
21 | * [ESLint](linters/.eslintrc.json) - ESLinting of JavaScript and Vue files.
22 | * [JSBeautify](linters/.jsbeautifyrc)
23 | * [JSHint](linters/.jshintrc)
24 | * [SASS](linters/.sass-lint.yml)
25 |
26 | ## Formatters
27 |
28 | * [ColdFusion - CFFormat](formatters/.cfformat.json)
29 | * [ColdFusion - Submlime](formatters/cfml_format.sublime-settings)
30 | * [Java - Eclipse/VSCode](formatters/ortus-java-style.xml)
31 |
32 |
33 | ## IDE Automatic Coding Standards
34 |
35 | We also provide ways to apply our formatting rules automatically via modern IDEs.
36 |
37 | ### CommandBox Formatting
38 |
39 | Start off by installing the cfformat CommandBox package: `box install commandbox-cfformat`. Then in the root of your application if you have a `box.json` open it. If you don't, then initialize your application as a CommandBox package: `box init`. Then open the file and look for a `scripts` section, if you don't have one, then add it. We will create three scripts to format your source code:
40 |
41 | * `format` : Format all the files/directories you want
42 | * `format:watch` : Start a watcher for all the files/directories you want and if a save is detected, automatically format the changed files.
43 | * `format:check` : Verifies if the watched files/directories adhere to your style guides.
44 |
45 | ```js
46 | scripts : {
47 | "format" : "cfformat run handlers/,interceptors/,models/,test-harness/tests/specs,ModuleConfig.cfc --overwrite",
48 | "format:watch" : "cfformat watch handlers/,interceptors/,models/,test-harness/tests/specs,ModuleConfig.cfc ./.cfformat.json",
49 | "format:check" : "cfformat check handlers/,interceptors/,models/,test-harness/tests/specs,ModuleConfig.cfc",
50 | }
51 | ```
52 |
53 | Then you can run a watcher: `box run-script format:watch` and everytime you save a change in the files being watched, the formatter will automatically format the CFML code.
54 |
55 |
56 | ### VSCode ESLint
57 |
58 | We are using ESLint as our standards for formatting and linting for JavaScript and Vue files. You can follow this guide to setup your VSCode editor for formatting and linting: [Setup VSCode](https://www.digitalocean.com/community/tutorials/linting-and-formatting-with-eslint-in-vs-code)
59 |
60 |
61 | ### Sublime
62 |
63 | If you use Sublime as your IDE, you can install the `CFML` package and use the built-in formatter to help you format CFML files according to our standards. Just open the **Format Settings** and paste in the [Sublime Settings](formatters/cfml_format.sublime-settings) contents. Then you can use the shortcut for it according to OS to execute it. You can read it here: https://github.com/jcberquist/sublimetext-cfml#code-formatting
64 |
65 | 
66 |
67 | The CFML Format operation is a manual command in Sublime by default. To make it automatic, install the "Hooks" (https://packagecontrol.io/packages/Hooks) plugin for Sublime and then add the following hook to your Syntax specific settings for CFML. To get to the Syntax specific settings, open a CFM or CFC file in Sublime then select the menu item Sublime Text > Preferences > Syntax - Specific Settings
68 |
69 | ```json
70 | // These settings override both User and Default settings for the cfml
71 | syntax
72 | {
73 | "on_pre_save_language": [
74 | {
75 | "command": "cfml_format",
76 | "args": {
77 | "current_method": false
78 | }, }
79 | ] }
80 | ```
81 |
82 |
83 | ---
84 |
85 | **Copyright Ortus Solutions Corp**
86 |
87 | If otherwise noted, this content is property of Ortus Solutions, Corp.
88 |
89 | > Soli Deo Gloria
90 |
--------------------------------------------------------------------------------
/resources/ortus-spaceman.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Ortus-Solutions/coding-standards/f73c446f917264598c80531c89499df8573fc90a/resources/ortus-spaceman.jpg
--------------------------------------------------------------------------------
/resources/sublime-format-settings.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Ortus-Solutions/coding-standards/f73c446f917264598c80531c89499df8573fc90a/resources/sublime-format-settings.png
--------------------------------------------------------------------------------
/resources/vscode-beautify-settings.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Ortus-Solutions/coding-standards/f73c446f917264598c80531c89499df8573fc90a/resources/vscode-beautify-settings.png
--------------------------------------------------------------------------------