Merge #6

chore: slim down npm package; test: introduce tests to package

.gitignore

@@ -1,3 +1,5 @@
 
 node_modules/
 dist/
+test/
+coverage/

.npmignore

@@ -1,2 +1,11 @@
 
 node_modules/
+.github/
+src/
+coverage/
+.prettierignore
+README.md
+eslint.config.js
+prettier.config.js
+vitest.config.js
+tsconfig.json

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hono-file-router",
-	"version": "0.0.4",
+	"version": "0.0.5",
 	"description": "File-based router for easier route management for hono.",
 	"main": "./dist/index.cjs",
 	"module": "./dist/index.mjs",
@@ -19,7 +19,8 @@
 	"scripts": {
 		"dev": "pkgroll --watch",
 		"build": "pkgroll",
-		"test": "echo \"no test for now\""
+		"test": "vitest run",
+		"test:watch": "vitest"
 	},
 	"keywords": [
 		"hono",
@@ -34,6 +35,7 @@
 	},
 	"devDependencies": {
 		"@types/node": "^22.7.5",
+		"@vitest/coverage-istanbul": "^2.1.2",
 		"eslint": "^9.12.0",
 		"eslint-config-prettier": "^9.1.0",
 		"globals": "^15.11.0",

src/filerouterscanner.test.ts

@@ -0,0 +1,29 @@
+import { describe, it, expectTypeOf, expect } from 'vitest';
+
+import { getCwd, cleanupPath, directoryScanner, fileExists } from './filerouterscanner';
+
+describe('file router scanner', () => {
+	it('test cwd', () => {
+		const directory = getCwd();
+
+		expectTypeOf(directory).toMatchTypeOf('pathstring');
+	});
+
+	it('test cleanup path', () => {
+		expect(cleanupPath('/./')).toBe('/');
+		expect(cleanupPath('\\')).toBe('/');
+	});
+
+	it('scans directories', () => {
+		const listOfFiles = directoryScanner('./src');
+		const filtered = listOfFiles.filter((file) => file.name === 'filerouterscanner.ts');
+		expect(filtered[0].name).toBe('filerouterscanner.ts');
+	});
+
+	it('checks for existing file', () => {
+		expect(fileExists('./src/filerouterscanner.ts')).toBe(true);
+		expect(fileExists('./src/thisfiledoesnotexistandwillneverbe')).toBe(false);
+	});
+
+	it.todo('test filerouterscanner');
+});

src/filerouterscanner.ts

@@ -8,9 +8,7 @@ type httpMethodTypes = { [K in (typeof httpMethods)[number]]?: RouteInfo };
 export type RouteInfo = { file: string; route: string; method: (typeof httpMethods)[number] };
 
 export function fileRouterScanner(cwd: string, initpath: string) {
-	const folders = fs.readdirSync(`${cwd}/${initpath}`, { recursive: true, withFileTypes: true });
-
-	const normalFolders = folders.map((folders) => ({ name: folders.name, path: cleanupPath(folders.parentPath), directory: folders.isDirectory() }));
+	const normalFolders = directoryScanner(`${cwd}/${initpath}`);
 
 	const resolvedPath = cleanupPath(path.resolve(initpath));
 	normalFolders.push({ name: '.', path: resolvedPath, directory: true });
@@ -25,8 +23,8 @@ export function fileRouterScanner(cwd: string, initpath: string) {
 
 		httpMethods.forEach((methodOrIndex) => {
 			const pathToFile = `${folder.path}/${folder.name}/${methodOrIndex}`;
-			const jsExists = fs.existsSync(`${pathToFile}.js`);
-			const tsExists = fs.existsSync(`${pathToFile}.ts`);
+			const jsExists = fileExists(`${pathToFile}.js`);
+			const tsExists = fileExists(`${pathToFile}.ts`);
 
 			if (jsExists && tsExists) errors.push({ message: 'Both js and ts files exist for that method. Only one must exist.', data: pathToFile });
 
@@ -46,10 +44,6 @@ export function fileRouterScanner(cwd: string, initpath: string) {
 		routes.push(methodAssignment);
 	});
 
-	function cleanupPath(path: string) {
-		return path.replaceAll('/./', '/').replaceAll('\\', '/');
-	}
-
 	function replaceParams(path: string) {
 		return path.replace(/\[([^\]]+)\]/g, ':$1');
 	}
@@ -59,6 +53,19 @@ export function fileRouterScanner(cwd: string, initpath: string) {
 	return routes;
 }
 
+export function fileExists(file: string) {
+	return fs.existsSync(file);
+}
+
+export function directoryScanner(path: string) {
+	const folders = fs.readdirSync(path, { recursive: true, withFileTypes: true });
+	return folders.map((folders) => ({ name: folders.name, path: cleanupPath(folders.parentPath), directory: folders.isDirectory() }));
+}
+
+export function cleanupPath(path: string) {
+	return path.replaceAll('/./', '/').replaceAll('\\', '/');
+}
+
 export function getCwd() {
 	return process.cwd();
 }

src/routegenerator.test.ts

@@ -0,0 +1,12 @@
+import { describe, it, expect } from 'vitest';
+
+import { createHandler } from './routegenerator';
+
+describe('route generator', () => {
+	it('test route generator', () => {
+		const PROMISE = createHandler((context) => {
+			return context.json({ hello: 'world' });
+		});
+		expect(Array.isArray(PROMISE)).toBe(true);
+	});
+});

vitest.config.js

@@ -0,0 +1,11 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+	test: {
+		coverage: {
+			provider: 'istanbul',
+			include: ['./src/**/*'],
+			enabled: true,
+		},
+	},
+});