Merge pull request #618 from Quenty/users/quenty/small-ci-cd-fixes

feat: Update declarations and README.md

Author: Quenty

readme.md

@@ -171,7 +171,7 @@ There are 270 packages in Nevermore.
 | [HumanoidUtils](https://quenty.github.io/NevermoreEngine/api/HumanoidUtils) | General humanoid utility code. | `npm i @quenty/humanoidutils` | [docs](https://quenty.github.io/NevermoreEngine/api/HumanoidUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/humanoidutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/humanoidutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/humanoidutils) |
 | [IdleService](https://quenty.github.io/NevermoreEngine/api/IdleService) | Helps track whether or not a player is idle and if so, then can show UI or other cute things. | `npm i @quenty/idleservice` | [docs](https://quenty.github.io/NevermoreEngine/api/IdleService) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/idleservice) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/idleservice/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/idleservice) |
 | [IK](https://quenty.github.io/NevermoreEngine/api/IKService) | Inverse Kinematics for characters on Roblox | `npm i @quenty/ik` | [docs](https://quenty.github.io/NevermoreEngine/api/IKService) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/ik) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/ik/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/ik) |
-| [InfluxDBClient](https://quenty.github.io/NevermoreEngine/api/InfluxDBClientUtils) | Provides a Roblox Lua InfluxDB client | `npm i @quenty/influxdbclient` | [docs](https://quenty.github.io/NevermoreEngine/api/InfluxDBClientUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/influxdbclient) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/influxdbclient/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/influxdbclient) |
+| [InfluxDBClient](https://quenty.github.io/NevermoreEngine/api/InfluxDBClient) | Provides a Roblox Lua InfluxDB client | `npm i @quenty/influxdbclient` | [docs](https://quenty.github.io/NevermoreEngine/api/InfluxDBClient) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/influxdbclient) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/influxdbclient/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/influxdbclient) |
 | [InputKeyMapUtils](https://quenty.github.io/NevermoreEngine/api/InputKeyMapList) | System to define rebindable key bindings and inputs for Roblox. | `npm i @quenty/inputkeymaputils` | [docs](https://quenty.github.io/NevermoreEngine/api/InputKeyMapList) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/inputkeymaputils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/inputkeymaputils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/inputkeymaputils) |
 | [InputMode](https://quenty.github.io/NevermoreEngine/api/InputMode) | Trace input mode state and trigger changes correctly | `npm i @quenty/inputmode` | [docs](https://quenty.github.io/NevermoreEngine/api/InputMode) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/inputmode) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/inputmode/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/inputmode) |
 | [InputObjectUtils](https://quenty.github.io/NevermoreEngine/api/InputObjectRayUtils) | Provides utility functions involving input objects | `npm i @quenty/inputobjectutils` | [docs](https://quenty.github.io/NevermoreEngine/api/InputObjectRayUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/inputobjectutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/inputobjectutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/inputobjectutils) |
@@ -226,8 +226,8 @@ There are 270 packages in Nevermore.
 | [PlayerHumanoidBinder](https://quenty.github.io/NevermoreEngine/api/PlayerHumanoidBinder) | Binder that will automatically bind to each player's humanoid | `npm i @quenty/playerhumanoidbinder` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerHumanoidBinder) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerhumanoidbinder) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerhumanoidbinder/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/playerhumanoidbinder) |
 | [PlayerInputMode](https://quenty.github.io/NevermoreEngine/api/PlayerInputModeService) | Service that takes active input modes from the player and exposes it to every other player via the server. | `npm i @quenty/playerinputmode` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerInputModeService) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerinputmode) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerinputmode/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/playerinputmode) |
 | [PlayersServicePromises](https://quenty.github.io/NevermoreEngine/api/PlayersServicePromises) | Utility methods for async methods in Players service | `npm i @quenty/playersservicepromises` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayersServicePromises) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/playersservicepromises) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/playersservicepromises/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/playersservicepromises) |
-| [PlayerThumbnailUtils](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | Utility methods to query policies for players from PolicyService. | `npm i @quenty/policyserviceutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/policyserviceutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/policyserviceutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/policyserviceutils) |
 | [PlayerThumbnailUtils](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | Reimplementation of Player:GetUserThumbnailAsync but as a promise with retry logic | `npm i @quenty/playerthumbnailutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerthumbnailutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerthumbnailutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/playerthumbnailutils) |
+| [PlayerThumbnailUtils](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | Utility methods to query policies for players from PolicyService. | `npm i @quenty/policyserviceutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/policyserviceutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/policyserviceutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/policyserviceutils) |
 | [PlayerUtils](https://quenty.github.io/NevermoreEngine/api/PlayerUtils) | Player utility functions | `npm i @quenty/playerutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PlayerUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/playerutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/playerutils) |
 | [PolynomialUtils](https://quenty.github.io/NevermoreEngine/api/PolynomialUtils) | Solves polynomials of certain degrees. | `npm i @quenty/polynomialutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PolynomialUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/polynomialutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/polynomialutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/polynomialutils) |
 | [PreferredParentUtils](https://quenty.github.io/NevermoreEngine/api/PreferredParentUtils) | Handles logic for creating a "preferred" parent container or erroring if it already exists | `npm i @quenty/preferredparentutils` | [docs](https://quenty.github.io/NevermoreEngine/api/PreferredParentUtils) | [source](https://github.com/Quenty/NevermoreEngine/tree/main/src/preferredparentutils) | [changelog](https://github.com/Quenty/NevermoreEngine/tree/main/src/preferredparentutils/CHANGELOG.md) | [npm](https://www.npmjs.com/package/@quenty/preferredparentutils) |
@@ -335,4 +335,21 @@ There are 270 packages in Nevermore.
 
 <!--package-list-generated-end-->
 
-To update this package list run `python ./tools/update_readme.py`.
+To update this package list run `python ./tools/update_readme.py`.
+
+## Linting
+
+In order to pass linting please run the following checks locally, within the Nevermore directory.
+
+```
+npm run lint:luau
+npm run lint:moonwave
+npm run lint:selene
+npm run lint:stylua
+```
+
+To fix stylua formatting you can run the following
+
+```
+npm run format
+```

src/deathreport/src/Client/DeathReportServiceClient.lua

@@ -56,7 +56,7 @@ end
 	@param player Player
 	@return Observable<DeathReport>
 ]=]
-function DeathReportServiceClient:ObservePlayerKillerReports(player)
+function DeathReportServiceClient:ObservePlayerKillerReports(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._reportProcessor:ObservePlayerKillerReports(player)
@@ -68,7 +68,7 @@ end
 	@param player Player
 	@return Observable<DeathReport>
 ]=]
-function DeathReportServiceClient:ObservePlayerDeathReports(player)
+function DeathReportServiceClient:ObservePlayerDeathReports(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._reportProcessor:ObservePlayerDeathReports(player)
@@ -80,7 +80,7 @@ end
 	@param humanoid Humanoid
 	@return Observable<DeathReport>
 ]=]
-function DeathReportServiceClient:ObserveHumanoidKillerReports(humanoid)
+function DeathReportServiceClient:ObserveHumanoidKillerReports(humanoid: Humanoid)
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	return self._reportProcessor:ObserveHumanoidKillerReports(humanoid)
@@ -92,7 +92,7 @@ end
 	@param humanoid Humanoid
 	@return Observable<DeathReport>
 ]=]
-function DeathReportServiceClient:ObserveHumanoidDeathReports(humanoid)
+function DeathReportServiceClient:ObserveHumanoidDeathReports(humanoid: Humanoid)
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	return self._reportProcessor:ObserveHumanoidDeathReports(humanoid)

src/highlight/src/Client/AnimatedHighlightGroup.lua

@@ -133,7 +133,7 @@ function AnimatedHighlightGroup:_setDefaultValues(highlight, doNotAnimate: boole
 	highlight:SetOutlineColor(self._defaultValues.OutlineColor.Value)
 end
 
-function AnimatedHighlightGroup:_getOrCreateHighlightStackHandle(adornee, observeScore)
+function AnimatedHighlightGroup:_getOrCreateHighlightStackHandle(adornee: Instance, observeScore)
 	assert(observeScore, "Bad observeScore")
 
 	local foundHighlightStack = self._highlightStacks[adornee]
@@ -196,7 +196,7 @@ function AnimatedHighlightGroup:_removeHighlightStack(highlightStack)
 	self._maid[highlightStack] = nil
 end
 
-function AnimatedHighlightGroup:_findHighlightAdornee(adornee)
+function AnimatedHighlightGroup:_findHighlightAdornee(adornee: Instance)
 	return self._highlightStacks[adornee]
 end
 

src/highlight/src/Client/HighlightServiceClient.lua

@@ -44,7 +44,7 @@ end
 	@param observeScore Observable<number> | number?
 	@return AnimatedHighlightModel
 ]=]
-function HighlightServiceClient:Highlight(adornee, observeScore)
+function HighlightServiceClient:Highlight(adornee: Instance, observeScore)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 
 	return self._group:Highlight(adornee, observeScore)

src/parttouchingcalculator/src/Shared/PartTouchingCalculator.lua

@@ -24,12 +24,17 @@ function PartTouchingCalculator.new()
 	return self
 end
 
-function PartTouchingCalculator:CheckIfTouchingHumanoid(humanoid, parts)
+function PartTouchingCalculator:CheckIfTouchingHumanoid(humanoid: Humanoid, parts)
 	assert(humanoid, "Bad humanoid")
 	assert(parts, "Must have parts")
 
+	local character = humanoid.Parent
+	if not character then
+		return false
+	end
+
 	local humanoidParts = {}
-	for _, item in humanoid.Parent:GetDescendants() do
+	for _, item in character:GetDescendants() do
 		if item:IsA("BasePart") then
 			table.insert(humanoidParts, item)
 		end

src/ragdoll/src/Server/Classes/RagdollHumanoidOnFall.lua

@@ -68,7 +68,7 @@ function RagdollHumanoidOnFall:_getOrCreateRagdollLogic()
 	return self._ragdollLogic
 end
 
-function RagdollHumanoidOnFall:_handleServerEvent(player, value)
+function RagdollHumanoidOnFall:_handleServerEvent(player: Player, value)
 	assert(player == self._player, "Bad player")
 	assert(typeof(value) == "boolean", "Bad value")
 

src/secrets/src/Server/SecretsService.lua

@@ -258,15 +258,15 @@ function SecretsService:_decrypt(data: SecretsData): (boolean?, string)
 	return true, tostring(decrypted)
 end
 
-function SecretsService:_handleServerInvoke(player, request)
+function SecretsService:_handleServerInvoke(player: Player, request)
 	if request == SecretsServiceConstants.REQUEST_SECRET_KEY_NAMES_LIST then
 		return self:_promiseHandleList(player):Yield()
 	else
 		error(string.format("Bad request %q", tostring(request)))
 	end
 end
 
-function SecretsService:_promiseHandleList(player)
+function SecretsService:_promiseHandleList(player: Player)
 	return self._permissionsService
 		:PromisePermissionProvider()
 		:Then(function(provider)

src/settings/src/Shared/SettingsDataService.lua

@@ -134,7 +134,7 @@ end
 	@param player Player
 	@return Observable<PlayerSettingsBase>
 ]=]
-function SettingsDataService:ObservePlayerSettings(player)
+function SettingsDataService:ObservePlayerSettings(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self:_getPlayerSettingsMapForPlayer(player):ObserveAtKey(player, self._tieRealmService:GetTieRealm())

src/sounds/src/Shared/SoundUtils.lua

@@ -21,6 +21,8 @@ export type SoundOptions = {
 	SoundId: number | string,
 }
 
+export type SoundId = string | number | SoundOptions
+
 local SoundUtils = {}
 
 --[=[
@@ -36,7 +38,7 @@ local SoundUtils = {}
 
 	@return Sound
 ]=]
-function SoundUtils.playFromId(id: string | number | SoundOptions): Sound
+function SoundUtils.playFromId(id: SoundId): Sound
 	local sound = SoundUtils.createSoundFromId(id)
 
 	if RunService:IsClient() then