Merge pull request #166 from jaredwray/adding-in-testing-for-mega-site

mega site update

Author: jaredwray

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docula",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Beautiful Website for Your Projects",
   "type": "module",
   "exports": "./dist/index.js",
@@ -31,6 +31,7 @@
     "clean": "rimraf ./dist ./coverage ./node_modules ./package-lock.json ./yarn.lock ./pnpm-lock.yaml ./site/README.md ./site-output",
     "build": "rimraf ./dist && tsc",
     "build-site": "rimraf ./site/README.md && node bin/docula.mjs build -s ./site -o ./site-output",
+    "serve-mega": "rimraf ./test/fixtures/mega-page-site/site-output && node bin/docula.mjs serve -s ./test/fixtures/mega-page-site",
     "test": "xo --fix && vitest run --coverage",
     "serve": "rimraf ./site/README.md && node bin/docula.mjs serve -s ./site -o ./site-output",
     "prepare": "npm run build"

src/builder.ts

@@ -257,6 +257,16 @@ export class DoculaBuilder {
 		const sitemapPath = `${data.outputPath}/sitemap.xml`;
 		const urls = [{url: data.siteUrl}, {url: `${data.siteUrl}/releases`}];
 
+		// Add all the document urls
+		for (const document of data.documents ?? []) {
+			let {urlPath} = document;
+			if (urlPath.endsWith('index.html')) {
+				urlPath = urlPath.slice(0, -10);
+			}
+
+			urls.push({url: `${data.siteUrl}${urlPath}`});
+		}
+
 		let xml = '<?xml version="1.0" encoding="UTF-8"?>';
 		xml += '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">';
 
@@ -488,8 +498,15 @@ export class DoculaBuilder {
 		const matterData = matter.default(documentContent);
 		const markdownContent = this.removeFrontmatter(documentContent);
 		const documentsFolderIndex = documentPath.lastIndexOf('/docs/');
-		const urlPath = documentPath.slice(documentsFolderIndex).replace('.md', '.html');
-		const isRoot = urlPath.split('/').length === 3;
+		let urlPath = documentPath.slice(documentsFolderIndex).replace('.md', '/index.html');
+		let isRoot = urlPath.split('/').length === 3;
+		if (!documentPath.slice(documentsFolderIndex + 6).includes('/')) {
+			isRoot = true;
+			const filePath = documentPath.slice(documentsFolderIndex + 6);
+			if (filePath === 'index.md') {
+				urlPath = documentPath.slice(documentsFolderIndex).replace('.md', '.html');
+			}
+		}
 
 		return {
 			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment

test/builder.test.ts

@@ -413,7 +413,7 @@ describe('DoculaBuilder', () => {
 			const builder = new DoculaBuilder();
 			const documentsPath = 'test/fixtures/mega-page-site/docs';
 			const documents = builder.getDocumentInDirectory(documentsPath);
-			expect(documents.length).toBe(2);
+			expect(documents.length).toBe(3);
 		});
 		it('should get all the documents from the mega fixtures', () => {
 			const builder = new DoculaBuilder();
@@ -427,7 +427,7 @@ describe('DoculaBuilder', () => {
 			};
 			const documentsPath = 'test/fixtures/mega-page-site/docs';
 			const documents = builder.getDocuments(documentsPath, doculaData);
-			expect(documents.length).toBe(20);
+			expect(documents.length).toBe(21);
 		});
 	});
 

test/fixtures/mega-page-site/docs/caching/caching-express.md

@@ -1,9 +1,10 @@
 ---
-title: 'Utilizing Keyv for Caching in Express: A Step-by-Step Guide'
-navTitle: 'Caching with Express'
+title: 'How to Implement Caching with Express'
+sidebarTitle: 'Caching with Express'
+parent: 'Caching'
 ---
 
-# Utilizing Keyv for Caching in Express: A Step-by-Step Guide
+# How to Implement Caching with Express
 
 ## What is Express?
 Express is a minimal Node.js web application framework. Its APIs provide web and mobile application functionality. Its simplicity enables users to quickly create a robust API in a familiar environment with enhanced features, including Robust routing, high performance, HTTP helpers, support for 14+ view template engines, content negotiation, and an executable for generating applications quickly.

test/fixtures/mega-page-site/docs/caching/caching-fastify.md

@@ -1,10 +1,10 @@
 ---
-title: 'Utilizing Keyv for Caching in Fastify: A Step-by-Step Guide'
-navTitle: 'Caching with Fastify'
-section: 'caching'
+title: 'How to Implement Caching with Fastify'
+sidebarTitle: 'Caching with Fastify'
+parent: 'Caching'
 ---
 
-# Utilizing Keyv for Caching in Fastify: A Step-by-Step Guide
+# How to Implement Caching with Fastify
 
 ## What is Fastify?
 Fastify is a web framework that provides a powerful plugin-based developer experience (inspired by Hapi and Express) with minimal overhead and is one of the fastest frameworks available, serving up to 30k requests per second. It is fully extensible via hooks, plugins, and decorators. Being schema-based, Fastify compiles schemas very efficiently. A TypeScript type declaration file is also maintained to support the growing TypeScript community.

test/fixtures/mega-page-site/docs/caching/caching-javascript.md

@@ -1,9 +1,10 @@
 ---
-title: 'Utilizing Keyv for Caching in Javascript: A Step-by-Step Guide'
-navTitle: 'Caching in Javascript'
+title: 'How to Implement Caching in Javascript'
+sidebarTitle: 'Caching in Javascript'
+parent: 'Caching'
 ---
 
-# Utilizing Keyv for Caching in Javascript: A Step-by-Step Guide
+# How to Implement Caching in Javascript
 
 ## What is a Cache?
 A cache is a short-term, high-speed data storage layer that stores a subset of data, enabling it to be retrieved faster than accessing it from its primary storage location. Caching allows you to reuse previously retrieved data efficiently.

test/fixtures/mega-page-site/docs/caching/caching-koa.md

@@ -1,9 +1,10 @@
 ---
-title: 'Utilizing Keyv for Caching in Koa: A Step-by-Step Guide'
-navTitle: 'Caching with Koa'
+title: 'How to Implement Caching with Koa'
+sidebarTitle: 'Caching with Koa'
+parent: 'Caching'
 ---
 
-# Utilizing Keyv for Caching in Koa: A Step-by-Step Guide
+# How to Implement Caching with Koa
 
 ## What is Koa?
 Koa is a web framework from the team behind Express that offers a smaller, more expressive, more robust foundation for APIs and web applications. Koa's use of async functions removes the need for callbacks and increases error handling. A Koa Context combines a node request and response object into a single object providing numerous helpful methods for writing APIs and web apps.

test/fixtures/mega-page-site/docs/caching/caching-nestjs.md

@@ -1,6 +1,7 @@
 ---
 title: 'Utilizing Keyv for Caching in NestJS: A Step-by-Step Guide'
-navTitle: 'Caching in Nest.js'
+sidebarTitle: 'Caching in Nest.js'
+parent: 'Caching'
 ---
 
 # Utilizing Keyv for Caching in NestJS: A Step-by-Step Guide

test/fixtures/mega-page-site/docs/caching/caching-node.md

@@ -1,6 +1,7 @@
 ---
 title: 'Utilizing Keyv for Caching in Node.js: A Step-by-Step Guide'
-navTitle: 'Caching in Node.js'
+sidebarTitle: 'Caching in Node.js'
+parent: 'Caching'
 ---
 
 # Utilizing Keyv for Caching in Node.js: A Step-by-Step Guide

test/fixtures/mega-page-site/docs/compression/compress-brotli.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/compress-brotli'
+sidebarTitle: '@keyv/compress-brotli'
+parent: 'Compression'
 ---
 
 # @keyv/compress-brotli 

test/fixtures/mega-page-site/docs/compression/compress-gzip.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/compress-gzip'
+sidebarTitle: '@keyv/compress-gzip'
+parent: 'Compression'
 ---
 
 # @keyv/compress-gzip 

test/fixtures/mega-page-site/docs/index.md

@@ -1,6 +1,6 @@
 ---
 title: 'Getting Started Guide'
-order: 0
+order: 1
 ---
 
 # Getting Started Guide

test/fixtures/mega-page-site/docs/keyv.md

@@ -1,8 +1,10 @@
 ---
 title: 'Keyv API'
-order: 1
+order: 2
 ---
 
+
+
 > Simple key-value storage with support for multiple backends
 
 [![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)

test/fixtures/mega-page-site/docs/storage-adapters/etcd.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/etcd'
+sidebarTitle: '@keyv/etcd'
+parent: 'Storage Adapters'
 ---
 
 # @keyv/etcd 

test/fixtures/mega-page-site/docs/storage-adapters/memcache.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/memcache'
+sidebarTitle: '@keyv/memcache'
+parent: 'Storage Adapters'
 ---
 
 # @keyv/memcache 

test/fixtures/mega-page-site/docs/storage-adapters/mongo.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/mongo'
+sidebarTitle: '@keyv/mongo'
+parent: 'Storage Adapters'
 ---
 
 # @keyv/mongo 

test/fixtures/mega-page-site/docs/storage-adapters/mysql.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/mysql'
+sidebarTitle: '@keyv/mysql'
+parent: 'Storage Adapters'
 ---
 
 # @keyv/mysql 

test/fixtures/mega-page-site/docs/storage-adapters/offline.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/offline'
+sidebarTitle: '@keyv/offline'
+parent: 'Storage Adapters'
 ---
 
 # @keyv/offline 

test/fixtures/mega-page-site/docs/storage-adapters/postgres.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/postgres'
+sidebarTitle: '@keyv/postgres'
+parent: 'Storage Adapters'
 ---
 
 # @keyv/postgres 

test/fixtures/mega-page-site/docs/storage-adapters/redis.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/redis'
+sidebarTitle: '@keyv/redis'
+parent: 'Storage Adapters'
 ---
 
 # @keyv/redis 

test/fixtures/mega-page-site/docs/storage-adapters/serialize.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/serialize'
+sidebarTitle: '@keyv/serialize'
+parent: 'Storage Adapters'
 ---
 
 # @keyv/serialize 

test/fixtures/mega-page-site/docs/storage-adapters/sqlite.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/sqlite'
+sidebarTitle: '@keyv/sqlite'
+parent: 'Storage Adapters'
 ---
 
 # @keyv/sqlite 

test/fixtures/mega-page-site/docs/storage-adapters/tiered.md

@@ -1,5 +1,7 @@
 ---
 title: '@keyv/tiered'
+sidebarTitle: '@keyv/tiered'
+parent: 'Storage Adapters'
 ---
 
 # @keyv/tiered 

test/fixtures/mega-page-site/docs/test-suite.md

@@ -0,0 +1,70 @@
+---
+title: 'Test Suite'
+permalink: /docs/test-suite/
+order: 6
+---
+
+# @keyv/test-suite 
+
+> Test suite for Keyv API compliance
+
+[![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/main/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
+[![npm](https://img.shields.io/npm/v/@keyv/test-suite.svg)](https://www.npmjs.com/package/@keyv/test-suite)
+[![npm](https://img.shields.io/npm/dm/@keyv/test-suite)](https://npmjs.com/package/@keyv/test-suite)
+
+Complete [AVA](https://github.com/avajs/ava) test suite to test a [Keyv](https://github.com/jaredwray/keyv) storage adapter for API compliance.
+
+## Usage
+
+### Install
+
+Install AVA, Keyv and `@keyv/test-suite` as development dependencies.
+
+```shell
+npm install --save-dev ava keyv @keyv/test-suite
+```
+
+Then update `keyv` and `@keyv/test-suite` versions to `*` in `package.json` to ensure you're always testing against the latest version.
+
+### Create Test File
+
+`test.js`
+
+```js
+import test from 'ava';
+import keyvTestSuite from '@keyv/test-suite';
+import Keyv from 'keyv';
+import KeyvStore from './';
+
+const store = () => new KeyvStore();
+keyvTestSuite(test, Keyv, store);
+```
+
+Where `KeyvStore` is your storage adapter.
+
+Set your test script in `package.json` to `ava`.
+```json
+"scripts": {
+  "test": "ava"
+}
+```
+
+## Example for Storage Adapters
+
+Take a look at [keyv-redis](https://github.com/jaredwray/keyv-redis) for an example of an existing storage adapter using `@keyv/test-suite`.
+
+## Testing Compression Adapters
+
+If you're testing a compression adapter, you can use the `keyvCompresstionTests` method instead of `keyvTestSuite`.
+
+```js
+const {keyvCompresstionTests} = require('@keyv/test-suite');
+const KeyvGzip = require('@keyv/compress-gzip');
+
+keyvCompresstionTests(test, new KeyvGzip());
+```
+
+## License
+
+MIT © Jared Wray

test/fixtures/mega-page-site/docula.config.cjs

@@ -7,8 +7,8 @@ module.exports.options = {
 	siteDescription: 'Beautiful Website for Your Projects',
 	siteUrl: 'https://docula.org',
 	sections: [
-		{ name: 'Caching', path: 'caching', order: 1 },
-		{ name: 'Compression', path: 'compression', order: 2 },
+		{ name: 'Caching', path: 'caching', order: 5 },
+		{ name: 'Compression', path: 'compression', order: 4 },
 		{ name: 'Storage Adapters', path: 'storage-adapters', order: 3 },
 	],
 };