refactor: review

Author: araujogui

src/generators/sitemap/index.mjs

@@ -4,7 +4,7 @@ import { join } from 'node:path';
 import dedent from 'dedent';
 
 import { BASE_URL } from '../../constants.mjs';
-import { buildApiDocUrl } from './utils/buildApiDocUrl.mjs';
+import { createPageSitemapEntry } from './utils/createPageSitemapEntry.mjs';
 
 /**
  * This generator generates a sitemap.xml file for search engine optimization
@@ -34,14 +34,19 @@ export default {
 
     const apiPages = entries
       .filter(entry => entry.heading.depth === 1)
-      .map(entry => buildApiDocUrl(entry, lastmod));
+      .map(entry => createPageSitemapEntry(entry, lastmod));
 
-    apiPages.push({
+    /**
+     * @typedef {import('./types').SitemapEntry}
+     */
+    const mainPage = {
       loc: new URL('/docs/latest/api/', BASE_URL).href,
       lastmod,
       changefreq: 'daily',
       priority: '1.0',
-    });
+    };
+
+    apiPages.push(mainPage);
 
     const template = await readFile(
       join(import.meta.dirname, 'template.xml'),

src/generators/sitemap/types.d.ts

@@ -1,4 +1,4 @@
-export interface SitemapUrl {
+export interface SitemapEntry {
   loc: string;
   lastmod?: string;
   changefreq?:

…erators/sitemap/utils/buildApiDocUrl.mjs …sitemap/utils/createPageSitemapEntry.mjssrc/generators/sitemap/utils/buildApiDocUrl.mjs renamed to src/generators/sitemap/utils/createPageSitemapEntry.mjs src/generators/sitemap/utils/buildApiDocUrl.mjs renamed to src/generators/sitemap/utils/createPageSitemapEntry.mjs

@@ -5,9 +5,9 @@ import { buildApiDocURL } from '../../../utils/url.mjs';
  *
  * @param {ApiDocMetadataEntry} entry
  * @param {string} lastmod
- * @returns {import('../types').SitemapUrl}
+ * @returns {import('../types').SitemapEntry}
  */
-export const buildApiDocUrl = (entry, lastmod) => {
+export const createPageSitemapEntry = (entry, lastmod) => {
   const { href } = buildApiDocURL(entry, true);
 
   return { loc: href, lastmod, changefreq: 'weekly', priority: '0.8' };