OpenDream Linting (#930)

* OpenDream Linting

Co-authored-by: MrMelbert <[email protected]>

* pish

* patchover

* Push updated pragmas

* fuck

* Guh:tm:

---------

Co-authored-by: MrMelbert <[email protected]>

Author: francinum

.github/workflows/ci_suite.yml

@@ -67,6 +67,25 @@ jobs:
         if: steps.linter-setup.conclusion == 'success' && !cancelled()
         run: tools/build/build --ci lint tgui-test
 
+  odlint:
+    if: ( !contains(github.event.head_commit.message, '[ci skip]') )
+    name: "Lint with OpenDream"
+    runs-on: ubuntu-22.04
+    concurrency:
+      group: odlint-${{ github.head_ref || github.run_id }}
+      cancel-in-progress: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: robinraju/[email protected]
+        with:
+          repository: "OpenDreamProject/OpenDream"
+          tag: "latest"
+          fileName: "DMCompiler_linux-x64.tar.gz"
+          extract: true
+      - name: Run OpenDream
+        run: |
+          ./DMCompiler_linux-x64/DMCompiler daedalus.dme --suppress-unimplemented --define=CIBUILDING
+
   compile_all_maps:
     if: ( !contains(github.event.head_commit.message, '[ci skip]') )
     name: Compile Maps

.gitignore

@@ -208,7 +208,10 @@ libprof.so
 # Screenshot tests
 /artifacts
 
+# Running OpenDream locally
+daedalus.json
+
 # Codex Database
 codex.db
 codex.db-shm
-codex.db-wal
+codex.db-wal

.vscode/launch.json

@@ -15,6 +15,12 @@
 			"preLaunchTask": "Build All",
 			"dmb": "${workspaceFolder}/${command:CurrentDMB}",
 			"dreamDaemon": true
+		},{
+			"type": "opendream",
+			"request": "launch",
+			"name": "OpenDream",
+			"preLaunchTask": "OpenDream: compile ${command:CurrentDME}",
+			"json_path": "${workspaceFolder}/${command:CurrentJson}"
 		}
 	]
 }

.vscode/tasks.json

@@ -89,6 +89,14 @@
 			],
 			"group": "build",
 			"label": "tgui: sonar"
+		},
+		{
+			"type": "opendream",
+			"problemMatcher": [
+				"$openDreamCompiler"
+			],
+			"group": "build",
+			"label": "OpenDream: compile daedalus.dme"
 		}
 	]
 }

code/_compile_options.dm

@@ -187,7 +187,7 @@
 #warn compiling in TESTING mode. testing() debug messages will be visible.
 #endif
 
-#ifdef CIBUILDING
+#if defined(CIBUILDING) && !defined(OPENDREAM)
 #define UNIT_TESTS
 #endif
 
@@ -214,12 +214,17 @@
 #define CBT
 #endif
 
-#if !defined(CBT) && !defined(SPACEMAN_DMM)
-#warn Building with Dream Maker is no longer supported and will result in errors.
-#warn In order to build, run BUILD.bat in the root directory.
-#warn Consider switching to VSCode editor instead, where you can press Ctrl+Shift+B to build.
-//Hi, Hijacking this to do DMEd-Specific Icon Overrides
-#define SIMPLE_MAPHELPERS
+#if defined(OPENDREAM)
+	#if !defined(CIBUILDING)
+		#warn You are building with OpenDream. Remember to build TGUI manually.
+		#warn You can do this by running tgui-build.cmd from the bin directory.
+	#endif
+#else
+	#if !defined(CBT) && !defined(SPACEMAN_DMM)
+		#warn Building with Dream Maker is no longer supported and will result in errors.
+		#warn In order to build, run BUILD.cmd in the root directory.
+		#warn Consider switching to VSCode editor instead, where you can press Ctrl+Shift+B to build.
+	#endif
 #endif
 
 #ifdef ZASDBG

daedalus.dme

@@ -12,6 +12,10 @@
 #define DEBUG
 // END_PREFERENCES
 
+#if !defined(SPACEMAN_DMM) && defined(OPENDREAM)
+#include "tools/ci/od_lints.dme"
+#endif
+
 // BEGIN_INCLUDE
 #include "_maps\_basemap.dm"
 #include "code\_byond_version_compact.dm"

tools/ci/od_lints.dme

@@ -0,0 +1,48 @@
+//1000-1999
+#pragma FileAlreadyIncluded error
+#pragma MissingIncludedFile error
+#pragma InvalidWarningCode error
+#pragma MisplacedDirective error
+#pragma UndefineMissingDirective error
+#pragma DefinedMissingParen error
+#pragma ErrorDirective error
+#pragma WarningDirective warning
+#pragma MiscapitalizedDirective error
+
+//2000-2999
+#pragma SoftReservedKeyword error
+#pragma DuplicateVariable error
+#pragma DuplicateProcDefinition error
+#pragma PointlessParentCall error
+#pragma PointlessBuiltinCall error
+#pragma SuspiciousMatrixCall error
+#pragma FallbackBuiltinArgument error
+#pragma PointlessScopeOperator error
+#pragma MalformedRange error
+#pragma InvalidRange error
+#pragma InvalidSetStatement error
+#pragma InvalidOverride error
+#pragma DanglingVarType error
+#pragma MissingInterpolatedExpression error
+#pragma AmbiguousResourcePath error
+
+
+// NOTE: The next few pragmas are for OpenDream's experimental type checker
+// This feature is still in development, elevating these pragmas outside of local testing is discouraged
+// An RFC to finalize this feature is coming soon(TM)
+// BEGIN TYPEMAKER
+#pragma UnsupportedTypeCheck disabled
+#pragma InvalidReturnType disabled
+#pragma InvalidVarType disabled
+#pragma ImplicitNullType disabled
+#pragma LostTypeInfo disabled
+// END TYPEMAKER
+
+//3000-3999
+#pragma EmptyBlock disabled
+#pragma EmptyProc disabled
+// NOTE: Only checks for unsafe accesses like "client.foobar" and doesn't consider if the client was already null-checked earlier in the proc
+#pragma UnsafeClientAccess disabled
+#pragma SuspiciousSwitchCase error
+#pragma AssignmentInConditional error
+#pragma PickWeightedSyntax disabled