@docusaurus/plugin-content-pages 2.0.0-beta.14 → 2.0.0-beta.15

package/lib/index.d.ts

@@ -4,8 +4,9 @@
  * 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, OptionValidationContext, ValidationResult } from '@docusaurus/types';
-import { PluginOptions, LoadedContent, PagesContentPaths } from './types';
+import type { LoadContext, Plugin, OptionValidationContext, ValidationResult } from '@docusaurus/types';
+import type { LoadedContent, PagesContentPaths } from './types';
+import type { PluginOptions } from '@docusaurus/plugin-content-pages';
 export declare function getContentPathList(contentPaths: PagesContentPaths): string[];
-export default function pluginContentPages(context: LoadContext, options: PluginOptions): Plugin<LoadedContent | null>;
+export default function pluginContentPages(context: LoadContext, options: PluginOptions): Promise<Plugin<LoadedContent | null>>;
 export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;

package/lib/index.js

@@ -8,17 +8,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = exports.getContentPathList = void 0;
 const tslib_1 = require("tslib");
-const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const utils_1 = require("@docusaurus/utils");
 const remark_admonitions_1 = (0, tslib_1.__importDefault)(require("remark-admonitions"));
 const pluginOptionSchema_1 = require("./pluginOptionSchema");
+const pageFrontMatter_1 = require("./pageFrontMatter");
 function getContentPathList(contentPaths) {
     return [contentPaths.contentPathLocalized, contentPaths.contentPath];
 }
 exports.getContentPathList = getContentPathList;
 const isMarkdownSource = (source) => source.endsWith('.md') || source.endsWith('.mdx');
