feat: showcase

admin/scripts/showcaseCheck.js

@@ -0,0 +1,62 @@
+/**
+ * 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 fs from 'fs-extra';
+import path from 'path';
+import yaml from 'js-yaml';
+import {load} from 'cheerio';
+
+async function parseFiles(directoryPath) {
+  try {
+    const files = await fs.promises.readdir(directoryPath);
+
+    for (const file of files) {
+      const filePath = path.join(directoryPath, file);
+      const stat = await fs.promises.stat(filePath);
+
+      if (stat.isDirectory()) {
+        await parseFiles(filePath); // Recursively process subdirectories
+      } else {
+        await processYamlFile(filePath); // Process individual YAML file
+      }
+    }
+  } catch (err) {
+    console.error('Error reading directory:', err);
+  }
+}
+async function processYamlFile(filePath) {
+  const data = await fs.promises.readFile(filePath, 'utf8');
+  const {website} = yaml.load(data);
+
+  try {
+    const html = await fetchWebsiteHtml(website);
+    const $ = load(html);
+    const generatorMeta = $('meta[name="generator"]');
+
+    if (generatorMeta.length === 0) {
+      console.log(`Website ${website} is not a Docusaurus site.`);
+    }
+  } catch (error) {
+    console.error(`Error fetching website ${website}:`, error.message);
+  }
+}
+
+async function fetchWebsiteHtml(url) {
+  const response = await fetch(url, {
+    headers: {
+      'Accept-Encoding': 'gzip, deflate',
+    },
+  });
+
+  if (!response.ok) {
+    throw new Error(`Failed to fetch ${url}: ${response.statusText}`);
+  }
+
+  return response.text();
+}
+
+// processYamlFiles('../../website/showcase');
+parseFiles('./admin/scripts/showcase');

packages/docusaurus-plugin-content-showcase/.npmignore

@@ -0,0 +1,3 @@
+.tsbuildinfo*
+tsconfig*
+__tests__

packages/docusaurus-plugin-content-showcase/README.md

@@ -0,0 +1,7 @@
+# `@docusaurus/plugin-content-showcase`
+
+Showcase plugin for Docusaurus.
+
+## Usage
+
+See [plugin-content-showcase documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-showcase).

packages/docusaurus-plugin-content-showcase/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@docusaurus/plugin-content-showcase",
+  "version": "3.3.2",
+  "description": "Showcase plugin for Docusaurus.",
+  "main": "lib/index.js",
+  "sideEffects": false,
+  "exports": {
+    "./lib/*": "./lib/*",
+    "./src/*": "./src/*",
+    "./client": {
+      "type": "./lib/client/index.d.ts",
+      "default": "./lib/client/index.js"
+    },
+    ".": {
+      "types": "./src/plugin-content-showcase.d.ts",
+      "default": "./lib/index.js"
+    }
+  },
+  "types": "src/plugin-content-showcase.d.ts",
+  "scripts": {
+    "build": "tsc --build",
+    "watch": "tsc --build --watch"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-content-showcase"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@docusaurus/core": "3.3.2",
+    "@docusaurus/types": "3.3.2",
+    "@docusaurus/utils": "3.3.2",
+    "@docusaurus/utils-validation": "3.3.2",
+    "@docusaurus/theme-common": "3.3.2",
+    "fs-extra": "^11.1.1",
+    "js-yaml": "^4.1.0",
+    "tslib": "^2.6.0",
+    "webpack": "^5.88.1"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "engines": {
+    "node": ">=18.0"
+  }
+}

packages/docusaurus-plugin-content-showcase/src/__tests__/__snapshots__/index.test.ts.snap

@@ -0,0 +1,37 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`docusaurus-plugin-content-showcase loads simple showcase 1`] = `
+{
+  "items": [
+    {
+      "description": "World",
+      "preview": "github.com/ozakione.png",
+      "source": "https://github.com/facebook/docusaurus",
+      "tags": [
+        "opensource",
+        "meta",
+      ],
+      "title": "Hello",
+      "website": "https://docusaurus.io/",
+    },
+  ],
+}
+`;
+
+exports[`docusaurus-plugin-content-showcase loads simple showcase with tags in options 1`] = `
+{
+  "items": [
+    {
+      "description": "World",
+      "preview": "github.com/ozakione.png",
+      "source": "https://github.com/facebook/docusaurus",
+      "tags": [
+        "opensource",
+        "meta",
+      ],
+      "title": "Hello",
+      "website": "https://docusaurus.io/",
+    },
+  ],
+}
+`;

packages/docusaurus-plugin-content-showcase/src/__tests__/index.test.ts

@@ -0,0 +1,88 @@
+/**
+ * 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/src/server/site';
+import {normalizePluginOptions} from '@docusaurus/utils-validation';
+import {fromPartial} from '@total-typescript/shoehorn';
+import pluginContentShowcase from '../index';
+import {validateOptions} from '../options';
+import type {PluginOptions} from '@docusaurus/plugin-content-showcase';
+
+const loadPluginContent = async (siteDir: string, options: PluginOptions) => {
+  const context = await loadContext({siteDir});
+  const plugin = await pluginContentShowcase(
+    context,
+    validateOptions({
+      validate: normalizePluginOptions,
+      options,
+    }),
+  );
+  return plugin.loadContent!();
+};
+
+describe('docusaurus-plugin-content-showcase', () => {
+  it('loads simple showcase', async () => {
+    const siteDir = path.join(__dirname, '__fixtures__', 'website');
+    const showcaseMetadata = await loadPluginContent(
+      siteDir,
+      fromPartial({
+        path: 'src/showcase',
+        tags: 'tags.yaml',
+      }),
+    );
+
+    expect(showcaseMetadata).toMatchSnapshot();
+  });
+
+  it('loads simple showcase with tags in options', async () => {
+    const tags = {
+      opensource: {
+        label: 'Open-Source',
+        description: {
+          message:
+            'Open-Source Docusaurus sites can be useful for inspiration!',
+          id: 'showcase.tag.opensource.description',
+        },
+        color: '#39ca30',
+      },
+      meta: {
+        label: 'Meta',
+        description: {
+          message: 'Docusaurus sites of Meta (formerly Facebook) projects',
+          id: 'showcase.tag.meta.description',
+        },
+        color: '#4267b2',
+      },
+    };
+    const siteDir = path.join(__dirname, '__fixtures__', 'website');
+    const showcaseMetadata = await loadPluginContent(
+      siteDir,
+      fromPartial({
+        path: 'src/showcase',
+        tags,
+      }),
+    );
+
+    expect(showcaseMetadata).toMatchSnapshot();
+  });
+
+  it('throw loading inexistant tags file', async () => {
+    const siteDir = path.join(__dirname, '__fixtures__', 'website');
+    await expect(async () => {
+      await loadPluginContent(
+        siteDir,
+        fromPartial({
+          path: 'src/showcase',
+          tags: 'wrong.yaml',
+        }),
+      );
+    }).rejects.toThrowErrorMatchingInlineSnapshot(
+      `"Failed to read tags file for showcase"`,
+    );
+  });
+});