Merge branch 'master' into endi/fixsearch

.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

@@ -3,7 +3,8 @@
 ## Unreleased
 
 - Slightly adjust search icon position to be more aligned on small width device.
-
+- Convert sitemap plugin to TypeScript.
+- Significantly reduce main bundle size and initial HTML payload on production build. Generated JS files from webpack is also shorter in name.
 
 ## 2.0.0-alpha.31
 

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.js → 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.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.js → 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"
+ }
+}

packages/docusaurus-types/src/index.d.ts

@@ -94,7 +94,7 @@ export interface Plugin<T> {
  getThemePath?(): string;
  getPathsToWatch?(): string[];
  getClientModules?(): string[];
- extendCli?(cli: CommanderStatic): any;
+ extendCli?(cli: CommanderStatic): void;
 }
 
 export type PluginConfig = [string, Object] | [string] | string;

packages/docusaurus-utils/src/__tests__/index.test.ts

@@ -108,6 +108,20 @@ describe('load utils', () => {
  Object.keys(secondAssert).forEach(str => {
  expect(genChunkName(str, undefined, 'blog')).toBe(secondAssert[str]);
  });
+
+ // Only generate short unique id
+ const thirdAssert = {
+ a: '0cc175b9',
+ b: '92eb5ffe',
+ c: '4a8a08f0',
+ d: '8277e091',
+ };
+ Object.keys(thirdAssert).forEach(str => {
+ expect(genChunkName(str, undefined, undefined, true)).toBe(
+ thirdAssert[str],
+ );
+ });
+ expect(genChunkName('d', undefined, undefined, true)).toBe('8277e091');
  });
 
  test('idx', () => {

packages/docusaurus-utils/src/index.ts

@@ -101,19 +101,27 @@ export function genChunkName(
  modulePath: string,
  prefix?: string,
  preferredName?: string,
+ shortId?: boolean,
 ): string {
  let chunkName: string | undefined = chunkNameCache.get(modulePath);
  if (!chunkName) {
- let str = modulePath;
- if (preferredName) {
- const shortHash = createHash('md5')
+ if (shortId) {
+ chunkName = createHash('md5')
  .update(modulePath)
  .digest('hex')
- .substr(0, 3);
- str = `${preferredName}${shortHash}`;
+ .substr(0, 8);
+ } else {
+ let str = modulePath;
+ if (preferredName) {
+ const shortHash = createHash('md5')
+ .update(modulePath)
+ .digest('hex')
+ .substr(0, 3);
+ str = `${preferredName}${shortHash}`;
+ }
+ const name = str === '/' ? 'index' : docuHash(str);
+ chunkName = prefix ? `${prefix}---${name}` : name;
  }
- const name = str === '/' ? 'index' : docuHash(str);
- chunkName = prefix ? `${prefix}---${name}` : name;
  chunkNameCache.set(modulePath, chunkName);
  }
  return chunkName;

packages/docusaurus/src/client/exports/ComponentCreator.js

@@ -56,9 +56,11 @@ function ComponentCreator(path) {
  }
 
  const chunkRegistry = registry[target] || {};
- optsLoader[keys.join('.')] = chunkRegistry.loader;
- optsModules.push(chunkRegistry.module);
- optsWebpack.push(chunkRegistry.webpack);
+ /* eslint-disable prefer-destructuring */
+ optsLoader[keys.join('.')] = chunkRegistry[0];
+ optsModules.push(chunkRegistry[1]);
+ optsWebpack.push(chunkRegistry[2]);
+ /* eslint-enable prefer-destructuring */
  }
 
  traverseChunk(chunkNames, []);

packages/docusaurus/src/server/index.ts

@@ -117,11 +117,10 @@ export async function load(siteDir: string): Promise<Props> {
  `export default {
 ${Object.keys(registry)
  .map(
- key => ` '${key}': {
- 'loader': ${registry[key].loader},
- 'module': ${JSON.stringify(registry[key].modulePath)},
- 'webpack': require.resolveWeak(${JSON.stringify(registry[key].modulePath)}),
- },`,
+ key =>
+ ` '${key}': [${registry[key].loader}, ${JSON.stringify(
+ registry[key].modulePath,
+ )}, require.resolveWeak(${JSON.stringify(registry[key].modulePath)})],`,
  )
  .join('\n')}};\n`,
  );

packages/docusaurus/src/server/routes.ts

@@ -24,6 +24,7 @@ function getModulePath(target: Module): string {
 }
 
 export async function loadRoutes(pluginsRouteConfigs: RouteConfig[]) {
+ const isProd = process.env.NODE_ENV === 'production';
  const routesImports = [
  `import React from 'react';`,
  `import ComponentCreator from '@docusaurus/ComponentCreator';`,
@@ -82,7 +83,7 @@ export async function loadRoutes(pluginsRouteConfigs: RouteConfig[]) {
  }
 
  const modulePath = getModulePath(value as Module);
- const chunkName = genChunkName(modulePath, prefix, name);
+ const chunkName = genChunkName(modulePath, prefix, name, isProd);
  const loader = `() => import(/* webpackChunkName: '${chunkName}' */ ${JSON.stringify(
  modulePath,
  )})`;

packages/docusaurus/src/webpack/base.ts

@@ -32,8 +32,8 @@ export function createBaseConfig(
  output: {
  pathinfo: false,
  path: outDir,
- filename: isProd ? '[name].[contenthash].js' : '[name].js',
- chunkFilename: isProd ? '[name].[contenthash].js' : '[name].js',
+ filename: isProd ? '[name].[contenthash:8].js' : '[name].js',
+ chunkFilename: isProd ? '[name].[contenthash:8].js' : '[name].js',
  publicPath: baseUrl,
  },
  // Don't throw warning when asset created is over 250kb
@@ -157,8 +157,8 @@ export function createBaseConfig(
  },
  plugins: [
  new MiniCssExtractPlugin({
- filename: isProd ? '[name].[contenthash].css' : '[name].css',
- chunkFilename: isProd ? '[name].[contenthash].css' : '[name].css',
+ filename: isProd ? '[name].[contenthash:8].css' : '[name].css',
+ chunkFilename: isProd ? '[name].[contenthash:8].css' : '[name].css',
  }),
  ],
  };