npm - @docusaurus/plugin-content-pages - Versions diffs - 2.0.0-beta.ff31de0ff → 2.0.1 - Mend

@docusaurus/plugin-content-pages 2.0.0-beta.ff31de0ff → 2.0.1

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.

Files changed (35) hide show

package/{src/__tests__/__fixtures__/website/i18n/fr/docusaurus-plugin-content-pages/hello/translatedJs.js → lib/frontMatter.d.ts} +4 -8
package/lib/frontMatter.js +21 -0
package/lib/index.d.ts +4 -3
package/lib/index.js +45 -67
package/lib/markdownLoader.d.ts +2 -6
package/lib/markdownLoader.js +4 -4
package/lib/options.d.ts +10 -0
package/lib/{pluginOptionSchema.js → options.js} +16 -8
package/lib/types.d.ts +0 -22
package/package.json +14 -15
package/src/frontMatter.ts +27 -0
package/src/index.ts +57 -90
package/src/markdownLoader.ts +8 -11
package/src/{pluginOptionSchema.ts → options.ts} +15 -8
package/src/plugin-content-pages.d.ts +59 -18
package/src/types.ts +0 -28
package/lib/.tsbuildinfo +0 -4349
package/lib/pluginOptionSchema.d.ts +0 -10
package/src/__tests__/__fixtures__/website/docusaurus.config.js +0 -14
package/src/__tests__/__fixtures__/website/i18n/fr/docusaurus-plugin-content-pages/hello/translatedMd.md +0 -1
package/src/__tests__/__fixtures__/website/src/pages/hello/_ignore.js +0 -1
package/src/__tests__/__fixtures__/website/src/pages/hello/_ignore.md +0 -1
package/src/__tests__/__fixtures__/website/src/pages/hello/_ignore.mdx +0 -1
package/src/__tests__/__fixtures__/website/src/pages/hello/_ignore.tsx +0 -1
package/src/__tests__/__fixtures__/website/src/pages/hello/index.md +0 -2
package/src/__tests__/__fixtures__/website/src/pages/hello/mdxPage.mdx +0 -5
package/src/__tests__/__fixtures__/website/src/pages/hello/translatedJs.js +0 -14
package/src/__tests__/__fixtures__/website/src/pages/hello/translatedMd.md +0 -1
package/src/__tests__/__fixtures__/website/src/pages/hello/world.js +0 -22
package/src/__tests__/__fixtures__/website/src/pages/index.js +0 -23
package/src/__tests__/__fixtures__/website/src/pages/typescript.tsx +0 -22
package/src/__tests__/index.test.ts +0 -139
package/src/__tests__/pluginOptionSchema.test.ts +0 -54
package/tsconfig.json +0 -9
package/types.d.ts +0 -13

package/lib/pluginOptionSchema.d.ts DELETED Viewed

@@ -1,10 +0,0 @@
-/**
- * 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 { PluginOptions } from './types';
-import { Joi } from '@docusaurus/utils-validation';
-export declare const DEFAULT_OPTIONS: PluginOptions;
-export declare const PluginOptionSchema: Joi.ObjectSchema<any>;

package/src/__tests__/__fixtures__/website/docusaurus.config.js DELETED Viewed

@@ -1,14 +0,0 @@
-/**
- * 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.
- */
-module.exports = {
-  title: 'My Site',
-  tagline: 'The tagline of my site',
-  url: 'https://your-docusaurus-test-site.com',
-  baseUrl: '/',
-  favicon: 'img/favicon.ico',
-};

package/src/__tests__/__fixtures__/website/i18n/fr/docusaurus-plugin-content-pages/hello/translatedMd.md DELETED Viewed

	@@ -1 +0,0 @@
1	- translated markdown page (fr)

package/src/__tests__/__fixtures__/website/src/pages/hello/_ignore.js DELETED Viewed

	@@ -1 +0,0 @@
1	- export default (a,b)=>a+b

package/src/__tests__/__fixtures__/website/src/pages/hello/_ignore.md DELETED Viewed

	@@ -1 +0,0 @@
1	- # ignored

package/src/__tests__/__fixtures__/website/src/pages/hello/_ignore.mdx DELETED Viewed

	@@ -1 +0,0 @@
1	- # ignored

