@quenty/string 3.3.6 → 3.4.0

package/CHANGELOG.md

@@ -3,176 +3,109 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [3.3.6](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.3.5...@quenty/string@3.3.6) (2026-01-12)
+# [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.3.7...@quenty/string@3.4.0) (2026-07-23)
 
+### Features
 
-### Bug Fixes
+- Add unit tests to string package ([f15f2f2](https://github.com/Quenty/NevermoreEngine/commit/f15f2f2892d782bed552a882e31f3b5d07975184))
 
-* Fix dependency installation process for pnpm ([9651b09](https://github.com/Quenty/NevermoreEngine/commit/9651b09af34f252ef3f9c7c539793cc878dd8cba))
+## [3.3.7](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.3.6...@quenty/string@3.3.7) (2026-05-30)
 
+**Note:** Version bump only for package @quenty/string
 
+## [3.3.6](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.3.5...@quenty/string@3.3.6) (2026-01-12)
 
+### Bug Fixes
 
+- Fix dependency installation process for pnpm ([9651b09](https://github.com/Quenty/NevermoreEngine/commit/9651b09af34f252ef3f9c7c539793cc878dd8cba))
 
 ## [3.3.5](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.3.4...@quenty/string@3.3.5) (2026-01-10)
 
 **Note:** Version bump only for package @quenty/string
 
-
-
-
-
 ## [3.3.4](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.3.3...@quenty/string@3.3.4) (2026-01-03)
 
 **Note:** Version bump only for package @quenty/string
 
-
-
-
-
 ## [3.3.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.3.1...@quenty/string@3.3.3) (2025-04-07)
 
-
 ### Bug Fixes
 
-* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
-* Bump package versions for republishing ([ba47c62](https://github.com/Quenty/NevermoreEngine/commit/ba47c62e32170bf74377b0c658c60b84306dc294))
-
-
-
-
+- Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+- Bump package versions for republishing ([ba47c62](https://github.com/Quenty/NevermoreEngine/commit/ba47c62e32170bf74377b0c658c60b84306dc294))
 
 ## [3.3.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.3.1...@quenty/string@3.3.2) (2025-04-07)
 
-
 ### Bug Fixes
 
-* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
-
-
-
-
+- Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
 
 ## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.3.0...@quenty/string@3.3.1) (2025-03-21)
 
 **Note:** Version bump only for package @quenty/string
 
-
-
-
-
 # [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.2.0...@quenty/string@3.3.0) (2024-09-25)
 
-
 ### Bug Fixes
 
-* Rename `:gsub()` to `string.gsub` ([9a730cb](https://github.com/Quenty/NevermoreEngine/commit/9a730cbd7001706787c5e5db0efe2306b2234b3a))
-* Rename `:sub()` to `string.sub` ([6874e06](https://github.com/Quenty/NevermoreEngine/commit/6874e06e456d7094a2d7f25a3a7b24a40d77fe3c))
-* Rename `:upper()` to `string.upper` ([2df557a](https://github.com/Quenty/NevermoreEngine/commit/2df557a9a5463c2c7beb257ff9f7786ac8ad746a))
-
-
-
-
+- Rename `:gsub()` to `string.gsub` ([9a730cb](https://github.com/Quenty/NevermoreEngine/commit/9a730cbd7001706787c5e5db0efe2306b2234b3a))
+- Rename `:sub()` to `string.sub` ([6874e06](https://github.com/Quenty/NevermoreEngine/commit/6874e06e456d7094a2d7f25a3a7b24a40d77fe3c))
+- Rename `:upper()` to `string.upper` ([2df557a](https://github.com/Quenty/NevermoreEngine/commit/2df557a9a5463c2c7beb257ff9f7786ac8ad746a))
 
 # [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.1.0...@quenty/string@3.2.0) (2024-05-09)
 
-
 ### Bug Fixes
 
-* Fix .package-lock.json replicating in packages ([75d0efe](https://github.com/Quenty/NevermoreEngine/commit/75d0efeef239f221d93352af71a5b3e930ec23c5))
-
-
-
-
+- Fix .package-lock.json replicating in packages ([75d0efe](https://github.com/Quenty/NevermoreEngine/commit/75d0efeef239f221d93352af71a5b3e930ec23c5))
 
 # [3.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@3.0.0...@quenty/string@3.1.0) (2023-02-21)
 
 **Note:** Version bump only for package @quenty/string
 
-
-
-
-
 # [3.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@2.3.0...@quenty/string@3.0.0) (2022-08-14)
 
-
 ### Features
 
-* Add seperator parameter to String library which allows comma seperator to be specified ([4bd70ae](https://github.com/Quenty/NevermoreEngine/commit/4bd70aefd30fb06447f0175a8ff94745bb1444c4))
-
-
-
-
+- Add seperator parameter to String library which allows comma seperator to be specified ([4bd70ae](https://github.com/Quenty/NevermoreEngine/commit/4bd70aefd30fb06447f0175a8ff94745bb1444c4))
 
 # [2.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@2.2.1...@quenty/string@2.3.0) (2022-03-27)
 
-
 ### Bug Fixes
 
-* Add types to core libraries ([6e685b3](https://github.com/Quenty/NevermoreEngine/commit/6e685b3cfbcd3816d15962769a4310a1ec57fb7e))
-
-
-
-
+- Add types to core libraries ([6e685b3](https://github.com/Quenty/NevermoreEngine/commit/6e685b3cfbcd3816d15962769a4310a1ec57fb7e))
 
 ## [2.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@2.2.0...@quenty/string@2.2.1) (2021-12-30)
 
 **Note:** Version bump only for package @quenty/string
 
-
-
-
-
 # [2.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@2.1.0...@quenty/string@2.2.0) (2021-11-10)
 
-
 ### Features
 
-* Add string.startsWith ([eb51da1](https://github.com/Quenty/NevermoreEngine/commit/eb51da1907f28bda5a843d7fa39fe4d9d9ce9938))
-
-
-
-
+- Add string.startsWith ([eb51da1](https://github.com/Quenty/NevermoreEngine/commit/eb51da1907f28bda5a843d7fa39fe4d9d9ce9938))
 
 # [2.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@2.0.0...@quenty/string@2.1.0) (2021-09-22)
 
-
 ### Bug Fixes
 
-* Add new string feature ([fc8d68c](https://github.com/Quenty/NevermoreEngine/commit/fc8d68c11b6cd7fc5dacc86f3229e81f481452f6))
-
-
-
-
+- Add new string feature ([fc8d68c](https://github.com/Quenty/NevermoreEngine/commit/fc8d68c11b6cd7fc5dacc86f3229e81f481452f6))
 
 # [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@1.2.0...@quenty/string@2.0.0) (2021-09-05)
 
-
 ### Bug Fixes
 
-* Remove peer dependencies. This is because lerna doesn't really support peer dependencies being linked and getting a new version on build, which is unfortunate. ([5f5aeee](https://github.com/Quenty/NevermoreEngine/commit/5f5aeeea8de9975435309e53679f0ef7064f9dd0))
-
-
-
-
+- Remove peer dependencies. This is because lerna doesn't really support peer dependencies being linked and getting a new version on build, which is unfortunate. ([5f5aeee](https://github.com/Quenty/NevermoreEngine/commit/5f5aeeea8de9975435309e53679f0ef7064f9dd0))
 
 # 1.2.0 (2021-07-31)
 
-
 ### Bug Fixes
 
-* Add CI and CD ([47513e9](https://github.com/Quenty/NevermoreEngine/commit/47513e9b568162707534af132396dd8756947dd3))
-* Adjust CI badge to show automatic build and release state ([5a55d3f](https://github.com/Quenty/NevermoreEngine/commit/5a55d3f19bf8d66a760d67da9b56ed47fab74656))
-* Fix selene linting ([45fc074](https://github.com/Quenty/NevermoreEngine/commit/45fc07489ee59127ac6582689f19a0e87c1e5b5a))
-
-
+- Add CI and CD ([47513e9](https://github.com/Quenty/NevermoreEngine/commit/47513e9b568162707534af132396dd8756947dd3))
+- Adjust CI badge to show automatic build and release state ([5a55d3f](https://github.com/Quenty/NevermoreEngine/commit/5a55d3f19bf8d66a760d67da9b56ed47fab74656))
+- Fix selene linting ([45fc074](https://github.com/Quenty/NevermoreEngine/commit/45fc07489ee59127ac6582689f19a0e87c1e5b5a))
 
 ## 1.0.2 (2021-07-25)
 
-
-
 ## 1.0.1 (2021-07-25)
 
-
-
 # 1.0.0 (2021-07-24)

package/deploy.nevermore.json

@@ -0,0 +1,10 @@
+{
+  "targets": {
+    "test": {
+      "universeId": 9716264427,
+      "placeId": 100668032156705,
+      "project": "test/default.project.json",
+      "scriptTemplate": "test/scripts/Server/ServerMain.server.lua"
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/string",
-  "version": "3.3.6",
+  "version": "3.4.0",
   "description": "This module provides utility functions for strings",
   "keywords": [
     "Roblox",
@@ -25,11 +25,16 @@
   "scripts": {
     "preinstall": "npx only-allow pnpm"
   },
+  "dependencies": {
+    "@quenty/loader": "10.11.0",
+    "@quenty/nevermore-test-runner": "1.5.0",
+    "@quentystudios/jest-lua": "3.10.0-quenty.2"
+  },
   "contributors": [
     "Quenty"
   ],
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "55f4a7407de7247aceea574de4d2f57dab70cb91"
+  "gitHead": "1de37218a2bedb8e3f8614a2e09bba9eddc812da"
 }

package/src/Shared/String.lua

@@ -71,7 +71,7 @@ function String.toPrivateCase(str: string): string
 end
 
 --[=[
-	Like trim, but only applied to the beginning of the setring
+	Like trim, but only applied to the beginning of the string
 	@param str string
 	@param pattern string? -- Defaults to whitespace
 	@return string
@@ -102,10 +102,10 @@ end
 
 --[=[
 	Checks if a string is empty or nil
-	@param str string
+	@param str string?
 	@return boolean
 ]=]
-function String.isEmptyOrWhitespaceOrNil(str: string): boolean
+function String.isEmptyOrWhitespaceOrNil(str: string?): boolean
 	return type(str) ~= "string" or str == "" or String.isWhitespace(str)
 end
 
@@ -173,7 +173,7 @@ function String.endsWith(str: string, postfix: string): boolean
 end
 
 --[=[
-	Returns if a string starts with a postfix
+	Returns if a string starts with a prefix
 
 	@param str string
 	@param prefix string

package/src/Shared/String.spec.lua

@@ -0,0 +1,235 @@
+--!strict
+--[[
+	@class String.spec.lua
+]]
+
+local require = require(script.Parent.loader).load(script)
+
+local Jest = require("Jest")
+local String = require("String")
+
+local describe = Jest.Globals.describe
+local expect = Jest.Globals.expect
+local it = Jest.Globals.it
+
+describe("String.trim", function()
+	it("trims leading and trailing whitespace by default", function()
+		expect(String.trim("  hello  ")).toEqual("hello")
+	end)
+
+	it("trims tabs and newlines", function()
+		expect(String.trim("\t\nhello world\n\t")).toEqual("hello world")
+	end)
+
+	it("leaves interior whitespace untouched", function()
+		expect(String.trim("  a  b  ")).toEqual("a  b")
+	end)
+
+	it("returns an empty string for all-whitespace input", function()
+		expect(String.trim("   ")).toEqual("")
+	end)
+
+	it("is a no-op when there is nothing to trim", function()
+		expect(String.trim("hello")).toEqual("hello")
+	end)
+
+	it("trims a custom pattern", function()
+		expect(String.trim("xxhelloxx", "x")).toEqual("hello")
+	end)
+end)
+
+describe("String.trimFront", function()
+	it("trims only the leading whitespace by default", function()
+		expect(String.trimFront("  hello  ")).toEqual("hello  ")
+	end)
+
+	it("leaves a string without a leading match untouched", function()
+		expect(String.trimFront("hello  ")).toEqual("hello  ")
+	end)
+
+	it("trims a custom leading pattern", function()
+		expect(String.trimFront("xxhello", "x")).toEqual("hello")
+	end)
+end)
+
+describe("String.toCamelCase", function()
+	it("converts snake_case to UpperCamelCase", function()
+		expect(String.toCamelCase("hello_world")).toEqual("HelloWorld")
+	end)
+
+	it("converts YELL_CASE to UpperCamelCase", function()
+		expect(String.toCamelCase("YELL_CASE")).toEqual("YellCase")
+	end)
+
+	it("converts space separated words to UpperCamelCase", function()
+		expect(String.toCamelCase("hello world")).toEqual("HelloWorld")
+	end)
+
+	it("capitalizes the first letter of a single lowercase word", function()
+		expect(String.toCamelCase("hello")).toEqual("Hello")
+	end)
+
+	it("strips remaining punctuation", function()
+		expect(String.toCamelCase("foo-bar")).toEqual("Foobar")
+	end)
+end)
+
+describe("String.toLowerCamelCase", function()
+	it("converts snake_case to lowerCamelCase", function()
+		expect(String.toLowerCamelCase("hello_world")).toEqual("helloWorld")
+	end)
+
+	it("converts YELL_CASE to lowerCamelCase", function()
+		expect(String.toLowerCamelCase("YELL_CASE")).toEqual("yellCase")
+	end)
+
+	it("keeps the first letter lowercase", function()
+		expect(String.toLowerCamelCase("hello")).toEqual("hello")
+	end)
+end)
+
+describe("String.uppercaseFirstLetter", function()
+	it("uppercases the first letter", function()
+		expect(String.uppercaseFirstLetter("hello")).toEqual("Hello")
+	end)
+
+	it("leaves an already-uppercase first letter untouched", function()
+		expect(String.uppercaseFirstLetter("Hello")).toEqual("Hello")
+	end)
+
+	it("is a no-op when the first character is not a letter", function()
+		expect(String.uppercaseFirstLetter("123abc")).toEqual("123abc")
+	end)
+end)
+
+describe("String.toPrivateCase", function()
+	it("prefixes with an underscore and lowercases the first letter", function()
+		expect(String.toPrivateCase("MyThing")).toEqual("_myThing")
+	end)
+
+	it("preserves the remainder of the string", function()
+		expect(String.toPrivateCase("SomeValue")).toEqual("_someValue")
+	end)
+end)
+
+describe("String.checkNumOfCharacterInString", function()
+	it("counts the occurrences of a character", function()
+		expect(String.checkNumOfCharacterInString("hello", "l")).toEqual(2)
+	end)
+
+	it("returns 0 when the character is absent", function()
+		expect(String.checkNumOfCharacterInString("hello", "z")).toEqual(0)
+	end)
+
+	it("counts every character in the string", function()
+		expect(String.checkNumOfCharacterInString("aaaa", "a")).toEqual(4)
+	end)
+end)
+
+describe("String.isWhitespace", function()
+	it("returns true for a string of only whitespace", function()
+		expect(String.isWhitespace("   ")).toEqual(true)
+	end)
+
+	it("returns false for a string with non-whitespace", function()
+		expect(String.isWhitespace("a b")).toEqual(false)
+	end)
+
+	it("returns false for an empty string", function()
+		expect(String.isWhitespace("")).toEqual(false)
+	end)
+end)
+
+describe("String.isEmptyOrWhitespaceOrNil", function()
+	it("returns true for nil", function()
+		expect(String.isEmptyOrWhitespaceOrNil(nil)).toEqual(true)
+	end)
+
+	it("returns true for an empty string", function()
+		expect(String.isEmptyOrWhitespaceOrNil("")).toEqual(true)
+	end)
+
+	it("returns true for a whitespace-only string", function()
+		expect(String.isEmptyOrWhitespaceOrNil("  \t")).toEqual(true)
+	end)
+
+	it("returns false for a string with content", function()
+		expect(String.isEmptyOrWhitespaceOrNil("hello")).toEqual(false)
+	end)
+end)
+
+describe("String.elipseLimit", function()
+	it("truncates and appends an ellipsis when over the limit", function()
+		expect(String.elipseLimit("hello world", 8)).toEqual("hello...")
+	end)
+
+	it("leaves a string at or under the limit untouched", function()
+		expect(String.elipseLimit("hello", 8)).toEqual("hello")
+	end)
+
+	it("produces a result of exactly the limit length", function()
+		expect(#String.elipseLimit("abcdefghij", 8)).toEqual(8)
+	end)
+end)
+
+describe("String.removePrefix", function()
+	it("removes a matching prefix", function()
+		expect(String.removePrefix("foobar", "foo")).toEqual("bar")
+	end)
+
+	it("returns the string unchanged when the prefix does not match", function()
+		expect(String.removePrefix("foobar", "xyz")).toEqual("foobar")
+	end)
+end)
+
+describe("String.removePostfix", function()
+	it("removes a matching postfix", function()
+		expect(String.removePostfix("foobar", "bar")).toEqual("foo")
+	end)
+
+	it("returns the string unchanged when the postfix does not match", function()
+		expect(String.removePostfix("foobar", "xyz")).toEqual("foobar")
+	end)
+end)
+
+describe("String.startsWith", function()
+	it("returns true when the string starts with the prefix", function()
+		expect(String.startsWith("foobar", "foo")).toEqual(true)
+	end)
+
+	it("returns false when the string does not start with the prefix", function()
+		expect(String.startsWith("foobar", "bar")).toEqual(false)
+	end)
+end)
+
+describe("String.endsWith", function()
+	it("returns true when the string ends with the postfix", function()
+		expect(String.endsWith("foobar", "bar")).toEqual(true)
+	end)
+
+	it("returns false when the string does not end with the postfix", function()
+		expect(String.endsWith("foobar", "foo")).toEqual(false)
+	end)
+end)
+
+describe("String.addCommas", function()
+	it("adds commas to a large number", function()
+		expect(String.addCommas(1000000)).toEqual("1,000,000")
+	end)
+
+	it("leaves numbers under a thousand unchanged", function()
+		expect(String.addCommas(123)).toEqual("123")
+	end)
+
+	it("handles negative numbers", function()
+		expect(String.addCommas(-1234567)).toEqual("-1,234,567")
+	end)
+
+	it("accepts a string number", function()
+		expect(String.addCommas("1234567")).toEqual("1,234,567")
+	end)
+
+	it("uses a custom separator", function()
+		expect(String.addCommas(1234, ".")).toEqual("1.234")
+	end)
+end)

package/src/jest.config.lua

@@ -0,0 +1,3 @@
+return {
+	testMatch = { "**/*.spec" },
+}

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,25 @@
+{
+  "name": "StringTest",
+  "globIgnorePaths": [
+    "**/.package-lock.json",
+    "**/.pnpm",
+    "**/.pnpm-workspace-state-v1.json",
+    "**/.modules.yaml",
+    "**/.ignored",
+    "**/.ignored_*"
+  ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "$properties": {
+        "LoadStringEnabled": true
+      },
+      "string": {
+        "$path": ".."
+      },
+      "Script": {
+        "$path": "scripts/Server"
+      }
+    }
+  }
+}

package/test/scripts/Server/ServerMain.server.lua

@@ -0,0 +1,14 @@
+--!nonstrict
+--[[
+	@class ServerMain
+]]
+
+local ServerScriptService = game:GetService("ServerScriptService")
+
+local root = ServerScriptService.string
+local loader = root:FindFirstChild("LoaderUtils", true).Parent
+local require = require(loader).bootstrapGame(root)
+
+local NevermoreTestRunnerUtils = require("NevermoreTestRunnerUtils")
+
+NevermoreTestRunnerUtils.runTestsIfNeededAsync(root)