@docusaurus/plugin-debug 2.0.0-beta.16 → 2.0.0-beta.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -5,4 +5,4 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
  import type { LoadContext, Plugin } from '@docusaurus/types';
8
- export default function pluginDebug({ siteConfig: { baseUrl }, generatedFilesDir, }: LoadContext): Plugin<void>;
8
+ export default function pluginDebug({ siteConfig: { baseUrl }, generatedFilesDir, }: LoadContext): Plugin<undefined>;
package/lib/index.js CHANGED
@@ -8,17 +8,17 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
10
  const utils_1 = require("@docusaurus/utils");
11
- const path_1 = (0, tslib_1.__importDefault)(require("path"));
11
+ const path_1 = tslib_1.__importDefault(require("path"));
12
12
  function pluginDebug({ siteConfig: { baseUrl }, generatedFilesDir, }) {
13
13
  const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-debug');
14
14
  const aliasedSource = (source) => `~debug/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
15
15
  return {
16
16
  name: 'docusaurus-plugin-debug',
17
17
  getThemePath() {
18
- return path_1.default.resolve(__dirname, '../lib/theme');
18
+ return '../lib/theme';
19
19
  },
20
20
  getTypeScriptThemePath() {
21
- return path_1.default.resolve(__dirname, '../src/theme');
21
+ return '../src/theme';
22
22
  },
23
23
  async contentLoaded({ actions: { createData, addRoute }, allContent }) {
24
24
  const allContentPath = await createData(
@@ -7,10 +7,10 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const react_1 = (0, tslib_1.__importDefault)(require("react"));
11
- const DebugLayout_1 = (0, tslib_1.__importDefault)(require("@theme/DebugLayout"));
12
- const DebugJsonView_1 = (0, tslib_1.__importDefault)(require("@theme/DebugJsonView"));
13
- const useDocusaurusContext_1 = (0, tslib_1.__importDefault)(require("@docusaurus/useDocusaurusContext"));
10
+ const react_1 = tslib_1.__importDefault(require("react"));
11
+ const DebugLayout_1 = tslib_1.__importDefault(require("@theme/DebugLayout"));
12
+ const DebugJsonView_1 = tslib_1.__importDefault(require("@theme/DebugJsonView"));
13
+ const useDocusaurusContext_1 = tslib_1.__importDefault(require("@docusaurus/useDocusaurusContext"));
14
14
  function DebugMetadata() {
15
15
  const { siteConfig } = (0, useDocusaurusContext_1.default)();
16
16
  return (react_1.default.createElement(DebugLayout_1.default, null,
@@ -7,9 +7,9 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const react_1 = (0, tslib_1.__importDefault)(require("react"));
11
- const DebugLayout_1 = (0, tslib_1.__importDefault)(require("@theme/DebugLayout"));
12
- const DebugJsonView_1 = (0, tslib_1.__importDefault)(require("@theme/DebugJsonView"));
10
+ const react_1 = tslib_1.__importDefault(require("react"));
11
+ const DebugLayout_1 = tslib_1.__importDefault(require("@theme/DebugLayout"));
12
+ const DebugJsonView_1 = tslib_1.__importDefault(require("@theme/DebugJsonView"));
13
13
  function PluginInstanceContent({ pluginId, pluginInstanceContent, }) {
14
14
  return (react_1.default.createElement("section", { style: { marginBottom: 30 } },
15
15
  react_1.default.createElement("code", null, pluginId),
@@ -19,16 +19,16 @@ function PluginContent({ pluginName, pluginContent, }) {
19
19
  return (react_1.default.createElement("section", { style: { marginBottom: 60 } },
20
20
  react_1.default.createElement("h3", null, pluginName),
21
21
  react_1.default.createElement("div", null, Object.entries(pluginContent)
22
- // filter plugin instances with no content
23
- .filter(([_pluginId, pluginInstanceContent]) => !!pluginInstanceContent)
22
+ // Filter plugin instances with no content
23
+ .filter(([, pluginInstanceContent]) => !!pluginInstanceContent)
24
24
  .map(([pluginId, pluginInstanceContent]) => (react_1.default.createElement(PluginInstanceContent, { key: pluginId, pluginId: pluginId, pluginInstanceContent: pluginInstanceContent }))))));
25
25
  }
26
26
  function DebugContent({ allContent }) {
27
27
  return (react_1.default.createElement(DebugLayout_1.default, null,
28
28
  react_1.default.createElement("h2", null, "Plugin content"),
29
29
  react_1.default.createElement("div", null, Object.entries(allContent)
30
- // filter plugins with no content
31
- .filter(([_pluginName, pluginContent]) => Object.values(pluginContent).some((instanceContent) => !!instanceContent))
30
+ // Filter plugins with no content
31
+ .filter(([, pluginContent]) => Object.values(pluginContent).some((instanceContent) => !!instanceContent))
32
32
  .map(([pluginName, pluginContent]) => (react_1.default.createElement(PluginContent, { key: pluginName, pluginName: pluginName, pluginContent: pluginContent }))))));
33
33
  }
34
34
  exports.default = DebugContent;
@@ -7,10 +7,10 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const react_1 = (0, tslib_1.__importDefault)(require("react"));
11
- const DebugLayout_1 = (0, tslib_1.__importDefault)(require("@theme/DebugLayout"));
12
- const DebugJsonView_1 = (0, tslib_1.__importDefault)(require("@theme/DebugJsonView"));
13
- const useGlobalData_1 = (0, tslib_1.__importDefault)(require("@docusaurus/useGlobalData"));
10
+ const react_1 = tslib_1.__importDefault(require("react"));
11
+ const DebugLayout_1 = tslib_1.__importDefault(require("@theme/DebugLayout"));
12
+ const DebugJsonView_1 = tslib_1.__importDefault(require("@theme/DebugJsonView"));
13
+ const useGlobalData_1 = tslib_1.__importDefault(require("@docusaurus/useGlobalData"));
14
14
  function DebugMetadata() {
15
15
  const globalData = (0, useGlobalData_1.default)();
16
16
  return (react_1.default.createElement(DebugLayout_1.default, null,
@@ -7,9 +7,9 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const react_1 = (0, tslib_1.__importDefault)(require("react"));
11
- const BrowserOnly_1 = (0, tslib_1.__importDefault)(require("@docusaurus/BrowserOnly"));
12
- // avoids "react-json-view" to display "root"
10
+ const react_1 = tslib_1.__importDefault(require("react"));
11
+ const BrowserOnly_1 = tslib_1.__importDefault(require("@docusaurus/BrowserOnly"));
12
+ // Avoids "react-json-view" displaying "root"
13
13
  const RootName = null;
14
14
  // Seems ReactJson does not work with SSR
15
15
  // https://github.com/mac-s-g/react-json-view/issues/121
@@ -7,10 +7,10 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const react_1 = (0, tslib_1.__importDefault)(require("react"));
11
- const Head_1 = (0, tslib_1.__importDefault)(require("@docusaurus/Head"));
12
- const Link_1 = (0, tslib_1.__importDefault)(require("@docusaurus/Link"));
13
- const styles_module_css_1 = (0, tslib_1.__importDefault)(require("./styles.module.css"));
10
+ const react_1 = tslib_1.__importDefault(require("react"));
11
+ const Head_1 = tslib_1.__importDefault(require("@docusaurus/Head"));
12
+ const Link_1 = tslib_1.__importDefault(require("@docusaurus/Link"));
13
+ const styles_module_css_1 = tslib_1.__importDefault(require("./styles.module.css"));
14
14
  function DebugNavLink({ to, children }) {
15
15
  return (react_1.default.createElement(Link_1.default, { className: styles_module_css_1.default.navlink, isNavLink: true, to: to, exact: true, activeStyle: {
16
16
  backgroundColor: '#363739',
@@ -20,7 +20,8 @@ function DebugLayout({ children, }) {
20
20
  return (react_1.default.createElement(react_1.default.Fragment, null,
21
21
  react_1.default.createElement(Head_1.default, null,
22
22
  react_1.default.createElement("html", { lang: "en" }),
23
- react_1.default.createElement("title", null, "Docusaurus debug panel")),
23
+ react_1.default.createElement("title", null, "Docusaurus debug panel"),
24
+ react_1.default.createElement("meta", { name: "robots", content: "noindex" })),
24
25
  react_1.default.createElement("div", null,
25
26
  react_1.default.createElement("nav", { className: styles_module_css_1.default.nav },
26
27
  react_1.default.createElement(DebugNavLink, { to: "/__docusaurus/debug" }, "Config"),
@@ -7,14 +7,14 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const react_1 = (0, tslib_1.__importDefault)(require("react"));
11
- const DebugLayout_1 = (0, tslib_1.__importDefault)(require("@theme/DebugLayout"));
12
- const registry_1 = (0, tslib_1.__importDefault)(require("@generated/registry"));
13
- const styles_module_css_1 = (0, tslib_1.__importDefault)(require("./styles.module.css"));
10
+ const react_1 = tslib_1.__importDefault(require("react"));
11
+ const DebugLayout_1 = tslib_1.__importDefault(require("@theme/DebugLayout"));
12
+ const registry_1 = tslib_1.__importDefault(require("@generated/registry"));
13
+ const styles_module_css_1 = tslib_1.__importDefault(require("./styles.module.css"));
14
14
  function DebugRegistry() {
15
15
  return (react_1.default.createElement(DebugLayout_1.default, null,
16
16
  react_1.default.createElement("h2", null, "Registry"),
17
- react_1.default.createElement("ul", { className: styles_module_css_1.default.list }, Object.values(registry_1.default).map(([, aliasedPath, resolved]) => (react_1.default.createElement("li", { key: aliasedPath, className: styles_module_css_1.default.listItem },
17
+ react_1.default.createElement("ul", { className: "clean-list" }, Object.values(registry_1.default).map(([, aliasedPath, resolved]) => (react_1.default.createElement("li", { key: aliasedPath, className: styles_module_css_1.default.listItem },
18
18
  react_1.default.createElement("div", { style: { marginBottom: '10px' } },
19
19
  "Aliased Path: ",
20
20
  react_1.default.createElement("code", null, aliasedPath)),
@@ -5,12 +5,7 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
- .list {
9
- padding: 0;
10
- }
11
-
12
8
  .listItem {
13
- list-style: none;
14
9
  background-color: #242526;
15
10
  padding: 10px;
16
11
  border-radius: 4px;
@@ -7,15 +7,15 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const react_1 = (0, tslib_1.__importDefault)(require("react"));
11
- const DebugLayout_1 = (0, tslib_1.__importDefault)(require("@theme/DebugLayout"));
12
- const DebugJsonView_1 = (0, tslib_1.__importDefault)(require("@theme/DebugJsonView"));
13
- const routes_1 = (0, tslib_1.__importDefault)(require("@generated/routes"));
14
- const styles_module_css_1 = (0, tslib_1.__importDefault)(require("./styles.module.css"));
10
+ const react_1 = tslib_1.__importDefault(require("react"));
11
+ const DebugLayout_1 = tslib_1.__importDefault(require("@theme/DebugLayout"));
12
+ const DebugJsonView_1 = tslib_1.__importDefault(require("@theme/DebugJsonView"));
13
+ const routes_1 = tslib_1.__importDefault(require("@generated/routes"));
14
+ const styles_module_css_1 = tslib_1.__importDefault(require("./styles.module.css"));
15
15
  function DebugRoutes() {
16
16
  return (react_1.default.createElement(DebugLayout_1.default, null,
17
17
  react_1.default.createElement("h2", null, "Routes"),
18
- react_1.default.createElement("ul", { className: styles_module_css_1.default.list }, routes_1.default.map(({ path, exact, routes: childRoutes }) => (react_1.default.createElement("li", { key: path, className: styles_module_css_1.default.listItem },
18
+ react_1.default.createElement("ul", { className: "clean-list" }, routes_1.default.map(({ path, exact, routes: childRoutes }) => (react_1.default.createElement("li", { key: path, className: styles_module_css_1.default.listItem },
19
19
  react_1.default.createElement("div", { className: styles_module_css_1.default.route },
20
20
  react_1.default.createElement("code", { className: styles_module_css_1.default.routeName }, path)),
21
21
  react_1.default.createElement("div", null,
@@ -5,12 +5,7 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
- .list {
9
- padding: 0;
10
- }
11
-
12
8
  .listItem {
13
- list-style: none;
14
9
  background-color: #242526;
15
10
  padding: 10px;
16
11
  border-radius: 4px;
@@ -7,10 +7,10 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const react_1 = (0, tslib_1.__importDefault)(require("react"));
11
- const DebugLayout_1 = (0, tslib_1.__importDefault)(require("@theme/DebugLayout"));
12
- const useDocusaurusContext_1 = (0, tslib_1.__importDefault)(require("@docusaurus/useDocusaurusContext"));
13
- const styles_module_css_1 = (0, tslib_1.__importDefault)(require("./styles.module.css"));
10
+ const react_1 = tslib_1.__importDefault(require("react"));
11
+ const DebugLayout_1 = tslib_1.__importDefault(require("@theme/DebugLayout"));
12
+ const useDocusaurusContext_1 = tslib_1.__importDefault(require("@docusaurus/useDocusaurusContext"));
13
+ const styles_module_css_1 = tslib_1.__importDefault(require("./styles.module.css"));
14
14
  function DebugMetadata() {
15
15
  const { siteMetadata } = (0, useDocusaurusContext_1.default)();
16
16
  return (react_1.default.createElement(DebugLayout_1.default, null,
@@ -23,7 +23,7 @@ function DebugMetadata() {
23
23
  ' ',
24
24
  react_1.default.createElement("code", null, siteMetadata.siteVersion || 'No version specified')),
25
25
  react_1.default.createElement("h3", { className: styles_module_css_1.default.sectionTitle }, "Plugins and themes"),
26
- react_1.default.createElement("ul", { className: styles_module_css_1.default.list }, Object.entries(siteMetadata.pluginVersions).map(([name, versionInformation]) => (react_1.default.createElement("li", { key: name, className: styles_module_css_1.default.listItem },
26
+ react_1.default.createElement("ul", { className: "clean-list" }, Object.entries(siteMetadata.pluginVersions).map(([name, versionInformation]) => (react_1.default.createElement("li", { key: name, className: styles_module_css_1.default.listItem },
27
27
  versionInformation.type === 'package' &&
28
28
  versionInformation.version && (react_1.default.createElement("div", { className: styles_module_css_1.default.version },
29
29
  react_1.default.createElement("code", null, versionInformation.version))),
@@ -9,12 +9,7 @@
9
9
  margin-top: 20px;
10
10
  }
11
11
 
12
- .list {
13
- padding: 0;
14
- }
15
-
16
12
  .listItem {
17
- list-style: none;
18
13
  background-color: #242526;
19
14
  padding: 10px;
20
15
  border-radius: 4px;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@docusaurus/plugin-debug",
3
- "version": "2.0.0-beta.16",
3
+ "version": "2.0.0-beta.19",
4
4
  "description": "Debug plugin for Docusaurus.",
5
5
  "main": "lib/index.js",
6
6
  "types": "src/plugin-debug.d.ts",
@@ -18,14 +18,14 @@
18
18
  },
19
19
  "license": "MIT",
20
20
  "dependencies": {
21
- "@docusaurus/core": "2.0.0-beta.16",
22
- "@docusaurus/utils": "2.0.0-beta.16",
23
- "fs-extra": "^10.0.1",
21
+ "@docusaurus/core": "2.0.0-beta.19",
22
+ "@docusaurus/utils": "2.0.0-beta.19",
23
+ "fs-extra": "^10.1.0",
24
24
  "react-json-view": "^1.21.3",
25
- "tslib": "^2.3.1"
25
+ "tslib": "^2.4.0"
26
26
  },
27
27
  "devDependencies": {
28
- "@docusaurus/types": "2.0.0-beta.16"
28
+ "@docusaurus/types": "2.0.0-beta.19"
29
29
  },
30
30
  "peerDependencies": {
31
31
  "react": "^16.8.4 || ^17.0.0",
@@ -34,5 +34,5 @@
34
34
  "engines": {
35
35
  "node": ">=14"
36
36
  },
37
- "gitHead": "eb43c4d4f95a4fb97dc9bb9dc615413e0dc2e1e7"
37
+ "gitHead": "a71e60a49cce93c1006ef10c41ac03187f057102"
38
38
  }
package/src/index.ts CHANGED
@@ -12,7 +12,7 @@ import path from 'path';
12
12
  export default function pluginDebug({
13
13
  siteConfig: {baseUrl},
14
14
  generatedFilesDir,
15
- }: LoadContext): Plugin<void> {
15
+ }: LoadContext): Plugin<undefined> {
16
16
  const pluginDataDirRoot = path.join(
17
17
  generatedFilesDir,
18
18
  'docusaurus-plugin-debug',
@@ -24,10 +24,10 @@ export default function pluginDebug({
24
24
  name: 'docusaurus-plugin-debug',
25
25
 
26
26
  getThemePath() {
27
- return path.resolve(__dirname, '../lib/theme');
27
+ return '../lib/theme';
28
28
  },
29
29
  getTypeScriptThemePath() {
30
- return path.resolve(__dirname, '../src/theme');
30
+ return '../src/theme';
31
31
  },
32
32
 
33
33
  async contentLoaded({actions: {createData, addRoute}, allContent}) {
@@ -7,6 +7,12 @@
7
7
 
8
8
  /// <reference types="@docusaurus/module-type-aliases" />
9
9
 
10
+ declare module '@docusaurus/plugin-debug' {
11
+ import type {LoadContext, Plugin} from '@docusaurus/types';
12
+
13
+ export default function pluginDebug(context: LoadContext): Plugin<undefined>;
14
+ }
15
+
10
16
  declare module '@theme/DebugConfig' {
11
17
  export default function DebugMetadata(): JSX.Element;
12
18
  }
@@ -31,17 +31,15 @@ function PluginContent({
31
31
  pluginContent,
32
32
  }: {
33
33
  pluginName: string;
34
- pluginContent: Record<string, unknown>;
34
+ pluginContent: {[pluginId: string]: unknown};
35
35
  }) {
36
36
  return (
37
37
  <section style={{marginBottom: 60}}>
38
38
  <h3>{pluginName}</h3>
39
39
  <div>
40
40
  {Object.entries(pluginContent)
41
- // filter plugin instances with no content
42
- .filter(
43
- ([_pluginId, pluginInstanceContent]) => !!pluginInstanceContent,
44
- )
41
+ // Filter plugin instances with no content
42
+ .filter(([, pluginInstanceContent]) => !!pluginInstanceContent)
45
43
  .map(([pluginId, pluginInstanceContent]) => (
46
44
  <PluginInstanceContent
47
45
  key={pluginId}
@@ -60,8 +58,8 @@ export default function DebugContent({allContent}: Props): JSX.Element {
60
58
  <h2>Plugin content</h2>
61
59
  <div>
62
60
  {Object.entries(allContent)
63
- // filter plugins with no content
64
- .filter(([_pluginName, pluginContent]) =>
61
+ // Filter plugins with no content
62
+ .filter(([, pluginContent]) =>
65
63
  Object.values(pluginContent).some(
66
64
  (instanceContent) => !!instanceContent,
67
65
  ),
@@ -10,7 +10,7 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
10
10
  import type {Props} from '@theme/DebugJsonView';
11
11
  import type {ReactJsonViewProps} from 'react-json-view';
12
12
 
13
- // avoids "react-json-view" to display "root"
13
+ // Avoids "react-json-view" displaying "root"
14
14
  const RootName = null;
15
15
 
16
16
  // Seems ReactJson does not work with SSR
@@ -35,6 +35,7 @@ export default function DebugLayout({
35
35
  <Head>
36
36
  <html lang="en" />
37
37
  <title>Docusaurus debug panel</title>
38
+ <meta name="robots" content="noindex" />
38
39
  </Head>
39
40
 
40
41
  <div>
@@ -15,7 +15,7 @@ export default function DebugRegistry(): JSX.Element {
15
15
  return (
16
16
  <DebugLayout>
17
17
  <h2>Registry</h2>
18
- <ul className={styles.list}>
18
+ <ul className="clean-list">
19
19
  {Object.values(registry).map(([, aliasedPath, resolved]) => (
20
20
  <li key={aliasedPath} className={styles.listItem}>
21
21
  <div style={{marginBottom: '10px'}}>
@@ -5,12 +5,7 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
- .list {
9
- padding: 0;
10
- }
11
-
12
8
  .listItem {
13
- list-style: none;
14
9
  background-color: #242526;
15
10
  padding: 10px;
16
11
  border-radius: 4px;
@@ -16,7 +16,7 @@ export default function DebugRoutes(): JSX.Element {
16
16
  return (
17
17
  <DebugLayout>
18
18
  <h2>Routes</h2>
19
- <ul className={styles.list}>
19
+ <ul className="clean-list">
20
20
  {routes.map(({path, exact, routes: childRoutes}) => (
21
21
  <li key={path} className={styles.listItem}>
22
22
  <div className={styles.route}>
@@ -5,12 +5,7 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
- .list {
9
- padding: 0;
10
- }
11
-
12
8
  .listItem {
13
- list-style: none;
14
9
  background-color: #242526;
15
10
  padding: 10px;
16
11
  border-radius: 4px;
@@ -24,7 +24,7 @@ export default function DebugMetadata(): JSX.Element {
24
24
  <code>{siteMetadata.siteVersion || 'No version specified'}</code>
25
25
  </div>
26
26
  <h3 className={styles.sectionTitle}>Plugins and themes</h3>
27
- <ul className={styles.list}>
27
+ <ul className="clean-list">
28
28
  {Object.entries(siteMetadata.pluginVersions).map(
29
29
  ([name, versionInformation]) => (
30
30
  <li key={name} className={styles.listItem}>
@@ -9,12 +9,7 @@
9
9
  margin-top: 20px;
10
10
  }
11
11
 
12
- .list {
13
- padding: 0;
14
- }
15
-
16
12
  .listItem {
17
- list-style: none;
18
13
  background-color: #242526;
19
14
  padding: 10px;
20
15
  border-radius: 4px;