Run Luau analysis in CI (#14)

Co-authored-by: Marin Minnerly <[email protected]>

Author: ghostnaps

.github/workflows/ci.yml

@@ -38,3 +38,22 @@ jobs:
 
       - name: Lint
         run: lune run lint
+
+  analyze:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: CompeyDev/[email protected]
+
+      - name: Install tools
+        run: rokit install --no-trust-check
+
+      - name: Install dependencies
+        run: lune run install
+
+      - name: Setup Lune typedefs
+        run: lune setup
+
+      - name: Analyze
+        run: lune run analyze

.lune/analyze.luau

@@ -0,0 +1,9 @@
+local run = require("@root/lib/run")
+
+local foldersToAnalyze = {
+	".lune",
+	"src",
+	"examples",
+}
+
+run("luau-lsp", { "analyze", "--ignore=**/pkg/**", table.unpack(foldersToAnalyze) })

foreman.toml

@@ -1,4 +1,5 @@
 [tools]
+luau-lsp = { source = "JohnnyMorganz/luau-lsp", version = "=1.45.0" }
 lune = { source = "lune-org/lune", version = "=0.9.3" }
 rojo = { source = "rojo-rbx/rojo", version = "=7.5.0" }
 selene = { source = "kampfkarren/selene", version = "=0.28.0" }

src/cloud/publishPlaceAsync.luau

@@ -31,8 +31,9 @@ local function publishPlaceAsync(
 
 	if res.ok then
 		local body = serde.decode("json", res.body)
-		return body.versionNumber
+		return body.versionNumber :: number
 	end
+	return -1
 end
 
 return publishPlaceAsync

src/requests/publishImagesAsync.luau

@@ -48,7 +48,7 @@ local function publishImagesAsync(
 				apiKey
 			)
 
-			local assetId = operation.response.assetId
+			local assetId = if operation.response then operation.response.assetId else nil
 
 			if assetId then
 				table.insert(pendingImages, {
@@ -88,18 +88,20 @@ local function publishImagesAsync(
 				apiKey
 			)
 
-			local assetId = operation.response.assetId
+			if operation.response then
+				local assetId = operation.response.assetId
 
-			if assetId then
-				table.insert(pendingImages, {
-					path = thumbnailPath,
-					filename = thumbnailFilename,
-					assetId = assetId,
-				})
+				if assetId then
+					table.insert(pendingImages, {
+						path = thumbnailPath,
+						filename = thumbnailFilename,
+						assetId = assetId,
+					})
 
-				logging.debug(`image uploaded successfully`)
-			else
-				logging.warn(`failed to upload image at {thumbnailPath}`)
+					logging.debug(`image uploaded successfully`)
+				else
+					logging.warn(`failed to upload image at {thumbnailPath}`)
+				end
 			end
 		end
 	end

src/requests/setAssetIconAsync.luau

@@ -64,7 +64,7 @@ local function setAssetIconAsync(projectPath: string, assetName: string, assetCo
 
 	local operation = waitForAssetOperationAsync(body.operationId, apiKey)
 
-	if operation.error then
+	if operation.metadata then
 		local problems = {}
 		for _, err in operation.metadata.errors do
 			table.insert(problems, err.error.message)

src/types.luau

@@ -133,46 +133,27 @@ types.validateLockfile = t.strictInterface({
 export type ErrorStatusResponse = {
 	code: string,
 	message: string,
+	details: { string }?,
 }
 
-type OperationPendingResponse = {
-	done: false,
+export type OperationResponse = {
+	done: boolean,
 	operationId: string,
 	path: string,
-}
 
-type ErrorResponse = {
-	code: string,
-	details: { string }?,
-	message: string,
-}
+	-- Success
+	response: { [string]: any }?,
 
-type OperationFailedResponse = {
-	done: true,
-	error: ErrorResponse,
+	-- Failure
+	error: ErrorStatusResponse?,
 	metadata: {
 		errors: {
 			{
-				error: ErrorResponse,
+				error: ErrorStatusResponse,
 				fieldMask: { [string]: any },
 			}
 		},
-	},
-	operationId: string,
-	path: string,
-}
-
-type OperationSucceededResponse = {
-	done: true,
-	operationId: string,
-	path: string,
-	response: { [string]: any },
-}
-
-export type OperationResponse =
-	OperationSucceededResponse
-	| OperationFailedResponse
-	| OperationPendingResponse
-	| ErrorStatusResponse
+	}?,
+} & ErrorStatusResponse
 
 return types