feat(v2): Implement proof-of-concept Docusaurus Debug Dashboard

.eslintignore

@@ -18,6 +18,7 @@ packages/docusaurus-plugin-client-redirects/lib/
 packages/docusaurus-plugin-content-blog/lib/
 packages/docusaurus-plugin-content-docs/lib/
 packages/docusaurus-plugin-content-pages/lib/
+packages/docusaurus-plugin-debug/lib/
 packages/docusaurus-plugin-sitemap/lib/
 packages/docusaurus-plugin-ideal-image/lib/
 packages/docusaurus-plugin-ideal-image/copyUntypedFiles.js

.gitignore

@@ -22,5 +22,6 @@ packages/docusaurus-plugin-client-redirects/lib/
 packages/docusaurus-plugin-content-blog/lib/
 packages/docusaurus-plugin-content-docs/lib/
 packages/docusaurus-plugin-content-pages/lib/
+packages/docusaurus-plugin-debug/lib/
 packages/docusaurus-plugin-sitemap/lib/
 packages/docusaurus-plugin-ideal-image/lib/

.prettierignore

@@ -11,6 +11,7 @@ packages/docusaurus-init/templates/**/*.md
 packages/docusaurus-plugin-content-blog/lib/
 packages/docusaurus-plugin-content-docs/lib/
 packages/docusaurus-plugin-content-pages/lib/
+packages/docusaurus-plugin-debug/lib/
 packages/docusaurus-plugin-sitemap/lib/
 packages/docusaurus-plugin-ideal-image/lib/
 __fixtures__

packages/docusaurus-plugin-debug/package.json

@@ -0,0 +1,25 @@
+{
+ "name": "@docusaurus/plugin-debug",
+ "version": "2.0.0-alpha.56",
+ "description": "Debug plugin for Docusaurus",
+ "main": "lib/index.js",
+ "scripts": {
+ "tsc": "tsc"
+ },
+ "publishConfig": {
+ "access": "public"
+ },
+ "license": "MIT",
+ "dependencies": {
+ "@docusaurus/types": "^2.0.0-alpha.56",
+ "@docusaurus/utils": "^2.0.0-alpha.56"
+ },
+ "peerDependencies": {
+ "@docusaurus/core": "^2.0.0",
+ "react": "^16.8.4",
+ "react-dom": "^16.8.4"
+ },
+ "engines": {
+ "node": ">=10.15.1"
+ }
+}

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

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {LoadContext, Plugin} from '@docusaurus/types';
+import {normalizeUrl} from '@docusaurus/utils';
+
+import path from 'path';
+
+export default function pluginContentPages({
+ siteConfig: {baseUrl},
+}: LoadContext): Plugin<void> {
+ return {
+ name: 'docusaurus-plugin-debug',
+
+ getThemePath() {
+ return path.resolve(__dirname, '../src/theme');
+ },
+
+ contentLoaded({actions: {addRoute}}) {
+ addRoute({
+ path: normalizeUrl([baseUrl, '__docusaurus/debug']),
+ component: '@theme/Debug',
+ exact: true,
+ });
+ },
+ };
+}

packages/docusaurus-plugin-debug/src/theme/Debug/index.js

@@ -0,0 +1,47 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import React from 'react';
+import Layout from '@theme/Layout';
+
+import registry from '@generated/registry';
+import routes from '@generated/routes';
+
+import styles from './styles.module.css';
+
+function Debug() {
+ return (
+ <Layout permalink="__docusaurus/debug" title="Debug">
+ <main className={styles.Container}>
+ <section>
+ <h2>Registry</h2>
+ <ul>
+ {Object.values(registry).map(([, aliasedPath, resolved]) => (
+ <li key={aliasedPath}>
+ <div>Aliased Path: {aliasedPath}</div>
+ <div>Resolved Path: {resolved}</div>
+ </li>
+ ))}
+ </ul>
+ </section>
+ <section>
+ <h2>Routes</h2>
+ <ul>
+ {routes.map(({path, exact}) => (
+ <li key={path}>
+ <div>Route: {path}</div>
+ <div>Is exact: {Boolean(exact)}</div>
+ </li>
+ ))}
+ </ul>
+ </section>
+ </main>
+ </Layout>
+ );
+}
+
+export default Debug;

packages/docusaurus-plugin-debug/src/theme/Debug/styles.module.css

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+.Container {
+ display: flex;
+ margin: 1em;
+}

packages/docusaurus-plugin-debug/tsconfig.json

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

packages/docusaurus-preset-classic/src/index.js

@@ -24,6 +24,7 @@ module.exports = function preset(context, opts = {}) {
  isProd &&
  googleAnalytics &&
  require.resolve('@docusaurus/plugin-google-analytics'),
+ !isProd && require.resolve('@docusaurus/plugin-debug'),
  isProd && gtag && require.resolve('@docusaurus/plugin-google-gtag'),
  isProd && [require.resolve('@docusaurus/plugin-sitemap'), opts.sitemap],
  ],