@quenty/string 2.1.0 → 2.2.1-canary.238.f89c386.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.2.1-canary.238.f89c386.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@2.2.0...@quenty/string@2.2.1-canary.238.f89c386.0) (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))
+
+
+
+
+
 # [2.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/string@2.0.0...@quenty/string@2.1.0) (2021-09-22)
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 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

package/README.md

@@ -1,14 +1,21 @@
 ## String
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <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/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <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>
 
-This module provides utility functions for strings
+This module provides utility functions for strings
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/string">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/string --save
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/string",
-  "version": "2.1.0",
+  "version": "2.2.1-canary.238.f89c386.0",
   "description": "This module provides utility functions for strings",
   "keywords": [
     "Roblox",
@@ -28,5 +28,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6288c63115f31544fce6663d018826e81ef01c7f"
+  "gitHead": "f89c3863db94c96adc936ea31a49e0c770756dd0"
 }

package/src/Shared/String.lua

@@ -1,8 +1,17 @@
---- This module provides utility functions for strings
--- @module String
+--[=[
+	This module provides utility functions for strings
+	@class String
+]=]
 
 local String = {}
 
+--[=[
+	Trims the string of the given pattern
+
+	@param str string
+	@param pattern string? -- Defaults to whitespace
+	@return string
+]=]
 function String.trim(str, pattern)
 	if not pattern then
 		return str:match("^%s*(.-)%s*$")
@@ -14,7 +23,11 @@ function String.trim(str, pattern)
 	end
 end
 
---- Sets it to UpperCamelCase
+--[=[
+	Converts the string to UpperCamelCase
+	@param str string
+	@return string
+]=]
 function String.toCamelCase(str)
 	str = str:lower()
 	str = str:gsub("[ _](%a)", string.upper)
@@ -24,10 +37,21 @@ function String.toCamelCase(str)
 	return str
 end
 
+
+--[=[
+	Uppercases the first letter of the string
+	@param str string
+	@return string
+]=]
 function String.uppercaseFirstLetter(str)
 	return str:gsub("^%a", string.upper)
 end
 
+--[=[
+	Converts to the string to lowerCamelCase
+	@param str string
+	@return string
+]=]
 function String.toLowerCamelCase(str)
 	str = str:lower()
 	str = str:gsub("[ _](%a)", string.upper)
@@ -37,16 +61,37 @@ function String.toLowerCamelCase(str)
 	return str
 end
 
+--[=[
+	Converts the string to _privateCamelCase
+	@param str string
+	@return string
+]=]
 function String.toPrivateCase(str)
 	return "_" .. str:sub(1, 1):lower() .. str:sub(2, #str)
 end
 
--- Only trims the front of the string...
+--[=[
+	Like trim, but only applied to the beginning of the setring
+	@param str string
+	@param pattern string? -- Defaults to whitespace
+	@return string
+]=]
 function String.trimFront(str, pattern)
 	pattern = pattern or "%s";
 	return (str:gsub("^"..pattern.."*(.-)"..pattern.."*", "%1"))
 end
 
+--[=[
+	Counts the number of times a char appears in a string.
+
+	:::note
+	Note that this is not UTF8 safe
+	:::
+
+	@param str string
+	@param char string
+	@return number
+]=]
 function String.checkNumOfCharacterInString(str, char)
 	local count = 0
 	for _ in string.gmatch(str, char) do
@@ -55,17 +100,30 @@ function String.checkNumOfCharacterInString(str, char)
 	return count
 end
 
---- Checks if a string is empty or nil
+--[=[
+	Checks if a string is empty or nil
+	@param str string
+	@return boolean
+]=]
 function String.isEmptyOrWhitespaceOrNil(str)
 	return type(str) ~= "string" or str == "" or String.isWhitespace(str)
 end
 
---- Returns whether or not text is whitespace
+--[=[
+	Returns whether or not text is only whitespace
+	@param str string
+	@return boolean
+]=]
 function String.isWhitespace(str)
 	return string.match(str, "[%s]+") == str
 end
 
---- Converts text to have a ... after it if it's too long.
+--[=[
+	Converts text to have a ... after it if it's too long.
+	@param str string
+	@param characterLimit number
+	@return string
+]=]
 function String.elipseLimit(str, characterLimit)
 	if #str > characterLimit then
 		str = str:sub(1, characterLimit-3).."..."
@@ -73,6 +131,12 @@ function String.elipseLimit(str, characterLimit)
 	return str
 end
 
+--[=[
+	Removes a prefix from a string if it exists
+	@param str string
+	@param prefix string
+	@return string
+]=]
 function String.removePrefix(str, prefix)
 	if str:sub(1, #prefix) == prefix then
 		return str:sub(#prefix + 1)
@@ -81,6 +145,12 @@ function String.removePrefix(str, prefix)
 	end
 end
 
+--[=[
+	Removes a postfix from a string if it exists
+	@param str string
+	@param postfix string
+	@return string
+]=]
 function String.removePostfix(str, postfix)
 	if str:sub(-#postfix) == postfix then
 		return str:sub(1, -#(postfix) - 1)
@@ -89,10 +159,31 @@ function String.removePostfix(str, postfix)
 	end
 end
 
+--[=[
+	Returns if a string ends with a postfix
+	@param str string
+	@param postfix string
+	@return boolean
+]=]
 function String.endsWith(str, postfix)
 	return str:sub(-#postfix) == postfix
 end
 
+--[=[
+	Returns if a string starts with a postfix
+	@param str string
+	@param prefix string
+	@return boolean
+]=]
+function String.startsWith(str, prefix)
+	return str:sub(1, #prefix) == prefix
+end
+
+--[=[
+	Adds commas to a number. Not culture aware.
+	@param number string | number
+	@return string
+]=]
 function String.addCommas(number)
 	if type(number) == "number" then
 		number = tostring(number)