Add sitemap generation and remove extra files

scripts/path-map.js

@@ -0,0 +1,87 @@
+const path = require('path');
+const glob = require('glob');
+
+const guides = require('../storage/guides.json');
+const roadmaps = require('../storage/roadmaps');
+
+const PAGES_PATH = path.join(__dirname, '../pages');
+
+/**
+ * Generate the page routes from the page files inside `/pages`
+ * directory. Gives the format understood by next
+ * {
+ *   '/slug': { page: '/path/to-file' }
+ * }
+ */
+const getPageRoutes = () => {
+  const files = glob.sync(`${PAGES_PATH}/**/*.js`, {
+    ignore: [
+      '**/_*.js',        // private non-page files e.g. _document.js
+      '**/[[]*[]].js',   // Ignore dynamic pages i.e. `page/[something].js` files
+      '**/[[]*[]]/*.js', // Ignore files inside dynamic pages i.e. `[something]/abc.js`
+    ]
+  });
+
+  const pageRoutes = {};
+  files.forEach(file => {
+    const pageName = file.replace(PAGES_PATH, '').replace('.js', '');
+    const pagePath = pageName.replace('/index', '') || '/';
+
+    pageRoutes[pagePath] = { page: `${pageName}` }
+  });
+
+  return pageRoutes;
+};
+
+/**
+ * Generates routes for guide pages
+ * @returns {*}
+ */
+const getGuideRoutes = () => {
+  return guides.reduce((acc, guide) => {
+    const [, , slug] = guide.url.split('/');
+    return {
+      ...acc,
+      [guide.url]: {
+        page: '/guides/[guide]',
+        query: slug,
+      }
+    };
+  }, {});
+};
+
+/**
+ * Generates routes for each of the roadmap and it's respective versions
+ * @returns {*}
+ */
+const getRoadmapRoutes = () => {
+  return roadmaps.reduce((roadmapRoutes, roadmap) => {
+    const [, slug] = roadmap.url.split('/');
+
+    return {
+      ...roadmapRoutes,
+      // Default roadmap path i.e. `{ '/frontend': { page: '/[roadmap]/index', query: 'frontend' }`
+      [roadmap.url]: {
+        page: '/[roadmap]',
+        query: slug
+      },
+      // Route for each of the versions of this roadmap i.e.
+      // `{ '/frontend/2019': { page: '/[roadmap]/[version]', query: 'frontend/2019' } }`
+      ...((roadmap.versions || []).reduce((versionRoutes, version) => {
+        return {
+          ...versionRoutes,
+          [`${roadmap.url}/${version}`]: {
+            page: '/[roadmap]/[version]',
+            query: `${slug}/${version}`
+          }
+        };
+      }, {})),
+    };
+  }, {});
+};
+
+module.exports = {
+  getPageRoutes,
+  getGuideRoutes,
+  getRoadmapRoutes,
+};

scripts/sitemap.js

@@ -0,0 +1,126 @@
+// This is a development script executed in the build step of pages
+const fs = require('fs');
+const path = require('path');
+const guides = require('../storage/guides');
+const { getPageRoutes, getGuideRoutes, getRoadmapRoutes } = require('./path-map');
+
+const DOMAIN = 'https://roadmap.sh';
+const PAGES_DIR = path.join(__dirname, '../pages');
+const STORAGE_PATH = path.join(__dirname, '../storage');
+const SITEMAP_PATH = 'static/sitemap.xml';
+const STATIC_PATH = path.join(__dirname, '../static');
+
+// Set the header
+const xmlHeader = `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">`;
+
+// Wrap all pages in <urlset> tags
+const xmlUrlWrapper = nodes => `${xmlHeader}
+${nodes}
+</urlset>`;
+
+const getSlugPriority = (pageSlug) => {
+  if (pageSlug === '/') {
+    return '1.0';
+  }
+
+  const slugPriorities = [
+    ['/roadmaps', '/guides'],      // 1.0
+    ['/signup'],                   // 0.9
+    ['/about'],                    // 0.8
+  ];
+
+  const foundIndex = slugPriorities.findIndex(
+    routes => routes.some(route => pageSlug.startsWith(route))
+  );
+
+  if (foundIndex !== -1) {
+    return parseFloat((10 - foundIndex) / 10)
+      .toFixed(1);
+  }
+
+  return 0.5;
+};
+
+function generateNode({
+  slug,
+  basePath,
+  fileName,
+  priority = null,
+  date = null,
+  frequency = 'monthly'
+}) {
+  const pagePath = path.join(basePath, fileName);
+  let pageStats = {};
+  try {
+    pageStats = fs.lstatSync(pagePath);
+  } catch(e) {
+    console.log(`File not found: ${pagePath}`);
+    pageStats = { mtime: (new Date()) }
+  }
+
+  return `<url>
+              <loc>${DOMAIN}${slug}</loc>
+              <changefreq>${ frequency }</changefreq>
+              <lastmod>${date || pageStats.mtime.toISOString()}</lastmod>
+              <priority>${ priority || getSlugPriority(slug) }</priority>
+          </url>`;
+}
+
+function generateSiteMap() {
+  const pageRoutes = getPageRoutes();
+  const pageSlugs = Object.keys(pageRoutes)
+    .filter(route => ![
+      '/privacy',
+      '/terms'
+    ].includes(route));
+
+  const pagesChunk = pageSlugs.map(pageSlug => {
+    return generateNode({
+      basePath: PAGES_DIR,
+      fileName: `${pageRoutes[pageSlug].page}.js`,
+      slug: pageSlug,
+    });
+  });
+
+  // Chunks for each of the guides
+  const guideRoutes = getGuideRoutes();
+  const guideSlugs  = Object.keys(guideRoutes);
+  const guidesChunk = guideSlugs.map(guideSlug => {
+    const foundGuide = guides.find(guide => guide.url === guideSlug) || {};
+    return generateNode({
+      basePath: STORAGE_PATH,
+      fileName: `${guideSlug}.md`,
+      slug: guideSlug,
+      date: foundGuide.updatedAt,
+      priority: '1.0',
+    });
+  });
+
+  // Chunks for each of the roadmaps
+  const roadmapRoutes = getRoadmapRoutes();
+  const roadmapSlugs = Object.keys(roadmapRoutes);
+  const roadmapsChunk = roadmapSlugs.map(roadmapSlug => {
+    const [, role, year = 'latest'] = roadmapSlug.split('/');
+    return generateNode({
+      basePath: STATIC_PATH,
+      fileName: `/roadmaps/${year}/${role}.png`,
+      slug: roadmapSlug,
+      priority: '1.0',
+    });
+  });
+
+  const nodes = [
+    ...roadmapsChunk,
+    ...guidesChunk,
+    ...pagesChunk,
+  ];
+
+  const sitemap = `${xmlUrlWrapper(nodes.join('\n'))}`;
+
+  fs.writeFileSync(SITEMAP_PATH, sitemap);
+
+  console.log(`sitemap.xml with ${nodes.length} entries was written to ${SITEMAP_PATH}`);
+}
+
+generateSiteMap();