@graphql-markdown/docusaurus 1.14.0 → 1.15.1

package/src/lib/renderer.js

@@ -1,150 +0,0 @@
-const path = require("path");
-
-const { convertArrayToObject } = require("../utils/scalars/array");
-const { hasProperty } = require("../utils/scalars/object");
-const { toSlug, startCase } = require("../utils/scalars/string");
-const { pathUrl } = require("../utils/scalars/url");
-const {
-  hasPrettierModule,
-  prettifyJavascript,
-  prettifyMarkdown,
-} = require("../utils/helpers/prettier");
-const {
-  saveFile,
-  ensureDir,
-  copyFile,
-  readFile,
-  fileExists,
-} = require("../utils/helpers/fs");
-
-const { ASSETS_LOCATION } = require("../config");
-const { schemaSidebar } = require(`${ASSETS_LOCATION}/sidebar.json`);
-
-const SIDEBAR = "sidebar-schema.js";
-const HOMEPAGE_ID = "schema";
-const CATEGORY_YAML = "_category_.yml";
-
-module.exports = class Renderer {
-  constructor(printer, outputDir, baseURL, group, prettify, docOptions) {
-    this.group = group;
-    this.outputDir = outputDir;
-    this.baseURL = baseURL;
-    this.printer = printer;
-    this.prettify = prettify && hasPrettierModule();
-    this.options = docOptions;
-  }
-
-  async generateCategoryMetafile(category, dirPath) {
-    const filePath = path.join(dirPath, CATEGORY_YAML);
-
-    if (await fileExists(filePath)) {
-      return;
-    }
-
-    await ensureDir(dirPath);
-
-    const label = startCase(category);
-    const link =
-      typeof this.options === "undefined" || !this.options.index
-        ? "null"
-        : `\n  type: generated-index\n  title: '${label} overview'\n`;
-
-    await saveFile(filePath, `label: ${label}\nlink: ${link}\n`);
-  }
-
-  async renderRootTypes(rootTypeName, type) {
-    if (typeof type === "undefined" || type === null) {
-      return undefined;
-    }
-
-    if (Array.isArray(type)) {
-      type = convertArrayToObject(type);
-    }
-
-    return Promise.all(
-      Object.keys(type).map(async (name) => {
-        let dirPath = this.outputDir;
-
-        if (hasProperty(this.group, name)) {
-          dirPath = path.join(dirPath, toSlug(this.group[name]));
-          await this.generateCategoryMetafile(this.group[name], dirPath);
-        }
-
-        dirPath = path.join(dirPath, toSlug(rootTypeName));
-        await this.generateCategoryMetafile(rootTypeName, dirPath);
-
-        return this.renderTypeEntities(dirPath, name, type[name]);
-      }),
-    );
-  }
-
-  async renderTypeEntities(dirPath, name, type) {
-    if (typeof type === "undefined" || type === null) {
-      return undefined;
-    }
-
-    const fileName = toSlug(name);
-    const filePath = path.join(path.normalize(dirPath), `${fileName}.mdx`);
-
-    const content = this.printer.printType(fileName, type, this.options);
-    await saveFile(
-      filePath,
-      this.prettify ? prettifyMarkdown(content) : content,
-    );
-
-    const pagePath = path.relative(this.outputDir, filePath);
-    const page = pagePath.match(
-      /(?<category>[A-Za-z0-9-]+)[\\/]+(?<pageId>[A-Za-z0-9-]+).mdx?$/,
-    );
-    const slug = pathUrl.join(page.groups.category, page.groups.pageId);
-
-    return { category: startCase(page.groups.category), slug: slug };
-  }
-
-  async renderSidebar() {
-    const sidebar = {
-      schemaSidebar: schemaSidebar.map((entry) => {
-        switch (entry.type) {
-          case "doc":
-            entry.id = pathUrl.join(this.baseURL, HOMEPAGE_ID);
-            break;
-          case "autogenerated":
-            entry.dirName = this.baseURL;
-            break;
-          default: //do nothing
-        }
-        return entry;
-      }),
-    };
-
-    const jsonSidebar = `
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-
-module.exports = ${JSON.stringify(sidebar, null, 2)};
-`;
-
-    const filePath = path.join(this.outputDir, SIDEBAR);
-    await saveFile(
-      filePath,
-      this.prettify ? prettifyJavascript(jsonSidebar) : jsonSidebar,
-    );
-
-    return path.relative("./", filePath);
-  }
-
-  async renderHomepage(homepageLocation) {
-    const homePage = path.basename(homepageLocation);
-    const destLocation = path.join(this.outputDir, homePage);
-    const slug = pathUrl.resolve("/", this.baseURL);
-
-    await copyFile(homepageLocation, destLocation);
-
-    const template = await readFile(destLocation);
-
-    const data = template
-      .toString()
-      .replace(/##baseURL##/gm, slug)
-      .replace(/##generated-date-time##/gm, new Date().toLocaleString());
-    await saveFile(destLocation, data);
-  }
-};

package/src/utils/helpers/fs.js

@@ -1,33 +0,0 @@
-const { promises: fs } = require("fs");
-const { dirname } = require("path");
-
-const readFile = fs.readFile;
-const copyFile = fs.copyFile;
-
-async function ensureDir(dirPath) {
-  if (!(await fileExists(dirPath))) {
-    await fs.mkdir(dirPath, { recursive: true });
-  }
-}
-
-async function fileExists(filePath) {
-  try {
-    await fs.stat(filePath);
-    return true;
-  } catch (error) {
-    return false;
-  }
-}
-
-async function saveFile(filePath, data) {
-  await ensureDir(dirname(filePath));
-  await fs.writeFile(filePath, data);
-}
-
-module.exports = {
-  copyFile,
-  ensureDir,
-  fileExists,
-  readFile,
-  saveFile,
-};

package/src/utils/helpers/prettier.js

@@ -1,29 +0,0 @@
-/* istanbul ignore file */
-let prettier;
-
-try {
-  prettier = require("prettier");
-} catch (e) {
-  console.debug("Prettier is not found");
-}
-
-function hasPrettierModule() {
-  return typeof prettier !== "undefined";
-}
-
-function prettify(content, parser) {
-  if (!hasPrettierModule()) {
-    return content;
-  }
-  return prettier.format(content, { parser });
-}
-
-function prettifyMarkdown(content) {
-  return prettify(content, "markdown");
-}
-
-function prettifyJavascript(content) {
-  return prettify(content, "babel");
-}
-
-module.exports = { hasPrettierModule, prettifyMarkdown, prettifyJavascript };

package/src/utils/scalars/array.js

@@ -1,18 +0,0 @@
-/**
- * Array functions
- */
-
-function toArray(param) {
-  if (param && typeof param === "object")
-    return Object.keys(param).map((key) => param[key]);
-  return undefined;
-}
-
-function convertArrayToObject(typeArray) {
-  return typeArray.reduce(function (r, o) {
-    if (o && o.name) r[o.name] = o;
-    return r;
-  }, {});
-}
-
-module.exports = { toArray, convertArrayToObject };

package/src/utils/scalars/object.js

@@ -1,16 +0,0 @@
-/**
- * Object functions
- */
-
-function hasProperty(obj, prop) {
-  return (
-    !!(obj && obj[prop]) ||
-    (obj instanceof Object && Object.prototype.hasOwnProperty.call(obj, prop))
-  );
-}
-
-function hasMethod(obj, prop) {
-  return hasProperty(obj, prop) && typeof obj[prop] === "function";
-}
-
-module.exports = { hasMethod, hasProperty };

package/src/utils/scalars/string.js

@@ -1,86 +0,0 @@
-/**
- * String functions
- */
-
-function stringCaseBuilder(str, transformation, separator) {
-  const hasTransformation = typeof transformation === "function";
-  const stringCase = replaceDiacritics(str)
-    .replace(/([a-z]+|\d+)([A-Z])/g, "$1 $2")
-    .replace(/([a-z]+)(\d)/g, "$1 $2")
-    .replace(/(\d+)([a-z])/g, "$1 $2")
-    .split(/[^0-9A-Za-z]+/g)
-    .map((word) => (hasTransformation ? transformation(word) : word))
-    .join(separator);
-  return prune(stringCase, separator);
-}
-
-function prune(str, char) {
-  let res = str;
-
-  if (res[0] === char) {
-    // Remove first character
-    res = res.slice(1);
-  }
-
-  if (res[res.length - 1] === char) {
-    // Remove last character
-    res = res.slice(0, -1);
-  }
-
-  return res;
-}
-
-function toSlug(str) {
-  return kebabCase(str);
-}
-
-function toHTMLUnicode(char) {
-  const unicodeChar = char.charCodeAt(0).toString(16).padStart(4, "0");
-  return `&#x${unicodeChar.toUpperCase()};`;
-}
-
-function escapeMDX(str) {
-  if (typeof str === "string") {
-    return str.replace(/[<>{}]/g, toHTMLUnicode);
-  }
-  return str;
-}
-
-function firstUppercase(word) {
-  const sliceUppercase = word.slice(0, 1).toUpperCase();
-  const sliceDefaultCase = word.slice(1);
-  return `${sliceUppercase}${sliceDefaultCase}`;
-}
-
-function capitalize(word) {
-  return firstUppercase(word.toLowerCase());
-}
-
-// from https://stackoverflow.com/a/37511463
-function replaceDiacritics(str) {
-  return str
-    .toString()
-    .normalize("NFD")
-    .replace(/[\u0300-\u036f]/g, "");
-}
-
-function startCase(str) {
-  return stringCaseBuilder(str, firstUppercase, " ");
-}
-
-function kebabCase(str) {
-  return stringCaseBuilder(str, (word) => word.toLowerCase(), "-");
-}
-
-module.exports = {
-  capitalize,
-  escapeMDX,
-  firstUppercase,
-  kebabCase,
-  prune,
-  replaceDiacritics,
-  startCase,
-  stringCaseBuilder,
-  toHTMLUnicode,
-  toSlug,
-};

package/src/utils/scalars/url.js

@@ -1,8 +0,0 @@
-/* istanbul ignore file */
-/**
- * Path functions
- */
-
-const pathUrl = require("path").posix;
-
-module.exports = { pathUrl };