package/src/__tests__/__fixtures__/website/src/pages/hello/_ignore.tsx DELETED Viewed

	@@ -1 +0,0 @@
1	- export default (a:number,b:number)=>a+b;

package/src/__tests__/__fixtures__/website/src/pages/hello/index.md DELETED Viewed

	@@ -1,2 +0,0 @@
1	-
2	- Markdown index page

package/src/__tests__/__fixtures__/website/src/pages/hello/mdxPage.mdx DELETED Viewed

@@ -1,5 +0,0 @@
----
-title: mdx page
-description: my mdx page
----
-MDX page

package/src/__tests__/__fixtures__/website/src/pages/hello/translatedJs.js DELETED Viewed

@@ -1,14 +0,0 @@
-/**
- * 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';
-export default class TranslatedJs extends React.Component {
-  render() {
-    return <div>TranslatedJsPage</div>;
-  }
-}

package/src/__tests__/__fixtures__/website/src/pages/hello/translatedMd.md DELETED Viewed

	@@ -1 +0,0 @@
1	- translated markdown page

package/src/__tests__/__fixtures__/website/src/pages/hello/world.js DELETED Viewed

@@ -1,22 +0,0 @@
-/**
- * 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 Head from '@docusaurus/Head';
-export default class World extends React.Component {
-  render() {
-    return (
-      <div>
-        <Head>
-          <title>World</title>
-        </Head>
-        <div>Hello World </div>
-      </div>
-    );
-  }
-}

package/src/__tests__/__fixtures__/website/src/pages/index.js DELETED Viewed

@@ -1,23 +0,0 @@
-/**
- * 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 Head from '@docusaurus/Head';
-export default class Home extends React.Component {
-  render() {
-    return (
-      <div>
-        <Head>
-          <title>Home</title>
-          <link rel="stylesheet" type="text/css" href="/css/basic.css" />
-        </Head>
-        <div>Home ... </div>
-      </div>
-    );
-  }
-}

package/src/__tests__/__fixtures__/website/src/pages/typescript.tsx DELETED Viewed

@@ -1,22 +0,0 @@
-/**
- * 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 Head from '@docusaurus/Head';
-export default class Home extends React.Component {
-  render() {
-    return (
-      <div>
-        <Head>
-          <title>Hello</title>
-        </Head>
-        <div>TypeScript...</div>
-      </div>
-    );
-  }
-}

package/src/__tests__/index.test.ts DELETED Viewed

@@ -1,139 +0,0 @@
-/**
- * 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 path from 'path';
-import {loadContext} from '@docusaurus/core/lib/server';
-import pluginContentPages from '../index';
-import normalizePluginOptions from './pluginOptionSchema.test';
-describe('docusaurus-plugin-content-pages', () => {
-  test('simple pages', async () => {
-    const siteDir = path.join(__dirname, '__fixtures__', 'website');
-    const context = await loadContext(siteDir);
-    const pluginPath = 'src/pages';
-    const plugin = pluginContentPages(
-      context,
-      normalizePluginOptions({
-        path: pluginPath,
-      }),
-    );
-    const pagesMetadatas = await plugin.loadContent?.();
-    expect(pagesMetadatas).toEqual([
-      {
-        type: 'jsx',
-        permalink: '/',
-        source: path.posix.join('@site', pluginPath, 'index.js'),
-      },
-      {
-        type: 'jsx',
-        permalink: '/typescript',
-        source: path.posix.join('@site', pluginPath, 'typescript.tsx'),
-      },
-      {
-        type: 'mdx',
-        permalink: '/hello/',
-        source: path.posix.join('@site', pluginPath, 'hello', 'index.md'),
-      },
-      {
-        type: 'mdx',
-        permalink: '/hello/mdxPage',
-        source: path.posix.join('@site', pluginPath, 'hello', 'mdxPage.mdx'),
-      },
-      {
-        type: 'jsx',
-        permalink: '/hello/translatedJs',
-        source: path.posix.join(
-          '@site',
-          pluginPath,
-          'hello',
-          'translatedJs.js',
-        ),
-      },
-      {
-        type: 'mdx',
-        permalink: '/hello/translatedMd',
-        source: path.posix.join(
-          '@site',
-          pluginPath,
-          'hello',
-          'translatedMd.md',
-        ),
-      },
-      {
-        type: 'jsx',
-        permalink: '/hello/world',
-        source: path.posix.join('@site', pluginPath, 'hello', 'world.js'),
-      },
-    ]);
-  });
-  test('simple pages with french translations', async () => {
-    const siteDir = path.join(__dirname, '__fixtures__', 'website');
-    const context = await loadContext(siteDir);
-    const pluginPath = 'src/pages';
-    const plugin = pluginContentPages(
-      {
-        ...context,
-        i18n: {
-          ...context.i18n,
-          currentLocale: 'fr',
-        },
-      },
-      normalizePluginOptions({
-        path: pluginPath,
-      }),
-    );
-    const pagesMetadatas = await plugin.loadContent?.();
-    const frTranslationsPath = path.posix.join(
-      '@site',
-      'i18n',
-      'fr',
-      'docusaurus-plugin-content-pages',
-    );
-    expect(pagesMetadatas).toEqual([
-      {
-        type: 'jsx',
-        permalink: '/',
-        source: path.posix.join('@site', pluginPath, 'index.js'),
-      },
-      {
-        type: 'jsx',
-        permalink: '/typescript',
-        source: path.posix.join('@site', pluginPath, 'typescript.tsx'),
-      },
-      {
-        type: 'mdx',
-        permalink: '/hello/',
-        source: path.posix.join('@site', pluginPath, 'hello', 'index.md'),
-      },
-      {
-        type: 'mdx',
-        permalink: '/hello/mdxPage',
-        source: path.posix.join('@site', pluginPath, 'hello', 'mdxPage.mdx'),
-      },
-      {
-        type: 'jsx',
-        permalink: '/hello/translatedJs',
-        source: path.posix.join(frTranslationsPath, 'hello', 'translatedJs.js'),
-      },
-      {
-        type: 'mdx',
-        permalink: '/hello/translatedMd',
-        source: path.posix.join(frTranslationsPath, 'hello', 'translatedMd.md'),
-      },
-      {
-        type: 'jsx',
-        permalink: '/hello/world',
-        source: path.posix.join('@site', pluginPath, 'hello', 'world.js'),
-      },
-    ]);
-  });
-});

package/src/__tests__/pluginOptionSchema.test.ts DELETED Viewed

@@ -1,54 +0,0 @@
-/**
- * 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 {PluginOptionSchema, DEFAULT_OPTIONS} from '../pluginOptionSchema';
-import {PluginOptions} from '../types';
-export default function normalizePluginOptions(
-  options: Partial<PluginOptions>,
-): PluginOptions {
-  const {value, error} = PluginOptionSchema.validate(options, {
-    convert: false,
-  });
-  if (error) {
-    throw error;
-  } else {
-    return value;
-  }
-}
-describe('normalizePagesPluginOptions', () => {
-  test('should return default options for undefined user options', () => {
-    const value = normalizePluginOptions({});
-    expect(value).toEqual(DEFAULT_OPTIONS);
-  });
-  test('should fill in default options for partially defined user options', () => {
-    const value = normalizePluginOptions({path: 'src/pages'});
-    expect(value).toEqual(DEFAULT_OPTIONS);
-  });
-  test('should accept correctly defined user options', () => {
-    const userOptions = {
-      path: 'src/my-pages',
-      routeBasePath: 'my-pages',
-      include: ['**/*.{js,jsx,ts,tsx}'],
-      exclude: ['**/$*/'],
-    };
-    const value = normalizePluginOptions(userOptions);
-    expect(value).toEqual({...DEFAULT_OPTIONS, ...userOptions});
-  });
-  test('should reject bad path inputs', () => {
-    expect(() => {
-      normalizePluginOptions({
-        // @ts-expect-error: bad attribute
-        path: 42,
-      });
-    }).toThrowErrorMatchingInlineSnapshot(`"\\"path\\" must be a string"`);
-  });
-});

package/tsconfig.json DELETED Viewed

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

package/types.d.ts DELETED Viewed

@@ -1,13 +0,0 @@
-/**
- * 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.
- */
-declare module 'remark-admonitions' {
-  type Options = Record<string, unknown>;
-  const plugin: (options?: Options) => void;
-  export = plugin;
-}