95% code test coverage

.github/checkCoverage.ts

@@ -0,0 +1,54 @@
+import { parseString } from 'xml2js';
+import { readFile } from 'fs';
+
+function parseXMLFile(): Promise<any> {
+ return new Promise((resolve, reject) => {
+ readFile('.github/coverageData.xml', 'utf8', (err, data) => {
+ if (err) {
+ reject('File Dose not exist!');
+ return;
+ }
+
+ parseString(data, (err, result) => {
+ if (err) {
+ reject('Something Went wrong!');
+ return;
+ }
+
+ resolve(result);
+ });
+ });
+ });
+}
+
+const data = await parseXMLFile();
+const codeStats = data.coverage.project[0].metrics[0].$;
+const info = {
+ statements: Number(codeStats.statements),
+ coveredstatements: Number(codeStats.coveredstatements),
+ conditionals: Number(codeStats.conditionals),
+ coveredconditionals: Number(codeStats.coveredconditionals),
+ methods: Number(codeStats.methods),
+ coveredmethods: Number(codeStats.coveredmethods)
+};
+
+if (95 > (info.coveredstatements / info.statements) * 100) {
+ throw new Error('Statements is required to be 95% or higher');
+}
+
+if (95 > (info.coveredconditionals / info.conditionals) * 100) {
+ throw new Error('Conditionals is required to be 95% or higher');
+}
+
+if (95 > (info.coveredmethods / info.methods) * 100) {
+ throw new Error('Methods is required to be 95% or higher');
+}
+
+if (
+ 95 >
+ ((info.coveredstatements + info.coveredconditionals + info.coveredmethods) /
+ (info.statements + info.conditionals + info.methods)) *
+ 100
+) {
+ throw new Error('Everythng Combinded is required to be 95% or higher');
+}

.github/workflows/ci-cd.yml

@@ -123,4 +123,10 @@ jobs:
  - name: Check tests
  env:
  HYPIXEL_KEY: ${{ secrets.HYPIXEL_KEY }}
- run: pnpm test
+ run: pnpm test:coverage
+
+ - name: Move Coverage Data
+ run: mv coverage/clover.xml .github/coverageData.xml
+
+ - name: Check Coverage
+ run: npx tsx .github/checkCoverage.ts

.gitignore

@@ -4,3 +4,4 @@ oldreborn/
 dist/
 .eslintcache
 coverage/
+.github/coverageData.xml

.npmignore

@@ -4,4 +4,5 @@ oldreborn/
 .eslintcache
 .git
 .gitignore
-coverage/
+coverage/
+.github/coverageData.xml

package.json

@@ -22,7 +22,8 @@
  "prettier": "npx prettier --write src/",
  "build": "npx tsc",
  "test": "npx vitest run",
- "test:coverage": "npx vitest --ui --coverage"
+ "test:coverage": "npx vitest run --coverage",
+ "test:ui": "npx vitest --ui --coverage"
  },
  "engines": {
  "node": ">=20.16.0"
@@ -52,6 +53,7 @@
  "@j4cobi/eslint-plugin-sort-imports": "^1.0.2",
  "@types/eslint": "^9.6.1",
  "@types/node": "^20.16.5",
+ "@types/xml2js": "^0.4.14",
  "@vitest/coverage-v8": "^2.0.5",
  "@vitest/ui": "^2.0.5",
  "dotenv": "^16.4.5",
@@ -61,6 +63,7 @@
  "prettier": "^3.3.3",
  "typescript": "^5.5.4",
  "typescript-eslint": "^8.4.0",
- "vitest": "^2.0.5"
+ "vitest": "^2.0.5",
+ "xml2js": "^0.6.2"
  }
 }

src/API/API.d.ts

@@ -14,3 +14,5 @@ export interface SkyblockRequestOptions extends RequestOptions {
  garden?: boolean;
  museum?: boolean;
 }
+
+export type GuildFetchOptions = 'id' | 'name' | 'player';

src/API/getAchievements.test.ts

@@ -7,7 +7,7 @@ import { StaticGameNames } from '../typings';
 import { expect, expectTypeOf, test } from 'vitest';
 
 test('getAchievements (raw)', async () => {
- const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false });
+ const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-expect-error
  const data = await client.getAchievements({ raw: true });
@@ -17,7 +17,7 @@ test('getAchievements (raw)', async () => {
 });
 
 test('getAchievements', async () => {
- const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false });
+ const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-expect-error
  const data = await client.getAchievements();

src/API/getActiveHouses.test.ts

@@ -3,7 +3,7 @@ import House from '../structures/House';
 import { expect, expectTypeOf, test } from 'vitest';
 
 test('getActiveHouses (raw)', async () => {
- const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false });
+ const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-expect-error
  const data = await client.getActiveHouses({ raw: true });