-function pluginContentPages(context, options) {
+async function pluginContentPages(context, options) {
     var _a;
     if (options.admonitions) {
         options.remarkPlugins = options.remarkPlugins.concat([
@@ -45,7 +46,7 @@ function pluginContentPages(context, options) {
         },
         async loadContent() {
             const { include } = options;
-            if (!fs_1.default.existsSync(contentPaths.contentPath)) {
+            if (!(await fs_extra_1.default.pathExists(contentPaths.contentPath))) {
                 return null;
             }
             const { baseUrl } = siteConfig;
@@ -54,6 +55,7 @@ function pluginContentPages(context, options) {
                 ignore: options.exclude,
             });
             async function toMetadata(relativeSource) {
+                var _a, _b;
                 // Lookup in localized folder in priority
                 const contentPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), relativeSource);
                 const source = path_1.default.join(contentPath, relativeSource);
@@ -64,11 +66,16 @@ function pluginContentPages(context, options) {
                     (0, utils_1.encodePath)((0, utils_1.fileToPath)(relativeSource)),
                 ]);
                 if (isMarkdownSource(relativeSource)) {
-                    // TODO: missing frontmatter validation/normalization here
+                    const content = await fs_extra_1.default.readFile(source, 'utf-8');
+                    const { frontMatter: unsafeFrontMatter, contentTitle, excerpt, } = (0, utils_1.parseMarkdownString)(content);
+                    const frontMatter = (0, pageFrontMatter_1.validatePageFrontMatter)(unsafeFrontMatter);
                     return {
                         type: 'mdx',
                         permalink,
                         source: aliasedSourcePath,
+                        title: (_a = frontMatter.title) !== null && _a !== void 0 ? _a : contentTitle,
+                        description: (_b = frontMatter.description) !== null && _b !== void 0 ? _b : excerpt,
+                        frontMatter,
                     };
                 }
                 else {

package/lib/markdownLoader.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 function markdownLoader(fileString) {
     const callback = this.async();
     // const options = this.getOptions();
-    // TODO provide additinal md processing here? like interlinking pages?
+    // TODO provide additional md processing here? like interlinking pages?
     // fileString = linkify(fileString)
     return callback && callback(null, fileString);
 }

package/lib/pageFrontMatter.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 type { FrontMatter } from '@docusaurus/plugin-content-pages';
+export declare function validatePageFrontMatter(frontMatter: Record<string, unknown>): FrontMatter;

package/lib/pageFrontMatter.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePageFrontMatter = void 0;
+const utils_validation_1 = require("@docusaurus/utils-validation");
+const PageFrontMatterSchema = utils_validation_1.Joi.object({
+    title: utils_validation_1.Joi.string(),
+    description: utils_validation_1.Joi.string(),
+    wrapperClassName: utils_validation_1.Joi.string(),
+    hide_table_of_contents: utils_validation_1.Joi.boolean(),
+    ...utils_validation_1.FrontMatterTOCHeadingLevels,
+});
+function validatePageFrontMatter(frontMatter) {
+    return (0, utils_validation_1.validateFrontMatter)(frontMatter, PageFrontMatterSchema);
+}
+exports.validatePageFrontMatter = validatePageFrontMatter;

package/lib/pluginOptionSchema.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginOptions } from './types';
+import type { PluginOptions } from '@docusaurus/plugin-content-pages';
 import { Joi } from '@docusaurus/utils-validation';
 export declare const DEFAULT_OPTIONS: PluginOptions;
 export declare const PluginOptionSchema: Joi.ObjectSchema<any>;

package/lib/types.d.ts

@@ -4,27 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { RemarkAndRehypePluginOptions } from '@docusaurus/mdx-loader';
-export declare type PluginOptions = RemarkAndRehypePluginOptions & {
-    id?: string;
-    path: string;
-    routeBasePath: string;
-    include: string[];
-    exclude: string[];
-    mdxPageComponent: string;
-    admonitions: Record<string, unknown>;
-};
-export declare type JSXPageMetadata = {
-    type: 'jsx';
-    permalink: string;
-    source: string;
-};
-export declare type MDXPageMetadata = {
-    type: 'mdx';
-    permalink: string;
-    source: string;
-};
-export declare type Metadata = JSXPageMetadata | MDXPageMetadata;
+import type { Metadata } from '@docusaurus/plugin-content-pages';
 export declare type LoadedContent = Metadata[];
 export declare type PagesContentPaths = {
     contentPath: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "2.0.0-beta.14",
+  "version": "2.0.0-beta.15",
   "description": "Pages plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-pages.d.ts",
@@ -18,17 +18,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.14",
-    "@docusaurus/mdx-loader": "2.0.0-beta.14",
-    "@docusaurus/utils": "2.0.0-beta.14",
-    "@docusaurus/utils-validation": "2.0.0-beta.14",
+    "@docusaurus/core": "2.0.0-beta.15",
+    "@docusaurus/mdx-loader": "2.0.0-beta.15",
+    "@docusaurus/utils": "2.0.0-beta.15",
+    "@docusaurus/utils-validation": "2.0.0-beta.15",
+    "fs-extra": "^10.0.0",
     "globby": "^11.0.2",
     "remark-admonitions": "^1.2.1",
     "tslib": "^2.3.1",
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.14"
+    "@docusaurus/types": "2.0.0-beta.15"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -37,5 +38,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "c4824a8937d8f1aa0806667749cbc74058e2b294"
+  "gitHead": "6cfad16436c07d8d11e5c2e1486dc59afd483e33"
 }

package/src/index.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import fs from 'fs';
+import fs from 'fs-extra';
 import path from 'path';
 import {
   encodePath,
@@ -19,24 +19,22 @@ import {
   createAbsoluteFilePathMatcher,
   normalizeUrl,
   DEFAULT_PLUGIN_ID,
+  parseMarkdownString,
 } from '@docusaurus/utils';
-import {
+import type {
   LoadContext,
   Plugin,
   OptionValidationContext,
   ValidationResult,
   ConfigureWebpackUtils,
 } from '@docusaurus/types';
-import {Configuration} from 'webpack';
+import type {Configuration} from 'webpack';
 import admonitions from 'remark-admonitions';
 import {PluginOptionSchema} from './pluginOptionSchema';
+import {validatePageFrontMatter} from './pageFrontMatter';
 
-import {
-  PluginOptions,
-  LoadedContent,
-  Metadata,
-  PagesContentPaths,
-} from './types';
+import type {LoadedContent, PagesContentPaths} from './types';
+import type {PluginOptions, Metadata} from '@docusaurus/plugin-content-pages';
 
 export function getContentPathList(contentPaths: PagesContentPaths): string[] {
   return [contentPaths.contentPathLocalized, contentPaths.contentPath];
@@ -45,10 +43,10 @@ export function getContentPathList(contentPaths: PagesContentPaths): string[] {
 const isMarkdownSource = (source: string) =>
   source.endsWith('.md') || source.endsWith('.mdx');
 
-export default function pluginContentPages(
+export default async function pluginContentPages(
   context: LoadContext,
   options: PluginOptions,
-): Plugin<LoadedContent | null> {
+): Promise<Plugin<LoadedContent | null>> {
   if (options.admonitions) {
     options.remarkPlugins = options.remarkPlugins.concat([
       [admonitions, options.admonitions || {}],
@@ -90,7 +88,7 @@ export default function pluginContentPages(
     async loadContent() {
       const {include} = options;
 
-      if (!fs.existsSync(contentPaths.contentPath)) {
+      if (!(await fs.pathExists(contentPaths.contentPath))) {
         return null;
       }
 
@@ -115,11 +113,20 @@ export default function pluginContentPages(
           encodePath(fileToPath(relativeSource)),
         ]);
         if (isMarkdownSource(relativeSource)) {
-          // TODO: missing frontmatter validation/normalization here
+          const content = await fs.readFile(source, 'utf-8');
+          const {
+            frontMatter: unsafeFrontMatter,
+            contentTitle,
+            excerpt,
+          } = parseMarkdownString(content);
+          const frontMatter = validatePageFrontMatter(unsafeFrontMatter);
           return {
             type: 'mdx',
             permalink,
             source: aliasedSourcePath,
+            title: frontMatter.title ?? contentTitle,
+            description: frontMatter.description ?? excerpt,
+            frontMatter,
           };
         } else {
           return {

package/src/markdownLoader.ts

@@ -15,7 +15,7 @@ export default function markdownLoader(
 
   // const options = this.getOptions();
 
-  // TODO provide additinal md processing here? like interlinking pages?
+  // TODO provide additional md processing here? like interlinking pages?
   // fileString = linkify(fileString)
 
   return callback && callback(null, fileString);

package/src/pageFrontMatter.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 {
+  Joi,
+  validateFrontMatter,
+  FrontMatterTOCHeadingLevels,
+} from '@docusaurus/utils-validation';
+import type {FrontMatter} from '@docusaurus/plugin-content-pages';
+
+const PageFrontMatterSchema = Joi.object<FrontMatter>({
+  title: Joi.string(),
+  description: Joi.string(),
+  wrapperClassName: Joi.string(),
+  hide_table_of_contents: Joi.boolean(),
+  ...FrontMatterTOCHeadingLevels,
+});
+
+export function validatePageFrontMatter(
+  frontMatter: Record<string, unknown>,
+): FrontMatter {
+  return validateFrontMatter(frontMatter, PageFrontMatterSchema);
+}

package/src/plugin-content-pages.d.ts

@@ -6,23 +6,58 @@
  */
 
 declare module '@docusaurus/plugin-content-pages' {
-  export type Options = Partial<import('./types').PluginOptions>;
+  import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
+
+  export type PluginOptions = RemarkAndRehypePluginOptions & {
+    id?: string;
+    path: string;
+    routeBasePath: string;
+    include: string[];
+    exclude: string[];
+    mdxPageComponent: string;
+    admonitions: Record<string, unknown>;
+  };
+
+  export type Options = Partial<PluginOptions>;
+
+  export type FrontMatter = {
+    readonly title?: string;
+    readonly description?: string;
+    readonly wrapperClassName?: string;
+    readonly hide_table_of_contents?: string;
+    readonly toc_min_heading_level?: number;
+    readonly toc_max_heading_level?: number;
+  };
+
+  export type JSXPageMetadata = {
+    type: 'jsx';
+    permalink: string;
+    source: string;
+  };
+
+  export type MDXPageMetadata = {
+    type: 'mdx';
+    permalink: string;
+    source: string;
+    frontMatter: FrontMatter & Record<string, unknown>;
+    title?: string;
+    description?: string;
+  };
+
+  export type Metadata = JSXPageMetadata | MDXPageMetadata;
 }
 
 declare module '@theme/MDXPage' {
   import type {TOCItem} from '@docusaurus/types';
+  import type {
+    MDXPageMetadata,
+    FrontMatter,
+  } from '@docusaurus/plugin-content-pages';
 
   export interface Props {
     readonly content: {
-      readonly frontMatter: {
-        readonly title: string;
-        readonly description: string;
-        readonly wrapperClassName?: string;
-        readonly hide_table_of_contents?: string;
-        readonly toc_min_heading_level?: number;
-        readonly toc_max_heading_level?: number;
-      };
-      readonly metadata: {readonly permalink: string};
+      readonly frontMatter: FrontMatter;
+      readonly metadata: MDXPageMetadata;
       readonly toc: readonly TOCItem[];
       (): JSX.Element;
     };

package/src/pluginOptionSchema.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {PluginOptions} from './types';
+import type {PluginOptions} from '@docusaurus/plugin-content-pages';
 import {
   Joi,
   RemarkPluginsSchema,

package/src/types.ts

@@ -5,31 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
-
-export type PluginOptions = RemarkAndRehypePluginOptions & {
-  id?: string;
-  path: string;
-  routeBasePath: string;
-  include: string[];
-  exclude: string[];
-  mdxPageComponent: string;
-  admonitions: Record<string, unknown>;
-};
-
-export type JSXPageMetadata = {
-  type: 'jsx';
-  permalink: string;
-  source: string;
-};
-
-export type MDXPageMetadata = {
-  type: 'mdx';
-  permalink: string;
-  source: string;
-};
-
-export type Metadata = JSXPageMetadata | MDXPageMetadata;
+import type {Metadata} from '@docusaurus/plugin-content-pages';
 
 export type LoadedContent = Metadata[];