Merge pull request #30 from ieedan/add-pad

feat: Add `pad` for left and right pad utilities

.changeset/ten-crabs-repeat.md

@@ -0,0 +1,5 @@
+---
+"ts-blocks": minor
+---
+
+Add `pad` utility for left and right pad functions.

blocks/utilities/pad.test.ts

@@ -0,0 +1,30 @@
+import { expect, test } from 'vitest';
+import { leftPad, rightPad } from './pad';
+
+// leftPad
+
+test('leftPad: Correct padding', () => {
+	expect(leftPad('Hello', 3)).toBe('   Hello');
+});
+
+test('leftPad: Correct padding `padWith`', () => {
+	expect(leftPad('Hello', 3, '.')).toBe('...Hello');
+});
+
+test('leftPad: Correct padding with 0', () => {
+	expect(leftPad('Hello', 0)).toBe('Hello');
+});
+
+// rightPad
+
+test('rightPad: Correct padding', () => {
+	expect(rightPad('Hello', 3)).toBe('Hello   ');
+});
+
+test('rightPad: Correct padding `padWith`', () => {
+	expect(rightPad('Hello', 3, '.')).toBe('Hello...');
+});
+
+test('rightPad: Correct padding with 0', () => {
+	expect(rightPad('Hello', 0)).toBe('Hello');
+});

blocks/utilities/pad.ts

@@ -0,0 +1,37 @@
+/** Adds the `padWith` (default `' '`) to the string the amount of times specified by the `space` argument
+ *
+ * @param str String to add padding to
+ * @param space Whitespace to add
+ * @param padWith Character to use to pad the string
+ * @returns
+ *
+ * ## Usage
+ * ```ts
+ * const padded = leftPad("Hello", 3, ".");
+ *
+ * console.log(padded); // '...Hello'
+ * ```
+ */
+const leftPad = (str: string, space: number, padWith = ' ') => {
+	return padWith.repeat(space) + str;
+};
+
+/** Adds the `padWith` (default `' '`) to the string the amount of times specified by the `space` argument
+ *
+ * @param str String to add padding to
+ * @param space Whitespace to add
+ * @param padWith Character to use to pad the string
+ * @returns
+ *
+ * ## Usage
+ * ```ts
+ * const padded = rightPad("Hello", 3, ".");
+ *
+ * console.log(padded); // 'Hello...'
+ * ```
+ */
+const rightPad = (str: string, space: number, padWith = ' ') => {
+	return str + padWith.repeat(space);
+};
+
+export { leftPad, rightPad };

blocks/utilities/sleep.test.ts

@@ -1,7 +1,6 @@
 import { expect, test } from 'vitest';
 import { sleep } from './sleep';
 
-// This test takes a bit and its a very simple function so feel free to take it out
 test('Expect time elapsed', async () => {
 	const start = Date.now();
 

package.json

@@ -7,10 +7,7 @@
 		"type": "git",
 		"url": "git+https://github.com/ieedan/ts-blocks"
 	},
-	"keywords": [
-		"changelog",
-		"date"
-	],
+	"keywords": ["changelog", "date"],
 	"author": "Aidan Bleser",
 	"license": "MIT",
 	"bugs": {

src/blocks.ts

@@ -24,6 +24,9 @@ const blocks: Record<string, Block> = {
 	sleep: {
 		category: 'utilities',
 	},
+	pad: {
+		category: 'utilities',
+	},
 };
 
 export { blocks };