@@ -13,7 +13,7 @@ test('getActiveHouses (raw)', async () => {
 });
 
 test('getActiveHouses', async () => {
- const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false });
+ const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-expect-error
  const data = await client.getActiveHouses();
@@ -30,9 +30,9 @@ test('getActiveHouses', async () => {
  expect(house.owner).toBeDefined();
  expectTypeOf(house.owner).toEqualTypeOf<string>();
  expect(house.createdAtTimestamp).toBeDefined();
- expectTypeOf(house.createdAtTimestamp).toEqualTypeOf<number>();
+ expectTypeOf(house.createdAtTimestamp).toEqualTypeOf<number | null>();
  expect(house.createdAt).toBeDefined();
- expectTypeOf(house.createdAt).toEqualTypeOf<Date>();
+ expectTypeOf(house.createdAt).toEqualTypeOf<Date | null>();
  expect(house.players).toBeDefined();
  expectTypeOf(house.players).toEqualTypeOf<number>();
  expect(house.cookies).toBeDefined();

src/API/getBoosters.test.ts

@@ -1,10 +1,10 @@
 import Booster from '../structures/Boosters/Booster';
 import Client from '../Client';
-import Game from '../structures/Game';
+import Game, { GameCode, GameID, GameString } from '../structures/Game';
 import { expect, expectTypeOf, test } from 'vitest';
 
 test('getBoosters (raw)', async () => {
- const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false });
+ const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-expect-error
  const data = await client.getBoosters({ raw: true });
@@ -14,7 +14,7 @@ test('getBoosters (raw)', async () => {
 });
 
 test('getBoosters', async () => {
- const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false });
+ const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-expect-error
  const data = await client.getBoosters();
@@ -37,7 +37,28 @@ test('getBoosters', async () => {
  expect(booster.activated).toBeDefined();
  expectTypeOf(booster.activated).toEqualTypeOf<Date>();
  expect(booster.game).toBeDefined();
- expectTypeOf(booster.game).toEqualTypeOf<Game | null>();
+ expectTypeOf(booster.game).toEqualTypeOf<Game>();
+ expect(booster.game).toBeDefined();
+ expectTypeOf(booster.game).toEqualTypeOf<Game>();
+ expect(booster.game.game).toBeDefined();
+ expectTypeOf(booster.game.game).toEqualTypeOf<GameID | GameCode>();
+ expect(booster.game.id).toBeDefined();
+ expectTypeOf(booster.game.id).toEqualTypeOf<GameID | null>();
+ expect(booster.game.code).toBeDefined();
+ expectTypeOf(booster.game.code).toEqualTypeOf<GameCode | null>();
+ expect(booster.game.name).toBeDefined();
+ expectTypeOf(booster.game.name).toEqualTypeOf<GameString | null>();
+ expect(booster.game.found).toBeDefined();
+ expectTypeOf(booster.game.found).toEqualTypeOf<boolean>();
+ expect(booster.game.toString()).toBeDefined();
+ expect(booster.game.toString()).toBe(booster.game.name);
+ expectTypeOf(booster.game.toString()).toEqualTypeOf<GameString | null>();
+ expect(Game.IDS).toBeDefined();
+ expectTypeOf(Game.IDS).toEqualTypeOf<GameID[]>();
+ expect(Game.CODES).toBeDefined();
+ expectTypeOf(Game.CODES).toEqualTypeOf<GameCode[]>();
+ expect(Game.NAMES).toBeDefined();
+ expectTypeOf(Game.NAMES).toEqualTypeOf<GameString[]>();
  expect(booster.isActive).toBeDefined();
  expectTypeOf(booster.isActive).toEqualTypeOf<boolean>();
  expect(booster.type).toBeDefined();

src/API/getChallenges.test.ts

@@ -5,7 +5,7 @@ import { StaticGameNames } from '../typings';
 import { expect, expectTypeOf, test } from 'vitest';
 
 test('getChallenges (raw)', async () => {
- const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false });
+ const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-expect-error
  const data = await client.getChallenges({ raw: true });
@@ -15,7 +15,7 @@ test('getChallenges (raw)', async () => {
 });
 
 test('getChallenges', async () => {
- const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false });
+ const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-expect-error
  const data = await client.getChallenges();

src/API/getGameCounts.test.ts

@@ -3,7 +3,7 @@ import GameCounts from '../structures/GameCounts';
 import { expect, expectTypeOf, test } from 'vitest';
 
 test('getGameCounts (raw)', async () => {
- const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false });
+ const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-expect-error
  const data = await client.getGameCounts({ raw: true });
@@ -13,7 +13,7 @@ test('getGameCounts (raw)', async () => {
 });
 
 test('getGameCounts', async () => {
- const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false });
+ const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-expect-error
  const data = await client.getGameCounts();