@docusaurus/plugin-content-pages 2.0.0-beta.2 → 2.0.0-beta.20

package/{src/__tests__/__fixtures__/website/i18n/fr/docusaurus-plugin-content-pages/hello/translatedJs.js → lib/frontMatter.d.ts}

@@ -4,11 +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 React from 'react';
-
-export default class TranslatedJs extends React.Component {
-  render() {
-    return <div>TranslatedJsPage (fr)</div>;
-  }
-}
+import type { FrontMatter } from '@docusaurus/plugin-content-pages';
+export declare function validatePageFrontMatter(frontMatter: {
+    [key: string]: unknown;
+}): FrontMatter;

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

package/lib/index.js

@@ -8,32 +8,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = exports.getContentPathList = void 0;
 const tslib_1 = require("tslib");
-const globby_1 = tslib_1.__importDefault(require("globby"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
-const minimatch_1 = tslib_1.__importDefault(require("minimatch"));
-const slash_1 = tslib_1.__importDefault(require("slash"));
 const utils_1 = require("@docusaurus/utils");
 const remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions"));
-const pluginOptionSchema_1 = require("./pluginOptionSchema");
-const constants_1 = require("@docusaurus/core/lib/constants");
-const lodash_1 = require("lodash");
+const frontMatter_1 = require("./frontMatter");
 function getContentPathList(contentPaths) {
     return [contentPaths.contentPathLocalized, contentPaths.contentPath];
 }
 exports.getContentPathList = getContentPathList;
 const isMarkdownSource = (source) => source.endsWith('.md') || source.endsWith('.mdx');
-function pluginContentPages(context, options) {
-    var _a;
+async function pluginContentPages(context, options) {
     if (options.admonitions) {
         options.remarkPlugins = options.remarkPlugins.concat([
-            [remark_admonitions_1.default, options.admonitions || {}],
+            [remark_admonitions_1.default, options.admonitions],
         ]);
     }
     const { siteConfig, siteDir, generatedFilesDir, i18n: { currentLocale }, } = context;
     const contentPaths = {
         contentPath: path_1.default.resolve(siteDir, options.path),
-        contentPathLocalized: utils_1.getPluginI18nPath({
+        contentPathLocalized: (0, utils_1.getPluginI18nPath)({
             siteDir,
             locale: currentLocale,
             pluginName: 'docusaurus-plugin-content-pages',
@@ -41,56 +35,51 @@ function pluginContentPages(context, options) {
         }),
     };
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-pages');
-    const dataDir = path_1.default.join(pluginDataDirRoot, (_a = options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_ID);
-    const excludeRegex = new RegExp(options.exclude
-        .map((pattern) => minimatch_1.default.makeRe(pattern).source)
-        .join('|'));
+    const dataDir = path_1.default.join(pluginDataDirRoot, options.id ?? utils_1.DEFAULT_PLUGIN_ID);
     return {
         name: 'docusaurus-plugin-content-pages',
         getPathsToWatch() {
-            const { include = [] } = options;
-            return lodash_1.flatten(getContentPathList(contentPaths).map((contentPath) => {
-                return include.map((pattern) => `${contentPath}/${pattern}`);
-            }));
-        },
-        getClientModules() {
-            const modules = [];
-            if (options.admonitions) {
-                modules.push(require.resolve('remark-admonitions/styles/infima.css'));
-            }
-            return modules;
+            const { include } = options;
+            return getContentPathList(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
         },
         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;
-            const pagesFiles = await globby_1.default(include, {
+            const pagesFiles = await (0, utils_1.Globby)(include, {
                 cwd: contentPaths.contentPath,
                 ignore: options.exclude,
             });
             async function toMetadata(relativeSource) {
                 // Lookup in localized folder in priority
-                const contentPath = await utils_1.getFolderContainingFile(getContentPathList(contentPaths), relativeSource);
+                const contentPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), relativeSource);
                 const source = path_1.default.join(contentPath, relativeSource);
-                const aliasedSourcePath = utils_1.aliasedSitePath(source, siteDir);
-                const pathName = utils_1.encodePath(utils_1.fileToPath(relativeSource));
-                const permalink = pathName.replace(/^\//, baseUrl || '');
-                if (isMarkdownSource(relativeSource)) {
-                    return {
-                        type: 'mdx',
-                        permalink,
-                        source: aliasedSourcePath,
-                    };
-                }
-                else {
+                const aliasedSourcePath = (0, utils_1.aliasedSitePath)(source, siteDir);
+                const permalink = (0, utils_1.normalizeUrl)([
+                    baseUrl,
+                    options.routeBasePath,
+                    (0, utils_1.encodePath)((0, utils_1.fileToPath)(relativeSource)),
+                ]);
+                if (!isMarkdownSource(relativeSource)) {
                     return {
                         type: 'jsx',
                         permalink,
                         source: aliasedSourcePath,
                     };
                 }
+                const content = await fs_extra_1.default.readFile(source, 'utf-8');
+                const { frontMatter: unsafeFrontMatter, contentTitle, excerpt, } = (0, utils_1.parseMarkdownString)(content);
+                const frontMatter = (0, frontMatter_1.validatePageFrontMatter)(unsafeFrontMatter);
+                return {
+                    type: 'mdx',
+                    permalink,
+                    source: aliasedSourcePath,
+                    title: frontMatter.title ?? contentTitle,
+                    description: frontMatter.description ?? excerpt,
+                    frontMatter,
+                };
             }
             return Promise.all(pagesFiles.map(toMetadata));
         },
@@ -105,7 +94,7 @@ function pluginContentPages(context, options) {
                     await createData(
                     // Note that this created data path must be in sync with
                     // metadataPath provided to mdx-loader.
-                    `${utils_1.docuHash(metadata.source)}.json`, JSON.stringify(metadata, null, 2));
+                    `${(0, utils_1.docuHash)(metadata.source)}.json`, JSON.stringify(metadata, null, 2));
                     addRoute({
                         path: permalink,
                         component: options.mdxPageComponent,
@@ -127,8 +116,9 @@ function pluginContentPages(context, options) {
                 }
             }));
         },
-        configureWebpack(_config, isServer, { getJSLoader }) {
+        configureWebpack(config, isServer, { getJSLoader }) {
             const { rehypePlugins, remarkPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
+            const contentDirs = getContentPathList(contentPaths);
             return {
                 resolve: {
                     alias: {
@@ -138,8 +128,8 @@ function pluginContentPages(context, options) {
                 module: {
                     rules: [
                         {
-                            test: /(\.mdx?)$/,
-                            include: getContentPathList(contentPaths)
+                            test: /\.mdx?$/i,
+                            include: contentDirs
                                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                                 .map(utils_1.addTrailingPathSeparator),
                             use: [
@@ -151,17 +141,15 @@ function pluginContentPages(context, options) {
                                         rehypePlugins,
                                         beforeDefaultRehypePlugins,
                                         beforeDefaultRemarkPlugins,
-                                        staticDir: path_1.default.join(siteDir, constants_1.STATIC_DIR_NAME),
-                                        // Note that metadataPath must be the same/in-sync as
-                                        // the path from createData for each MDX.
+                                        staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
+                                        siteDir,
+                                        isMDXPartial: (0, utils_1.createAbsoluteFilePathMatcher)(options.exclude, contentDirs),
                                         metadataPath: (mdxPath) => {
-                                            if (excludeRegex.test(slash_1.default(mdxPath))) {
-                                                return null;
-                                            }
-                                            const aliasedSource = utils_1.aliasedSitePath(mdxPath, siteDir);
-                                            return path_1.default.join(dataDir, `${utils_1.docuHash(aliasedSource)}.json`);
+                                            // Note that metadataPath must be the same/in-sync as
+                                            // the path from createData for each MDX.
+                                            const aliasedSource = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
+                                            return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedSource)}.json`);
                                         },
-                                        forbidFrontMatter: (mdxPath) => excludeRegex.test(slash_1.default(mdxPath)),
                                     },
                                 },
                                 {
@@ -180,8 +168,5 @@ function pluginContentPages(context, options) {
     };
 }
 exports.default = pluginContentPages;
-function validateOptions({ validate, options, }) {
-    const validatedOptions = validate(pluginOptionSchema_1.PluginOptionSchema, options);
-    return validatedOptions;
-}
-exports.validateOptions = validateOptions;
+var options_1 = require("./options");
+Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/markdownLoader.d.ts

@@ -4,9 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference types="node" />
-interface Loader extends Function {
-    (this: any, source: string): string | Buffer | void | undefined;
-}
-declare const markdownLoader: Loader;
-export default markdownLoader;
+import type { LoaderContext } from 'webpack';
+export default function markdownLoader(this: LoaderContext<undefined>, fileString: string): void;

package/lib/markdownLoader.js

@@ -6,11 +6,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const markdownLoader = function (fileString) {
+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);
-};
+    return callback?.(null, fileString);
+}
 exports.default = markdownLoader;

package/lib/options.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 { PluginOptions, Options } from '@docusaurus/plugin-content-pages';
+import type { OptionValidationContext } from '@docusaurus/types';
+export declare const DEFAULT_OPTIONS: PluginOptions;
+export declare function validateOptions({ validate, options, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;

package/lib/{pluginOptionSchema.js → options.js}

@@ -1,24 +1,27 @@
 "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.PluginOptionSchema = exports.DEFAULT_OPTIONS = void 0;
+exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
+const utils_1 = require("@docusaurus/utils");
 exports.DEFAULT_OPTIONS = {
     path: 'src/pages',
     routeBasePath: '/',
     include: ['**/*.{js,jsx,ts,tsx,md,mdx}'],
+    exclude: utils_1.GlobExcludeDefault,
     mdxPageComponent: '@theme/MDXPage',
     remarkPlugins: [],
     rehypePlugins: [],
     beforeDefaultRehypePlugins: [],
     beforeDefaultRemarkPlugins: [],
     admonitions: {},
-    exclude: [
-        '**/_*.{js,jsx,ts,tsx,md,mdx}',
-        '**/*.test.{js,ts}',
-        '**/__tests__/**',
-    ],
 };
-exports.PluginOptionSchema = utils_validation_1.Joi.object({
+const PluginOptionSchema = utils_validation_1.Joi.object({
     path: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.path),
     routeBasePath: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.routeBasePath),
     include: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()).default(exports.DEFAULT_OPTIONS.include),
@@ -30,3 +33,8 @@ exports.PluginOptionSchema = utils_validation_1.Joi.object({
     beforeDefaultRemarkPlugins: utils_validation_1.RemarkPluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRemarkPlugins),
     admonitions: utils_validation_1.AdmonitionsSchema.default(exports.DEFAULT_OPTIONS.admonitions),
 });
+function validateOptions({ validate, options, }) {
+    const validatedOptions = validate(PluginOptionSchema, options);
+    return validatedOptions;
+}
+exports.validateOptions = validateOptions;

package/lib/types.d.ts

@@ -4,28 +4,6 @@
  * 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 interface PluginOptions extends 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;
-export declare type LoadedContent = Metadata[];
 export declare type PagesContentPaths = {
     contentPath: string;
     contentPathLocalized: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.20",
   "description": "Pages plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-pages.d.ts",
@@ -18,25 +18,24 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.2",
-    "@docusaurus/mdx-loader": "2.0.0-beta.2",
-    "@docusaurus/types": "2.0.0-beta.2",
-    "@docusaurus/utils": "2.0.0-beta.2",
-    "@docusaurus/utils-validation": "2.0.0-beta.2",
-    "globby": "^11.0.2",
-    "lodash": "^4.17.20",
-    "minimatch": "^3.0.4",
+    "@docusaurus/core": "2.0.0-beta.20",
+    "@docusaurus/mdx-loader": "2.0.0-beta.20",
+    "@docusaurus/utils": "2.0.0-beta.20",
+    "@docusaurus/utils-validation": "2.0.0-beta.20",
+    "fs-extra": "^10.1.0",
     "remark-admonitions": "^1.2.1",
-    "slash": "^3.0.0",
-    "tslib": "^2.1.0",
-    "webpack": "^5.40.0"
+    "tslib": "^2.4.0",
+    "webpack": "^5.72.0"
+  },
+  "devDependencies": {
+    "@docusaurus/types": "2.0.0-beta.20"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14"
   },
-  "gitHead": "883f07fddffaf1657407c8e202e370cc436e25f7"
+  "gitHead": "ed5cdba401a5948e187e927039b142a0decc702d"
 }

package/{types.d.ts → src/deps.d.ts}

@@ -6,7 +6,7 @@
  */
 
 declare module 'remark-admonitions' {
-  type Options = Record<string, unknown>;
+  type Options = {[key: string]: unknown};
 
   const plugin: (options?: Options) => void;
   export = plugin;

package/src/frontMatter.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: {
+  [key: string]: unknown;
+}): FrontMatter {
+  return validateFrontMatter(frontMatter, PageFrontMatterSchema);
+}