refactor(v2): Convert sitemap plugin to TypeScript (#1894)

* Convert sitemap plugin to TypeScript

Test - enabled the sitemap plugin in the v2 website and verified that
the sitemap is created after running `docusaurus build`.

* Addressing review comments

.eslintignore

@@ -16,3 +16,4 @@ packages/docusaurus-init/lib/
 packages/docusaurus-plugin-content-blog/lib/
 packages/docusaurus-plugin-content-docs/lib/
 packages/docusaurus-plugin-content-pages/lib/
+packages/docusaurus-plugin-sitemap/lib/

.gitignore

@@ -18,3 +18,4 @@ packages/docusaurus-init/lib/
 packages/docusaurus-plugin-content-blog/lib/
 packages/docusaurus-plugin-content-docs/lib/
 packages/docusaurus-plugin-content-pages/lib/
+packages/docusaurus-plugin-sitemap/lib/

.prettierignore

@@ -8,3 +8,4 @@ packages/docusaurus-init/lib/
 packages/docusaurus-plugin-content-blog/lib/
 packages/docusaurus-plugin-content-docs/lib/
 packages/docusaurus-plugin-content-pages/lib/
+packages/docusaurus-plugin-sitemap/lib/

CHANGELOG-2.x.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Convert sitemap plugin to TypeScript
+
 ## 2.0.0-alpha.31
 
 - Footer is now sticky/ pinned to the bottom of the viewport in desktop browsers. 

packages/docusaurus-plugin-sitemap/package.json

@@ -2,12 +2,16 @@
   "name": "@docusaurus/plugin-sitemap",
   "version": "2.0.0-alpha.31",
   "description": "Simple sitemap generation plugin for Docusaurus",
-  "main": "src/index.js",
+  "main": "lib/index.js",
+  "scripts": {
+    "tsc": "tsc"
+  },
   "publishConfig": {
     "access": "public"
   },
   "license": "MIT",
   "dependencies": {
+    "@docusaurus/types": "^2.0.0-alpha.30",
     "sitemap": "^3.2.2"
   },
   "peerDependencies": {

packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts

@@ -6,23 +6,30 @@
  */
 
 import createSitemap from '../createSitemap';
+import {DocusaurusConfig} from '@docusaurus/types';
+import DEFAULT_OPTIONS from '../index';
 
 describe('createSitemap', () => {
   test('simple site', () => {
-    const sitemap = createSitemap({
-      siteConfig: {
+    const sitemap = createSitemap(
+      {
         url: 'https://example.com',
+      } as DocusaurusConfig,
+      ['/', '/test'],
+      {
+        cacheTime: 600,
+        changefreq: 'daily',
+        priority: 0.7,
       },
-      routesPaths: ['/', '/test'],
-    });
-    expect(sitemap).toContain(
+    );
+    expect(sitemap.toString()).toContain(
       `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1">`,
     );
   });
 
   test('empty site', () => {
     expect(() => {
-      createSitemap({});
+      createSitemap({} as any, [], {} as any);
     }).toThrowErrorMatchingInlineSnapshot(
       `"Url in docusaurus.config.js cannot be empty/undefined"`,
     );

packages/docusaurus-plugin-sitemap/src/createSitemap.js

@@ -1,33 +0,0 @@
-/**
- * Copyright (c) 2017-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-const sitemap = require('sitemap');
-
-module.exports = function createSitemap({
-  siteConfig = {},
-  routesPaths,
-  options = {},
-}) {
-  const {url: hostname} = siteConfig;
-  if (!hostname) {
-    throw new Error('Url in docusaurus.config.js cannot be empty/undefined');
-  }
-
-  const urls = routesPaths.map(routesPath => ({
-    url: routesPath,
-    changefreq: options.changefreq,
-    priority: options.priority,
-  }));
-
-  return sitemap
-    .createSitemap({
-      hostname,
-      cacheTime: options.cacheTime,
-      urls,
-    })
-    .toString();
-};

packages/docusaurus-plugin-sitemap/src/createSitemap.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) 2017-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import sitemap, {SitemapItemOptions} from 'sitemap';
+import {PluginOptions} from './types';
+import {DocusaurusConfig} from '@docusaurus/types';
+
+export default function createSitemap(
+  siteConfig: DocusaurusConfig,
+  routesPaths: string[],
+  options: PluginOptions,
+) {
+  const {url: hostname} = siteConfig;
+  if (!hostname) {
+    throw new Error('Url in docusaurus.config.js cannot be empty/undefined');
+  }
+
+  const urls = routesPaths.map(
+    routesPath =>
+      ({
+        url: routesPath,
+        changefreq: options.changefreq,
+        priority: options.priority,
+      } as SitemapItemOptions),
+  );
+
+  return sitemap.createSitemap({
+    hostname,
+    cacheTime: options.cacheTime,
+    urls,
+  });
+}

packages/docusaurus-plugin-sitemap/src/index.ts

@@ -5,30 +5,34 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const fs = require('fs');
-const path = require('path');
+import fs from 'fs';
+import path from 'path';
+import {PluginOptions} from './types';
+import createSitemap from './createSitemap';
+import {LoadContext, Props} from '@docusaurus/types';
 
-const createSitemap = require('./createSitemap');
-
-const DEFAULT_OPTIONS = {
+const DEFAULT_OPTIONS: PluginOptions = {
   cacheTime: 600 * 1000, // 600 sec - cache purge period
   changefreq: 'weekly',
   priority: 0.5,
 };
 
-module.exports = function(context, opts) {
+export default function pluginSitemap(
+  _context: LoadContext,
+  opts: Partial<PluginOptions>,
+) {
   const options = {...DEFAULT_OPTIONS, ...opts};
 
   return {
     name: 'docusaurus-plugin-sitemap',
 
-    async postBuild({siteConfig = {}, routesPaths = [], outDir}) {
+    async postBuild({siteConfig, routesPaths, outDir}: Props) {
       // Generate sitemap
-      const generatedSitemap = createSitemap({
+      const generatedSitemap = createSitemap(
         siteConfig,
         routesPaths,
         options,
-      }).toString();
+      ).toString();
 
       // Write sitemap file
       const sitemapPath = path.join(outDir, 'sitemap.xml');
@@ -39,4 +43,4 @@ module.exports = function(context, opts) {
       });
     },
   };
-};
+}

packages/docusaurus-plugin-sitemap/src/types.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) 2017-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export interface PluginOptions {
+  cacheTime: number;
+  changefreq: string;
+  priority: number;
+}

packages/docusaurus-plugin-sitemap/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "incremental": true,
+    "tsBuildInfoFile": "./lib/.tsbuildinfo",
+    "rootDir": "src",
+    "outDir": "lib"
+  }
+}