refactor: update prettier command in package.json and pr-check yml

gabriel-logan · gabriel-logan · commit dbeced5a0b9b · 2024-10-20T10:42:01.000-03:00
diff --git a/.github/workflows/typescript-pr-check.yml b/.github/workflows/typescript-pr-check.yml
@@ -23,9 +23,11 @@ jobs:
 
       - name: Install dependencies
         run: yarn install
+      - name: Run Prettier
+        run: yarn prettier
       - name: Run lint
         run: yarn lint
-      - name: Run tests
-        run: yarn pr-check
+      - name: Run test
+        run: yarn test
       - name: Run build
         run: yarn build
diff --git a/package.json b/package.json
@@ -21,7 +21,7 @@
 		"build:browser": "webpack",
 		"build": "yarn build:types && yarn build:browser",
 		"lint": "eslint . --ext .ts",
-		"prettier": "prettier --write .",
+		"prettier": "prettier --write '**/*.{ts,js}'",
 		"pr-check": "yarn prettier && yarn lint && yarn build && yarn test"
 	},
 	"repository": {
diff --git a/tests/src/cpfValidator.test.ts b/tests/src/cpfValidator.test.ts
@@ -75,7 +75,9 @@ describe("cpfIsValid", () => {
 		let result = cpfIsValid("");
 		expect(result.isValid).toBe(false);
 
-		expect(() => cpfIsValid(null as any)).toThrow("The input should be a string.");
+		expect(() => cpfIsValid(null as any)).toThrow(
+			"The input should be a string.",
+		);
 	});
 
 	it("should return isValid as false and the correct error message when CPF does not have 11 digits after cleaning", () => {
diff --git a/tests/src/getOnlyEmail.test.ts b/tests/src/getOnlyEmail.test.ts
@@ -93,18 +93,18 @@ describe("getOnlyEmail", () => {
 		expect(result).toBe("alexa@google.com");
 	});
 
-	it('should clean the domain from the email when cleanDomain is true', () => {
+	it("should clean the domain from the email when cleanDomain is true", () => {
 		const result = getOnlyEmail(
 			"Entre em contato com a equipe:	alexa@google.com.br",
-			{ cleanDomain: true }
+			{ cleanDomain: true },
 		);
 		expect(result).toBe("alexa@google.com.br");
 	});
 
-	it('should clean the domain from the email using a custom domain list', () => {
+	it("should clean the domain from the email using a custom domain list", () => {
 		const result = getOnlyEmail(
 			"Entre em contato com a equipe:	alexa@google.custom",
-			{ cleanDomain: [".custom"] }
+			{ cleanDomain: [".custom"] },
 		);
 		expect(result).toBe("alexa@google.custom");
 	});
diff --git a/tests/src/isAscii.test.ts b/tests/src/isAscii.test.ts
@@ -7,7 +7,9 @@ describe("isAscii", () => {
 	});
 
 	it("should return true when the input is an empty string", () => {
-		expect(() => isAscii(" ")).toThrow("Input value must not be an empty string.");
+		expect(() => isAscii(" ")).toThrow(
+			"Input value must not be an empty string.",
+		);
 	});
 
 	it("should return false when the input is not ASCII", () => {
diff --git a/tests/src/isDate.test.ts b/tests/src/isDate.test.ts
@@ -14,8 +14,12 @@ describe("isDate", () => {
 	});
 
 	it("should throw an error when the input is a empty string", () => {
-		expect(() => isDate("")).toThrow("Input value must not be an empty string.");
-		expect(() => isDate(" ")).toThrow("Input value must not be an empty string.");
+		expect(() => isDate("")).toThrow(
+			"Input value must not be an empty string.",
+		);
+		expect(() => isDate(" ")).toThrow(
+			"Input value must not be an empty string.",
+		);
 	});
 
 	it("should return false if isNaN or !(dateObject instanceof Date)", () => {
diff --git a/tests/src/isDecimal.test.ts b/tests/src/isDecimal.test.ts
@@ -73,7 +73,9 @@ describe("isDecimal", () => {
 	});
 
 	it("should throw error when the input is a function", () => {
-		function func() { /* document why this function 'func' is empty */  }
+		function func() {
+			/* document why this function 'func' is empty */
+		}
 
 		expect(() => isDecimal(func() as any) as any).toThrow(errorToThrow);
 	});
@@ -191,7 +193,9 @@ describe("isDecimal", () => {
 	});
 
 	it("should throw error when the input is a function", () => {
-		function func() { /* document why this function 'func' is empty */  }
+		function func() {
+			/* document why this function 'func' is empty */
+		}
 
 		expect(() => isDecimal(func as any)).toThrow(
 			"Input value must be a string or a number.",
diff --git a/tests/src/isValidVideo.test.ts b/tests/src/isValidVideo.test.ts
@@ -171,32 +171,56 @@ describe("isValidVideo", () => {
 		expect(result1).toBe(false);
 	});
 
-	test('validateMp4 should return true for specific byte sequence', () => {
+	test("validateMp4 should return true for specific byte sequence", () => {
 		const fileBuffer = Buffer.from([
-			0x00, 0x00, 0x00, 0x18, // First 4 bytes
-			0x66, 0x74, 0x79, 0x70  // Next 4 bytes
+			0x00,
+			0x00,
+			0x00,
+			0x18, // First 4 bytes
+			0x66,
+			0x74,
+			0x79,
+			0x70, // Next 4 bytes
 		]);
 
 		const result = isValidVideo(fileBuffer);
 		expect(result).toBe(true);
 	});
 
-	test('validateMp4 should return true for byte sequence 1', () => {
+	test("validateMp4 should return true for byte sequence 1", () => {
 		const fileBuffer = Buffer.from([
-			0x00, 0x00, 0x00, 0x20, // First 4 bytes
-			0x66, 0x74, 0x79, 0x70, // Next 4 bytes
-			0x6d, 0x70, 0x34, 0x32  // Last 4 bytes
+			0x00,
+			0x00,
+			0x00,
+			0x20, // First 4 bytes
+			0x66,
+			0x74,
+			0x79,
+			0x70, // Next 4 bytes
+			0x6d,
+			0x70,
+			0x34,
+			0x32, // Last 4 bytes
 		]);
 
 		const result = isValidVideo(fileBuffer);
 		expect(result).toBe(true);
 	});
 
-	test('validateMp4 should return true for byte sequence 2', () => {
+	test("validateMp4 should return true for byte sequence 2", () => {
 		const fileBuffer = Buffer.from([
-			0x00, 0x00, 0x00, 0x1c, // First 4 bytes
-			0x66, 0x74, 0x79, 0x70, // Next 4 bytes
-			0x69, 0x73, 0x6f, 0x6d  // Last 4 bytes
+			0x00,
+			0x00,
+			0x00,
+			0x1c, // First 4 bytes
+			0x66,
+			0x74,
+			0x79,
+			0x70, // Next 4 bytes
+			0x69,
+			0x73,
+			0x6f,
+			0x6d, // Last 4 bytes
 		]);
 
 		const result = isValidVideo(fileBuffer);
diff --git a/tests/src/validateEmail.test.ts b/tests/src/validateEmail.test.ts
@@ -88,15 +88,21 @@ describe("validateEmail", () => {
 
 	it("should throw an error when errorMsg is not an array or null", () => {
 		// @ts-ignore
-		expect(() => validateEmail("jor@dio.com", { errorMsg: 123 })).toThrow("errorMsg must be an Array or null");
+		expect(() => validateEmail("jor@dio.com", { errorMsg: 123 })).toThrow(
+			"errorMsg must be an Array or null",
+		);
 	});
 
 	it("should throw an error if any element of the errorMsg array is different from string or null", () => {
-		expect(() => validateEmail("jd@dio.com", { errorMsg: [123 as any] })).toThrow("All values within the array must be strings or null/undefined.");
-	})
+		expect(() =>
+			validateEmail("jd@dio.com", { errorMsg: [123 as any] }),
+		).toThrow("All values within the array must be strings or null/undefined.");
+	});
 
 	it("should throw an error when maxLength must be a number and cannot be less than 1", () => {
-		expect(() => validateEmail("aa@dao.com", { maxLength: 0 })).toThrow("maxLength must be a number and cannot be less than 1");
+		expect(() => validateEmail("aa@dao.com", { maxLength: 0 })).toThrow(
+			"maxLength must be a number and cannot be less than 1",
+		);
 	});
 
 	it("should invalidate an email that does not end with the country code", () => {
@@ -110,4 +116,4 @@ describe("validateEmail", () => {
 		expect(result.isValid).toBe(true);
 		expect(result.errorMsg).toBe(null);
 	});
-});
+});
diff --git a/tests/src/validateName.test.ts b/tests/src/validateName.test.ts
@@ -11,7 +11,7 @@ describe("validateName", () => {
 		const result: ValidateFunctions = validateName("");
 		expect(result.isValid).toBe(false);
 		expect(result.errorMsg).toBe("Name cannot be empty");
-	});	
+	});
 
 	it("should return isValid as false for names with numbers", () => {
 		const result: ValidateFunctions = validateName("John123");
diff --git a/tests/src/validatePhoneNumber.test.ts b/tests/src/validatePhoneNumber.test.ts
@@ -34,9 +34,9 @@ describe("validatePhoneNumber", () => {
 	});
 
 	it("should throw an error when errorMsg is not an array or null", () => {
-		expect(() => validatePhoneNumber("(555) 123-4567", "Custom error" as any)).toThrow(
-			"errorMsg must be an Array or null",
-		);
+		expect(() =>
+			validatePhoneNumber("(555) 123-4567", "Custom error" as any),
+		).toThrow("errorMsg must be an Array or null");
 	});
 
 	it("should throw an error when the input is not a string", () => {
diff --git a/tests/src/validateSurname.test.ts b/tests/src/validateSurname.test.ts
@@ -27,8 +27,7 @@ describe("validateSurname", () => {
 		const result: ValidateFunctions = validateSurname("");
 		expect(result.isValid).toBe(false);
 		expect(result.errorMsg).toBe("Surname cannot be empty");
-	});	
-
+	});
 
 	it("should return false if (/(\\w)\\1\\1/.test(surname)) is true", () => {
 		const result: ValidateFunctions = validateSurname("Johnnn");
@@ -37,18 +36,22 @@ describe("validateSurname", () => {
 	});
 
 	it("should throw an error if maxLength or minLength less than 1", () => {
-		expect(() => validateSurname("John", { minLength: 0, maxLength: 20 })).toThrow(
+		expect(() =>
+			validateSurname("John", { minLength: 0, maxLength: 20 }),
+		).toThrow(
 			"maxLength or minLength must be a number and cannot be less than 1",
 		);
-		expect(() => validateSurname("John", { minLength: 1, maxLength: 0 })).toThrow(
+		expect(() =>
+			validateSurname("John", { minLength: 1, maxLength: 0 }),
+		).toThrow(
 			"maxLength or minLength must be a number and cannot be less than 1",
 		);
 	});
 
 	it("should throw an error if minLength is greater than maxLength", () => {
-		expect(() => validateSurname("John", { minLength: 20, maxLength: 1 })).toThrow(
-			"minLength cannot be greater than maxLength",
-		);
+		expect(() =>
+			validateSurname("John", { minLength: 20, maxLength: 1 }),
+		).toThrow("minLength cannot be greater than maxLength");
 	});
 
 	it("returns error for surname with special characters", () => {
@@ -118,11 +121,11 @@ describe("validateSurname", () => {
 	});
 
 	it("should throw an error when errorMsg is not an array or null", () => {
-		expect(() => validateSurname("Johnson", {
-			errorMsg: "Custom error" as unknown as (string | null)[],
-		})).toThrow(
-			"errorMsg must be an Array or null",
-		);
+		expect(() =>
+			validateSurname("Johnson", {
+				errorMsg: "Custom error" as unknown as (string | null)[],
+			}),
+		).toThrow("errorMsg must be an Array or null");
 	});
 
 	it("should throw an error when the input is not a string", () => {
diff --git a/tests/src/validateTextarea.test.ts b/tests/src/validateTextarea.test.ts
@@ -2,9 +2,9 @@ import validateTextarea from "../../src/validateTextarea";
 
 describe("validateTextarea", () => {
 	it("should throw an error when the input is not a string", () => {
-		expect(() =>
-			validateTextarea(12345678 as any),
-		).toThrow("The input should be a string.");
+		expect(() => validateTextarea(12345678 as any)).toThrow(
+			"The input should be a string.",
+		);
 	});
 
 	it("should throw an error when errorMsg is not an array", () => {
@@ -23,13 +23,17 @@ describe("validateTextarea", () => {
 				isRequired: true,
 				maxLength: -1,
 			}),
-		).toThrow("maxLength or minLength must be a number and cannot be less than 1");
+		).toThrow(
+			"maxLength or minLength must be a number and cannot be less than 1",
+		);
 		expect(() =>
 			validateTextarea("This is a valid textarea.", {
 				isRequired: true,
 				maxLength: "a" as any,
 			}),
-		).toThrow("maxLength or minLength must be a number and cannot be less than 1");
+		).toThrow(
+			"maxLength or minLength must be a number and cannot be less than 1",
+		);
 	});
 
 	it("validates textarea with correct length", () => {
diff --git a/tests/src/validateUSPhoneNumber.test.ts b/tests/src/validateUSPhoneNumber.test.ts
@@ -34,9 +34,9 @@ describe("validateUSPhoneNumber", () => {
 	});
 
 	it("should throw an error when errorMsg is not an array or null", () => {
-		expect(() => validateUSPhoneNumber("(555) 123-4567", "error msg" as any)).toThrow(
-			"errorMsg must be an Array or null",
-		);
+		expect(() =>
+			validateUSPhoneNumber("(555) 123-4567", "error msg" as any),
+		).toThrow("errorMsg must be an Array or null");
 	});
 
 	it("should throw an error when the input is not a string", () => {
diff --git a/tests/src/validateUsername.test.ts b/tests/src/validateUsername.test.ts
@@ -2,7 +2,9 @@ import validateUsername from "../../src/validateUsername";
 
 describe("validateUsername", () => {
 	it("should throw an error for non-string inputs", () => {
-		expect(() => validateUsername(123 as any)).toThrow("The input should be a string.");
+		expect(() => validateUsername(123 as any)).toThrow(
+			"The input should be a string.",
+		);
 	});
 	it("validates username with correct length", () => {
 		const result = validateUsername("User123", { minLength: 3, maxLength: 25 });
@@ -22,18 +24,18 @@ describe("validateUsername", () => {
 	it("should throw an error if maxLength or minlength is NaN", () => {
 		expect(() =>
 			validateUsername("User123", {
-				minLength: 'a' as any,
+				minLength: "a" as any,
 				maxLength: 25,
 			}),
 		).toThrow("maxLength or minLength must be a number");
 		expect(() =>
 			validateUsername("User123", {
 				minLength: 3,
-				maxLength: 'a' as any,
+				maxLength: "a" as any,
 			}),
 		).toThrow("maxLength or minLength must be a number");
 	});
-	
+
 	it("should throw an error if minLength is greater than maxLength", () => {
 		expect(() =>
 			validateUsername("User123", {
