@sphido/sitemap 1.1.0 → 2.0.2

package/LICENSE.md

@@ -1,7 +1,7 @@
 MIT License
 -----------
 
-Copyright (c) 2021 Roman Ožana (https://ozana.cz/)
+Copyright (c) 2022 Roman Ožana (https://ozana.cz/)
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without

package/lib/sitemap.js

@@ -1,12 +1,36 @@
+import {createWriteStream, existsSync} from 'node:fs';
+import {mkdir, unlink} from 'node:fs/promises';
+import {dirname} from 'node:path';
+
 /**
- * Generate sitemap XML from posts
- * @param {array} pages
- * @param {string} domain
- * @returns {string}
+ * Generate XML sitemap
+ * @param {string} file
+ * @returns {Object<{add: add, end: end}>}
  */
-export function sitemap(pages, domain) {
-	return '<?xml version="1.0" encoding="UTF-8"?>\n<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n'
-		+ `<url><loc>${domain}</loc><lastmod>${new Date().toISOString()}</lastmod><priority>1.0</priority></url>\n`
-		+ pages.map(post => `<url><loc>${typeof post.link === 'function' ? post.link(domain) : post.link}</loc><lastmod>${post.date.toISOString()}</lastmod><priority>0.80</priority></url>\n`).join('')
-		+ '</urlset>';
+export async function createSitemap(file = 'public/sitemap.xml') {
+	// Create directory
+	if (!existsSync(dirname(file))) {
+		await mkdir(dirname(file), {recursive: true});
+	}
+
+	// Truncate file
+	if (existsSync(file)) {
+		await unlink(file);
+	}
+
+	// Create stream
+	const sitemap = createWriteStream(file, {flags: 'a'});
+	sitemap.write('<?xml version="1.0" encoding="UTF-8"?>\n<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n');
+
+	return {
+
+		add(url, lastmod = new Date(), priority = 0.8) {
+			sitemap.write(`\t<url><loc>${url}</loc><lastmod>${lastmod.toISOString()}</lastmod><priority>${priority}</priority></url>\r\n`);
+		},
+
+		end() {
+			sitemap.write('</urlset>');
+			sitemap.end();
+		},
+	};
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sphido/sitemap",
-	"version": "1.1.0",
+	"version": "2.0.2",
 	"author": {
 		"name": "Roman Ožana",
 		"email": "roman@ozana.cz",
@@ -14,11 +14,11 @@
 	"description": "Sitemap XML for Sphido CMS",
 	"license": "MIT",
 	"devDependencies": {
-		"ava": "^4.2.0",
-		"fs-extra": "^10.0.1"
+		"@sindresorhus/slugify": "^2.1.0",
+		"ava": "^4.2.0"
 	},
 	"scripts": {
 		"test": "ava"
 	},
-	"gitHead": "06fc68158f4f3d76c8f3f6e9f3d411c635913a91"
+	"gitHead": "df860e9742cc0228338438748f62ea9733ff0872"
 }

package/readme.md

@@ -9,26 +9,34 @@ yarn add @sphido/sitemap
 ## Example
 
 ```javascript
-import fs from 'fs-extra';
-import path from 'path';
-import {fileURLToPath} from 'url';
-import {sitemap} from '@sphido/sitemap';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-const posts = [
-	{link: 'https://example.com/first', date: new Date()},
-	{link: 'https://example.com/second', date: new Date()},
-];
-
-(async () => {
-	await fs.outputFile(
-		__dirname  + '/sitemap.xml',
-		sitemap(posts, 'https://example.com')
-	);
-})();
+#!/usr/bin/env node
+
+import {dirname, relative, join} from 'node:path';
+import {getPages, allPages} from '@sphido/core';
+import slugify from '@sindresorhus/slugify';
+import {createSitemap} from '../lib/sitemap.js';
+
+const pages = await getPages({path: 'content'});
+const map = await createSitemap('sitemap.xml');
+
+map.add('https://sphido.org', new Date(), 1);
+
+for (const page of await allPages(pages)) {
+	page.slug = join('/', relative('content', dirname(page.path)), slugify(page.name) + '.html');
+	map.add('https://sphido.org' + page.slug, new Date());
+}
+
+map.end();
 ```
 
 ## Source codes
 
-https://github.com/sphido/sphido/tree/main/packages/sphido-sitemap
+https://github.com/sphido/sphido/tree/main/packages/sphido-sitemap
+
+## TODO
+
+Ping Google about changes:
+
+```text
+https://www.google.com/webmasters/tools/ping?sitemap=https://www.mydomain.com/sitemap.xml
+```