convert sitemap to ts

Author: andrepg

src/sitemap/SitemapGenerator.js

@@ -0,0 +1,55 @@
+import xml from 'xml';
+import type { Post } from '../data/Posts';
+
+export interface SitemapItem {
+  url: [
+    { loc: string },
+    { lastmod: string | number },
+    { changefreq: string },
+    { priority: number }
+  ];
+}
+
+export class SitemapGenerator {
+  private xmlAttribute = {
+    _attr: {
+      xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9',
+    },
+  };
+
+  private encoding = '<?xml version="1.0" encoding="UTF-8" ?>';
+
+  private host: string;
+
+  constructor({ host }: { host: string }) {
+    this.host = host;
+  }
+
+  private generateSitemapItem(page: Post): SitemapItem {
+    const lastmod = page.published_at 
+      ? (typeof page.published_at === 'string' ? page.published_at : new Date(page.published_at).toISOString())
+      : new Date().toISOString();
+
+    return {
+      url: [
+        { loc: this.host + page.path },
+        { lastmod },
+        { changefreq: 'monthly' },
+        { priority: 0.5 },
+      ],
+    };
+  }
+
+  private generateUrlSet(pages: Post[]) {
+    const items = pages.map((page) => this.generateSitemapItem(page));
+    return [this.xmlAttribute, ...items];
+  }
+
+  public generateSitemap(pages: Post[]): string {
+    const sitemap = {
+      urlset: this.generateUrlSet(pages),
+    };
+
+    return this.encoding + xml(sitemap);
+  }
+}

src/sitemap/SitemapGenerator.ts

@@ -0,0 +1,76 @@
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { lstatSync, readdirSync, readFileSync, writeFileSync } from 'fs';
+import FrontMatter from 'front-matter';
+
+import { SitemapGenerator } from './SitemapGenerator';
+import type { Post } from '../data/Posts';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const blogRoot = path.join(__dirname, '../../blog/');
+const sitemapXmlPath = path.join(__dirname, '../../public/sitemap.xml');
+const sitemapJsonPath = path.join(__dirname, '../../public/sitemap.json');
+
+const sitemap: Post[] = [];
+
+function isArticle(filePath: string): boolean {
+  return (
+    lstatSync(path.join(blogRoot, filePath)).isFile() &&
+    !filePath.toString().includes('.json')
+  );
+}
+
+function getArticlesList(): string[] {
+  return readdirSync(blogRoot, { recursive: true }).filter((item) =>
+    isArticle(item as string)
+  ) as string[];
+}
+
+function generateSitemapXml(posts: Post[]): string {
+  return new SitemapGenerator({
+    host: 'https://andrepg.github.io/',
+  }).generateSitemap(posts);
+}
+
+function report(message: string): void {
+  console.log(message);
+}
+
+function addArticleToSitemap(item: string): void {
+  const content = readFileSync(path.join(blogRoot, item), 'utf8').toString();
+  const fm = FrontMatter<Post>(content);
+
+  sitemap.push({
+    path: item.replace('.md', ''),
+    ...fm.attributes,
+  });
+
+  report(`\tFile processed -> ${item}`);
+}
+
+function main(): void {
+  report(`Building blog sitemap for ${blogRoot}`);
+  const articleList = getArticlesList();
+
+  report(
+    `\t${articleList.length} articles found.\nCollecting front-matter properties.`
+  );
+  articleList.forEach(addArticleToSitemap);
+
+  report('Generating JSON sitemap');
+  writeFileSync(sitemapJsonPath, JSON.stringify(sitemap, null, 2), {
+    encoding: 'utf-8',
+  });
+
+  report('Generating XML sitemap');
+  const xmlContent = generateSitemapXml(sitemap);
+  writeFileSync(sitemapXmlPath, xmlContent, { encoding: 'utf-8' });
+
+  report(`Sitemap file generated at ${sitemapXmlPath} and ${sitemapJsonPath}`);
+}
+
+console.time('sitemap-build');
+main();
+console.timeEnd('sitemap-build');