Merge pull request #97 from justindhillon/test

Write new tests

README.md

@@ -2,7 +2,7 @@
 [![Total Downloads](https://img.shields.io/npm/dt/link-inspector)](https://www.npmjs.com/package/link-inspector)
 
 <div align="center">
-<img height="150px" src="https://github.com/justindhillon/link-inspector/assets/145078271/532b05a6-dd98-48f3-aad1-f469c093752a">
+<img height="150px" src="https://raw.githubusercontent.com/justindhillon/link-inspector/test/tests/test-folder/logo.png">
 
 <h1>link-inspector</h1>
 <h3>Automatically scan links, files, and directories for broken links.</h3>

checkLink.ts

@@ -10,6 +10,8 @@ const ignoredCodes: Set<number> = new Set([
 ]);
 
 const ignoredURLs: Set<string> = new Set([
+  'localhost',
+  '127.0.0.1',
   'example.com',
   'www.example.com',
   'example.org',

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package.json

@@ -4,7 +4,6 @@
     "author": "Justin Dhillon",
     "license": "AGPL-3.0-or-later",
     "description": "NPM Tool That Audits Projects For Broken Links",
-
     "main": "dist/index.js",
     "module": "dist/index.mjs",
     "types": "dist/index.d.ts",
@@ -14,7 +13,6 @@
     "files": [
         "!**/*"
     ],
-
     "repository": {
         "type": "git",
         "url": "git+https://github.com/justindhillon/link-inspector.git"
@@ -30,14 +28,15 @@
         "url": "https://github.com/justindhillon/link-inspector/issues"
     },
     "homepage": "https://github.com/justindhillon/link-inspector#readme",
-
     "scripts": {
         "build": "tsup index.ts --format cjs,esm --dts --minify && tsup bin.ts --minify",
         "lint": "tsc",
-        "test": "ts-node tests/test.ts"
+        "test": "jest"
     },
     "devDependencies": {
-        "ts-node": "^10.9.2",
+        "@types/jest": "^29.5.12",
+        "jest": "^29.7.0",
+        "ts-jest": "^29.1.2",
         "tsup": "^8.0.1",
         "typescript": "^5.3.3"
     },

tests/checkLink.test.ts

@@ -0,0 +1,37 @@
+import { checkLink } from "../checkLink";
+
+test('api. returns false', async () => {
+    expect(await checkLink("https://api.pythagora.io/telemetry")).toBe(false);
+});
+
+test('localhost returns false', async () => {
+    expect(await checkLink("https://localhost/")).toBe(false);
+    expect(await checkLink("https://127.0.0.1/")).toBe(false);
+});
+
+test('White Listed URLS return false', async () => {
+    expect(await checkLink("https://www.google.com/")).toBe(false);
+    expect(await checkLink("https://example.com/")).toBe(false);
+    expect(await checkLink("https://www.example.com/")).toBe(false);
+    expect(await checkLink("https://example.org/")).toBe(false);
+    expect(await checkLink("https://www.example.org/")).toBe(false);
+    expect(await checkLink("https://goo.gl/")).toBe(false);
+    expect(await checkLink("https://fonts.googleapis.com")).toBe(false);
+    expect(await checkLink("https://fonts.gstatic.com")).toBe(false);
+});
+
+test('Valid Links return false', async () => {
+    expect(await checkLink("https://www.google.com/")).toBe(false);
+    expect(await checkLink("https://www.wikipedia.org/")).toBe(false);
+    expect(await checkLink("https://www.nasa.gov/")).toBe(false);
+    expect(await checkLink("https://www.bbc.com/")).toBe(false);
+    expect(await checkLink("https://www.un.org/")).toBe(false);
+});
+
+test('Broken Links return true', async () => {
+    expect(await checkLink("https://www.google.com/page-not-found")).toBe(true);
+    expect(await checkLink("https://www.wikipedia.org/page-not-found")).toBe(true);
+    expect(await checkLink("https://www.nasa.gov/page-not-found")).toBe(true);
+    expect(await checkLink("https://www.bbc.com/page-not-found")).toBe(true);
+    expect(await checkLink("https://www.un.org/page-not-found")).toBe(true);
+});

tests/index.test.ts

@@ -0,0 +1,37 @@
+import linkInspector from "../index";
+
+test('Broken link calls callback', async () => {
+    const promise1 = new Promise<void>((resolve) => {
+        const callback = (link: string) => {
+            expect(link).toBe('https://www.google.com/page-not-found');
+            resolve();
+        };
+
+        linkInspector("https://www.google.com/page-not-found", callback);
+    });
+
+    const promise2 = new Promise<void>((resolve) => {
+        const callback = (link: string) => {
+            expect(link).toBe('https://www.wikipedia.org/page-not-found');
+            resolve();
+        };
+
+        linkInspector("https://www.wikipedia.org/page-not-found", callback);
+    });
+
+    await promise1;
+    await promise2;
+});
+
+test('Test on real folder', async () => {
+    const promise = new Promise<void>((resolve) => {
+        const callback = (link: string) => {
+            expect(link).toBe('https://www.wikipedia.org/page-not-found');
+            resolve();
+        };
+
+        linkInspector("tests/test-folder", callback);
+    });
+
+    await promise;
+});

tests/test-folder/test.txt

@@ -0,0 +1,6 @@
+bowishadve https://www.google.com/ tribution pendaytive 
+astrus digikiki quz trudicats alginall shopolized 
+beatorlds reflupper https://www.wikipedia.org/page-not-found 
+nucch sa eadicerolawyne antilds ij nessinfulleter 
+expercity larv posion vikins revotempution norted 
+https://www.un.org/ sweeds corehooker iwoppion burgination