Lint plugin src (#846)

plugin/src/Reconciler/applyPatch.lua

@@ -25,14 +25,14 @@ local function applyPatch(instanceMap, patch)
 	local unappliedPatch = PatchSet.newEmpty()
 
 	for _, removedIdOrInstance in ipairs(patch.removed) do
-		local ok = pcall(function()
+		local removeInstanceSuccess = pcall(function()
 			if Types.RbxId(removedIdOrInstance) then
 				instanceMap:destroyId(removedIdOrInstance)
 			else
 				instanceMap:destroyInstance(removedIdOrInstance)
 			end
 		end)
-		if not ok then
+		if not removeInstanceSuccess then
 			table.insert(unappliedPatch.removed, removedIdOrInstance)
 		end
 	end
@@ -175,10 +175,10 @@ local function applyPatch(instanceMap, patch)
 		end
 
 		if update.changedName ~= nil then
-			local ok = pcall(function()
+			local setNameSuccess = pcall(function()
 				instance.Name = update.changedName
 			end)
-			if not ok then
+			if not setNameSuccess then
 				unappliedUpdate.changedName = update.changedName
 				partiallyApplied = true
 			end
@@ -194,15 +194,15 @@ local function applyPatch(instanceMap, patch)
 
 		if update.changedProperties ~= nil then
 			for propertyName, propertyValue in pairs(update.changedProperties) do
-				local ok, decodedValue = decodeValue(propertyValue, instanceMap)
-				if not ok then
+				local decodeSuccess, decodedValue = decodeValue(propertyValue, instanceMap)
+				if not decodeSuccess then
 					unappliedUpdate.changedProperties[propertyName] = propertyValue
 					partiallyApplied = true
 					continue
 				end
 
-				local ok = setProperty(instance, propertyName, decodedValue)
-				if not ok then
+				local setPropertySuccess = setProperty(instance, propertyName, decodedValue)
+				if not setPropertySuccess then
 					unappliedUpdate.changedProperties[propertyName] = propertyValue
 					partiallyApplied = true
 				end

plugin/src/Reconciler/decodeValue.lua

@@ -27,9 +27,9 @@ local function decodeValue(encodedValue, instanceMap)
 		end
 	end
 
-	local ok, decodedValue = RbxDom.EncodedValue.decode(encodedValue)
+	local decodeSuccess, decodedValue = RbxDom.EncodedValue.decode(encodedValue)
 
-	if not ok then
+	if not decodeSuccess then
 		return false,
 			Error.new(Error.CannotDecodeValue, {
 				encodedValue = encodedValue,

plugin/src/Reconciler/diff.lua

@@ -147,13 +147,13 @@ local function diff(instanceMap, virtualInstances, rootId)
 
 		local changedProperties = {}
 		for propertyName, virtualValue in pairs(virtualInstance.Properties) do
-			local ok, existingValueOrErr = getProperty(instance, propertyName)
+			local getProperySuccess, existingValueOrErr = getProperty(instance, propertyName)
 
-			if ok then
+			if getProperySuccess then
 				local existingValue = existingValueOrErr
-				local ok, decodedValue = decodeValue(virtualValue, instanceMap)
+				local decodeSuccess, decodedValue = decodeValue(virtualValue, instanceMap)
 
-				if ok then
+				if decodeSuccess then
 					if not trueEquals(existingValue, decodedValue) then
 						Log.debug(
 							"{}.{} changed from '{}' to '{}'",
@@ -165,7 +165,6 @@ local function diff(instanceMap, virtualInstances, rootId)
 						changedProperties[propertyName] = virtualValue
 					end
 				else
-					local propertyType = next(virtualValue)
 					Log.warn(
 						"Failed to decode property {}.{}. Encoded property was: {:#?}",
 						virtualInstance.ClassName,
@@ -220,9 +219,9 @@ local function diff(instanceMap, virtualInstances, rootId)
 					table.insert(patch.removed, childInstance)
 				end
 			else
-				local ok, err = diffInternal(childId)
+				local diffSuccess, err = diffInternal(childId)
 
-				if not ok then
+				if not diffSuccess then
 					return false, err
 				end
 			end
@@ -243,9 +242,9 @@ local function diff(instanceMap, virtualInstances, rootId)
 		return true
 	end
 
-	local ok, err = diffInternal(rootId)
+	local diffSuccess, err = diffInternal(rootId)
 
-	if not ok then
+	if not diffSuccess then
 		return false, err
 	end
 

plugin/src/Reconciler/hydrate.lua

@@ -31,13 +31,13 @@ local function hydrate(instanceMap, virtualInstances, rootId, rootInstance)
 				-- We guard accessing Name and ClassName in order to avoid
 				-- tripping over children of DataModel that Rojo won't have
 				-- permissions to access at all.
-				local ok, name, className = pcall(function()
+				local accessSuccess, name, className = pcall(function()
 					return childInstance.Name, childInstance.ClassName
 				end)
 
 				-- This rule is very conservative and could be loosened in the
 				-- future, or more heuristics could be introduced.
-				if ok and name == virtualChild.Name and className == virtualChild.ClassName then
+				if accessSuccess and name == virtualChild.Name and className == virtualChild.ClassName then
 					isExistingChildVisited[childIndex] = true
 					hydrate(instanceMap, virtualInstances, childId, childInstance)
 					break

plugin/src/Reconciler/reify.lua

@@ -53,9 +53,9 @@ function reifyInner(instanceMap, virtualInstances, id, parentInstance, unapplied
 	-- Instance.new can fail if we're passing in something that can't be
 	-- created, like a service, something enabled with a feature flag, or
 	-- something that requires higher security than we have.
-	local ok, instance = pcall(Instance.new, virtualInstance.ClassName)
+	local createSuccess, instance = pcall(Instance.new, virtualInstance.ClassName)
 
-	if not ok then
+	if not createSuccess then
 		addAllToPatch(unappliedPatch, virtualInstances, id)
 		return
 	end
@@ -80,14 +80,14 @@ function reifyInner(instanceMap, virtualInstances, id, parentInstance, unapplied
 			continue
 		end
 
-		local ok, value = decodeValue(virtualValue, instanceMap)
-		if not ok then
+		local decodeSuccess, value = decodeValue(virtualValue, instanceMap)
+		if not decodeSuccess then
 			unappliedProperties[propertyName] = virtualValue
 			continue
 		end
 
-		local ok = setProperty(instance, propertyName, value)
-		if not ok then
+		local setPropertySuccess = setProperty(instance, propertyName, value)
+		if not setPropertySuccess then
 			unappliedProperties[propertyName] = virtualValue
 		end
 	end
@@ -148,8 +148,8 @@ function applyDeferredRefs(instanceMap, deferredRefs, unappliedPatch)
 			continue
 		end
 
-		local ok = setProperty(entry.instance, entry.propertyName, targetInstance)
-		if not ok then
+		local setPropertySuccess = setProperty(entry.instance, entry.propertyName, targetInstance)
+		if not setPropertySuccess then
 			markFailed(entry.id, entry.propertyName, entry.virtualValue)
 		end
 	end

plugin/src/Reconciler/reify.spec.lua

@@ -3,7 +3,6 @@ return function()
 
 	local PatchSet = require(script.Parent.Parent.PatchSet)
 	local InstanceMap = require(script.Parent.Parent.InstanceMap)
-	local Error = require(script.Parent.Error)
 
 	local function isEmpty(table)
 		return next(table) == nil, "Table was not empty"

plugin/src/Reconciler/setProperty.lua

@@ -28,9 +28,9 @@ local function setProperty(instance, propertyName, value)
 			})
 	end
 
-	local ok, err = descriptor:write(instance, value)
+	local writeSuccess, err = descriptor:write(instance, value)
 
-	if not ok then
+	if not writeSuccess then
 		if err.kind == RbxDom.Error.Kind.Roblox and err.extra:find("lacking permission") then
 			return false,
 				Error.new(Error.LackingPropertyPermissions, {