@quenty/defaultvalueutils 1.0.1-canary.402.a911cda.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1-canary.402.a911cda.0 (2023-08-23)
+
+
+### Bug Fixes
+
+* Add missing dependencies ([324e3db](https://github.com/Quenty/NevermoreEngine/commit/324e3dbcd7ed260542eebe24889cbc6cd968d380))
+* Remove unused code ([71930e0](https://github.com/Quenty/NevermoreEngine/commit/71930e02bfb42d9d6e84f716fbfca2a001c8a0cf))
+
+
+### Features
+
+* Add DefaultValueUtils ([abd0df4](https://github.com/Quenty/NevermoreEngine/commit/abd0df4439e7124c81fbab6d7cf9636c872487d9))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2023 James Onnen (Quenty)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+## DefaultValueUtils
+
+<div align="center">
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
+  </a>
+  <a href="https://discord.gg/mhtGUS8">
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
+  </a>
+  <a href="https://github.com/Quenty/NevermoreEngine/actions">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
+  </a>
+</div>
+
+Helps get the default or zero value for value types in Roblox
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/DefaultValueUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/defaultvalueutils --save
+```

package/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "defaultvalueutils",
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@quenty/defaultvalueutils",
+  "version": "1.0.1-canary.402.a911cda.0",
+  "description": "Helps get the default or zero value for value types in Roblox",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "defaultvalueutils"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/defaultvalueutils/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "a911cdaf4f1039b599528cec17b027f4660e4fd8"
+}

package/src/Shared/DefaultValueUtils.lua

@@ -0,0 +1,80 @@
+--[=[
+	Helps get the default or zero value for value types in Roblox
+	@class DefaultValueUtils
+]=]
+
+local DefaultValueUtils = {}
+
+-- selene: allow(incorrect_standard_library_use)
+local DEFAULT_VALUES = {
+	["boolean"] = false;
+	["BrickColor"] = BrickColor.new();
+	["CFrame"] = CFrame.new();
+	["Color3"] = Color3.new();
+	["ColorSequence"] = ColorSequence.new({ ColorSequenceKeypoint.new(0, Color3.new(0, 0, 0)); ColorSequenceKeypoint.new(1, Color3.new(0, 0, 0)); });
+	["ColorSequenceKeypoint"] = ColorSequenceKeypoint.new(0, Color3.new(0, 0, 0));
+	["number"] = 0;
+	["PhysicalProperties"] = PhysicalProperties.new(Enum.Material.Plastic); -- Eww
+	["NumberRange"] = NumberRange.new(0);
+	["NumberSequence"] = NumberSequence.new({ NumberSequenceKeypoint.new(0, 0); NumberSequenceKeypoint.new(1, 0); });
+	["NumberSequenceKeypoint"] = NumberSequenceKeypoint.new(0, 0);
+	["Ray"] = Ray.new();
+	["Rect"] = Rect.new();
+	["Region3"] = Region3.new();
+	["Region3int16"] = Region3int16.new();
+	["string"] = "";
+	["UDim"] = UDim.new();
+	["UDim2"] = UDim2.new();
+	["userdata"] = newproxy();
+	["Vector2"] = Vector2.zero;
+	["Vector2int16"] = Vector2int16.new();
+	["Vector3"] = Vector3.zero;
+	["Vector3int16"] = Vector3int16.new();
+}
+
+--[=[
+	Returns the default value for a given value type. If the type is mutable than
+	a new value will ge cosntructed.
+
+	@param typeOfName string
+	@return any
+]=]
+function DefaultValueUtils.getDefaultValueForType(typeOfName)
+	if DEFAULT_VALUES[typeOfName] ~= nil then
+		return DEFAULT_VALUES[typeOfName]
+	elseif typeOfName == "table" then
+		return {}
+	elseif typeOfName == "nil" then
+		return nil
+	elseif typeOfName == "Random" then
+		return Random.new()
+	elseif typeOfName == "RaycastParams" then
+		return RaycastParams.new()
+	elseif typeOfName == "OverlapParams" then
+		return OverlapParams.new()
+	elseif typeOfName == "Instance" then
+		error("Cannot get a defaultValue for an instance")
+	else
+		error(string.format("Unknown type %q", typeOfName))
+	end
+end
+
+--[=[
+	Converts this value to its default value. If it's a table, it applies it recursively.
+
+	@param value T
+	@return T
+]=]
+function DefaultValueUtils.toDefaultValue(value)
+	if type(value) == "table" then
+		local result = {}
+		for key, item in pairs(value) do
+			result[key] = DefaultValueUtils.toDefaultValue(item)
+		end
+		return result
+	else
+		return DefaultValueUtils.getDefaultValueForType(typeof(value))
+	end
+end
+
+return DefaultValueUtils

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}

package/test/default.project.json

@@ -0,0 +1,11 @@
+{
+  "name": "DefaultValueUtilsTest",
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "defaultvalueutils": {
+        "$path": ".."
+      }
+    }
+  }
+}