@docfy/ember 0.9.0 → 0.10.0

package/lib/plugins/extract-demos-to-components.js

@@ -1,149 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const unist_util_visit_1 = __importDefault(require("unist-util-visit"));
-const plugin_1 = __importDefault(require("@docfy/core/lib/plugin"));
-const unist_util_find_1 = __importDefault(require("unist-util-find"));
-const mdast_util_to_string_1 = __importDefault(require("mdast-util-to-string"));
-const utils_1 = require("./utils");
-const path_1 = __importDefault(require("path"));
-/*
- * Create the heading for the examples section of the page.
- *
- * It uses the remark stack to make sure any plugins that manage headings can be
- * executed.
- *
- * This is necessary for apps using remark-autolink-headings, for example.
- */
-function createHeading(ctx) {
-    const heading = ctx.remark.runSync(ctx.remark.parse('## Examples')).children[0];
-    heading.depth = 2;
-    return heading;
-}
-const isTextMarker = (node) => node.type === 'paragraph' &&
-    node.children.length === 1 &&
-    node.children[0].type === 'text';
-const demoMarkerRegex = /^\[\[demo:(.+?)\]\]$/;
-const demoMarker = (node) => isTextMarker(node) && demoMarkerRegex.test(node.children[0].value);
-const demosAllMarkerRegex = /^\[\[demos-all\]\]$/;
-const demosAllMarker = (node) => isTextMarker(node) &&
-    demosAllMarkerRegex.test(node.children[0].value);
-/*
- * Insert Demo nodes into the page.
- */
-function insertDemoNodesIntoPage(page, toInsert) {
-    if (Array.isArray(page.ast.children)) {
-        const secondHeading = (0, unist_util_find_1.default)(page.ast, (node) => node.type === 'heading' && node.depth !== 1);
-        if (secondHeading) {
-            const index = page.ast.children.findIndex((el) => el === secondHeading);
-            page.ast.children.splice(index, 0, ...toInsert);
-        }
-        else {
-            page.ast.children.push(...toInsert);
-        }
-    }
-}
-function replaceDemoMarkers(page, demos) {
-    if (Array.isArray(page.ast.children)) {
-        const markers = [];
-        const allMarkers = [];
-        (0, unist_util_visit_1.default)(page.ast, 'paragraph', (node) => {
-            if (demoMarker(node))
-                markers.push(node);
-            if (demosAllMarker(node))
-                allMarkers.push(node);
-        });
-        markers.forEach((marker) => {
-            const child = marker.children[0];
-            const matches = child.value.match(demoMarkerRegex);
-            if (!matches)
-                return;
-            // TODO: This is an inner loop and can cause perf issues if someone
-            // out there has many demos on a single page. It would be better to
-            // create a demo component hash that can be looked up by demo name.
-            const demoName = matches[1];
-            const demo = demos.find((d) => d.name.dashCase.endsWith(demoName));
-            if (!demo) {
-                console.warn(`Found demo marker "${demoName}" with no matching demo component in ${page.source}`);
-                return;
-            }
-            marker.type = 'div';
-            marker.children.splice(0, 1, ...(0, utils_1.createDemoNodes)(demo));
-        });
-        allMarkers.forEach((marker) => {
-            const demoNodes = demos
-                .map((component) => (0, utils_1.createDemoNodes)(component))
-                .flat();
-            marker.type = 'div';
-            marker.children.splice(0, 1, ...demoNodes);
-        });
-    }
-}
-exports.default = (0, plugin_1.default)({
-    runWithMdast(ctx) {
-        const seenNames = new Set();
-        ctx.pages.forEach((page) => {
-            if (page.demos) {
-                const demoComponents = [];
-                page.demos.forEach((demo) => {
-                    const chunks = [];
-                    (0, unist_util_visit_1.default)(demo.ast, 'code', (node) => {
-                        if (['component', 'template', 'styles'].includes(node.meta || '')) {
-                            chunks.push({
-                                snippet: node,
-                                code: node.value.replace(/\\{{/g, '{{'),
-                                ext: (0, utils_1.getExt)(node.lang || (node.meta === 'template' ? 'hbs' : 'js')),
-                                type: node.meta
-                            });
-                        }
-                    });
-                    // 1. exclude extension
-                    // 2. remove /index.md because of web conventions
-                    const baseName = page.source.replace('/index.md', '').split('.')[0];
-                    const componentName = (0, utils_1.generateDemoComponentName)(`docfy-demo-${baseName}-${path_1.default.basename(demo.source).split('.')[0]}`, seenNames);
-                    const demoTitle = (0, unist_util_find_1.default)(demo.ast, (node) => node.type === 'heading' && node.depth === 1);
-                    if (demoTitle) {
-                        demoTitle.depth = 3;
-                        demoTitle.data = Object.assign(Object.assign({}, (demoTitle.data || {})), { id: componentName.dashCase, docfyDelete: true // mark the heading to be deleted by @docfy/core TOC plugin
-                         });
-                    }
-                    demoComponents.push({
-                        name: componentName,
-                        chunks,
-                        description: {
-                            title: demoTitle ? (0, mdast_util_to_string_1.default)(demoTitle) : undefined,
-                            ast: demo.ast,
-                            editUrl: demo.meta.editUrl
-                        }
-                    });
-                    // Delete used code blocks
-                    chunks.forEach(({ snippet }) => {
-                        (0, utils_1.deleteNode)(demo.ast.children, snippet);
-                    });
-                });
-                if (page.meta.frontmatter.manualDemoInsertion) {
-                    // Manual demo insertion inserts demos into markdown files
-                    // wherever there is a demo marker ([[demo:name]] or [[demos-all]])
-                    replaceDemoMarkers(page, demoComponents);
-                }
-                else {
-                    // Automatic demo insertion creates an Example block after
-                    // the first heading.
-                    const toInsert = [createHeading(ctx)];
-                    demoComponents.forEach((component) => {
-                        toInsert.push(...(0, utils_1.createDemoNodes)(component));
-                    });
-                    insertDemoNodesIntoPage(page, toInsert);
-                }
-                if ((0, utils_1.isDemoComponents)(page.pluginData.demoComponents)) {
-                    page.pluginData.demoComponents.push(...demoComponents);
-                }
-                else {
-                    page.pluginData.demoComponents = demoComponents;
-                }
-            }
-        });
-    }
-});

package/lib/plugins/preview-template.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("@docfy/core/lib/types").Plugin<import("@docfy/core/lib/types").PluginOptions | null | undefined>;
-export default _default;

package/lib/plugins/preview-template.js

@@ -1,41 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const unist_util_visit_1 = __importDefault(require("unist-util-visit"));
-const plugin_1 = __importDefault(require("@docfy/core/lib/plugin"));
-const utils_1 = require("./utils");
-const path_1 = __importDefault(require("path"));
-exports.default = (0, plugin_1.default)({
-    runWithMdast(ctx) {
-        const seenNames = new Set();
-        ctx.pages.forEach((page) => {
-            const demoComponents = [];
-            (0, unist_util_visit_1.default)(page.ast, 'code', (node) => {
-                if (['preview-template', 'preview'].includes(node.meta || '')) {
-                    demoComponents.push({
-                        name: (0, utils_1.generateDemoComponentName)(`docfy-demo-preview-${path_1.default.basename(page.meta.url)}`, seenNames),
-                        chunks: [
-                            {
-                                snippet: node,
-                                code: node.value.replace(/\\{{/g, '{{'),
-                                ext: (0, utils_1.getExt)(node.lang || 'hbs'),
-                                type: node.meta
-                            }
-                        ]
-                    });
-                }
-            });
-            demoComponents.forEach((demoComponent) => {
-                (0, utils_1.replaceNode)(page.ast.children, demoComponent.chunks[0].snippet, ...(0, utils_1.createDemoNodes)(demoComponent));
-            });
-            if ((0, utils_1.isDemoComponents)(page.pluginData.demoComponents)) {
-                page.pluginData.demoComponents.push(...demoComponents);
-            }
-            else {
-                page.pluginData.demoComponents = demoComponents;
-            }
-        });
-    }
-});

package/lib/plugins/replace-internal-links-with-docfy-link.d.ts

@@ -1,6 +0,0 @@
-declare const _default: import("@docfy/core/lib/types").Plugin<import("@docfy/core/lib/types").PluginOptions | null | undefined>;
-/**
- * This function finds all the links starting with an `/` and replace them with
- * the `DocfyLink` component.
- */
-export default _default;

package/lib/plugins/replace-internal-links-with-docfy-link.js

@@ -1,44 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const plugin_1 = __importDefault(require("@docfy/core/lib/plugin"));
-const unist_util_visit_1 = __importDefault(require("unist-util-visit"));
-const unist_builder_1 = __importDefault(require("unist-builder"));
-function visitor(page) {
-    (0, unist_util_visit_1.default)(page.ast, 'link', (node, index, parent) => {
-        if (node.url[0] === '/') {
-            const data = node.data || (node.data = {});
-            const props = (data.hProperties || (data.hProperties = {}));
-            const urlParts = node.url.split('#');
-            const attributes = Object.keys(props)
-                .map((key) => {
-                return `${key}=${String(props[key])}`;
-            })
-                .join(' ');
-            const toInsert = [
-                (0, unist_builder_1.default)('html', `<DocfyLink @to="${urlParts[0]}" ${urlParts[1] ? `@anchor="${urlParts[1]}"` : ''} ${attributes}>`),
-                ...node.children,
-                (0, unist_builder_1.default)('html', `</DocfyLink>`)
-            ];
-            parent === null || parent === void 0 ? void 0 : parent.children.splice(index, 1, ...toInsert);
-        }
-    });
-}
-/**
- * This function finds all the links starting with an `/` and replace them with
- * the `DocfyLink` component.
- */
-exports.default = (0, plugin_1.default)({
-    runWithMdast(ctx) {
-        ctx.pages.forEach((page) => {
-            visitor(page);
-            if (Array.isArray(page.demos)) {
-                page.demos.forEach((demo) => {
-                    visitor(demo);
-                });
-            }
-        });
-    }
-});

package/lib/plugins/types.d.ts

@@ -1,29 +0,0 @@
-import { Node } from 'unist';
-interface Literal {
-    value: string;
-}
-export interface CodeNode extends Node, Literal {
-    type: 'code';
-    lang?: string;
-    meta?: string;
-}
-export interface DemoComponent {
-    name: DemoComponentName;
-    chunks: DemoComponentChunk[];
-    description?: {
-        title?: string;
-        ast: Node;
-        editUrl?: string;
-    };
-}
-export interface DemoComponentName {
-    dashCase: string;
-    pascalCase: string;
-}
-export interface DemoComponentChunk {
-    type: string;
-    code: string;
-    ext: string;
-    snippet: Node;
-}
-export {};

package/lib/plugins/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/utils.d.ts

@@ -1,31 +0,0 @@
-import { Node } from 'unist';
-import { DemoComponent, DemoComponentName } from './types';
-/**
- * Creates all the Nodes necessary to render a Demo Component.
- *
- * It will render something like the follwing:
- * ```hbs
- * <DocfyDemo as |demo|>
- *   <demo.Example>
- *     <ComponentName />
- *   </demo.Example>
- *   <demo.Description @title="Heading depth 1" @editUrl="url">
- *     Demo markdown content
- *   </demo.Description>
- *   <demo.Snippets as |Snippet|>
- *     <Snippet @name="component">
- *       Code Snippet (with any highlight applied from remark)
- *     </Snippet>
- *   </demo.Snippets>
- * </DocfyDemo>
- * ```
- */
-export declare function createDemoNodes(component: DemoComponent): Node[];
-export declare function getExt(lang: string): string;
-export declare function deleteNode(nodes: unknown, nodeToDelete: Node | undefined): void;
-export declare function replaceNode(nodes: unknown, nodeToDelete: Node, ...newNodes: Node[]): void;
-export declare function generateDemoComponentName(identifier: string, seenNames: Set<string>, tentativeCount?: number): DemoComponentName;
-/**
- * Checks if a property is of type DemoComponent[]
- */
-export declare function isDemoComponents(components: unknown): components is DemoComponent[];

package/lib/plugins/utils.js

@@ -1,142 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDemoComponents = exports.generateDemoComponentName = exports.replaceNode = exports.deleteNode = exports.getExt = exports.createDemoNodes = void 0;
-const unist_builder_1 = __importDefault(require("unist-builder"));
-/**
- * Creates all the Nodes necessary to render a Demo Component.
- *
- * It will render something like the follwing:
- * ```hbs
- * <DocfyDemo as |demo|>
- *   <demo.Example>
- *     <ComponentName />
- *   </demo.Example>
- *   <demo.Description @title="Heading depth 1" @editUrl="url">
- *     Demo markdown content
- *   </demo.Description>
- *   <demo.Snippets as |Snippet|>
- *     <Snippet @name="component">
- *       Code Snippet (with any highlight applied from remark)
- *     </Snippet>
- *   </demo.Snippets>
- * </DocfyDemo>
- * ```
- */
-function createDemoNodes(component) {
-    const nodes = [
-        (0, unist_builder_1.default)('html', `<DocfyDemo @id="${component.name.dashCase}" as |demo|>`)
-    ];
-    if (component.description) {
-        nodes.push((0, unist_builder_1.default)('html', `<demo.Description
-          ${component.description.title
-            ? `@title="${component.description.title}" `
-            : ''}${component.description.editUrl
-            ? `@editUrl="${component.description.editUrl}"`
-            : ''}>`), component.description.ast, (0, unist_builder_1.default)('html', '</demo.Description>'));
-    }
-    nodes.push((0, unist_builder_1.default)('html', '<demo.Example>'), (0, unist_builder_1.default)('html', `<${component.name.pascalCase} />`), (0, unist_builder_1.default)('html', '</demo.Example>'));
-    if (component.chunks.length > 1) {
-        nodes.push((0, unist_builder_1.default)('html', '<demo.Snippets as |Snippet|>'));
-        component.chunks.forEach((chunk) => {
-            nodes.push((0, unist_builder_1.default)('html', `<Snippet @name="${chunk.type}">`), chunk.snippet, (0, unist_builder_1.default)('html', '</Snippet>'));
-        });
-        nodes.push((0, unist_builder_1.default)('html', '</demo.Snippets>'));
-    }
-    else {
-        component.chunks.forEach((chunk) => {
-            nodes.push((0, unist_builder_1.default)('html', `<demo.Snippet @name="${chunk.type}">`), chunk.snippet, (0, unist_builder_1.default)('html', '</demo.Snippet>'));
-        });
-    }
-    nodes.push((0, unist_builder_1.default)('html', '</DocfyDemo>'));
-    return nodes;
-}
-exports.createDemoNodes = createDemoNodes;
-const MAP_LANG_TO_EXT = {
-    javascript: 'js',
-    typescript: 'ts',
-    handlebars: 'hbs',
-    'html.hbs': 'hbs',
-    'html.handlebars': 'hbs'
-};
-/*
- * It returns the file extension from a lang string.
- */
-function getExt(lang) {
-    lang = lang.toLowerCase();
-    return MAP_LANG_TO_EXT[lang] || lang;
-}
-exports.getExt = getExt;
-/*
- * Delete a node from a list of nodes
- */
-function deleteNode(nodes, nodeToDelete) {
-    if (!nodeToDelete) {
-        return;
-    }
-    if (Array.isArray(nodes)) {
-        const index = nodes.findIndex((item) => item === nodeToDelete);
-        if (index !== -1) {
-            nodes.splice(index, 1);
-        }
-    }
-}
-exports.deleteNode = deleteNode;
-/*
- * Replace a node from a list of nodes
- */
-function replaceNode(nodes, nodeToDelete, ...newNodes) {
-    if (Array.isArray(nodes)) {
-        const index = nodes.findIndex((item) => item === nodeToDelete);
-        if (index !== -1) {
-            nodes.splice(index, 1, ...newNodes);
-        }
-    }
-}
-exports.replaceNode = replaceNode;
-/*
- * Generate the component name from the source path of the demo
- *
- * It returns both dash case and pastal case.
- * The dash-case can be used for the file name and the PascalCase for the
- * rendering of the component.
- */
-function generateDemoComponentName(identifier, seenNames, tentativeCount = 1) {
-    const dashCase = identifier
-        .split('.')[0]
-        .toLowerCase()
-        .replace(/\/|\\/g, '-')
-        .replace(/[^a-zA-Z0-9|-]/g, '');
-    const pascalCase = dashCase
-        .replace(/(\w)(\w*)/g, function (_, g1, g2) {
-        return `${g1.toUpperCase()}${g2.toLowerCase()}`;
-    })
-        .replace(/-(\d+)/g, function (_, g1) {
-        return `_${g1}`;
-    })
-        .replace(/-/g, '');
-    if (seenNames.has(dashCase)) {
-        return generateDemoComponentName(`${dashCase}${tentativeCount}`, seenNames, tentativeCount + 1);
-    }
-    seenNames.add(dashCase);
-    return {
-        dashCase,
-        pascalCase
-    };
-}
-exports.generateDemoComponentName = generateDemoComponentName;
-/**
- * Checks if a property is of type DemoComponent[]
- */
-function isDemoComponents(components) {
-    if (Array.isArray(components) &&
-        typeof components[0] == 'object' &&
-        {}.hasOwnProperty.call(components[0], 'name') &&
-        {}.hasOwnProperty.call(components[0], 'chunks')) {
-        return true;
-    }
-    return false;
-}
-exports.isDemoComponents = isDemoComponents;

package/output.d.ts

@@ -1,13 +0,0 @@
-/*
- * The actual output.js file is generated at build time. This is only to
- * provide typing.
- */
-import { NestedPageMetadata } from '@docfy/core/lib/types';
-
-interface Output {
-  nested: NestedPageMetadata;
-}
-
-declare const output: Output;
-
-export default output;

package/src/docfy-output-template.ts

@@ -1,20 +0,0 @@
-export default function docfyOutputTemplate(modulePrefix: string): string {
-  return `;
-define('@docfy/ember/output', [
-  'exports',
-  '${modulePrefix}/docfy-output'
-], function (_exports, _docfyOutput) {
-  'use strict';
-
-  Object.defineProperty(_exports, '__esModule', {
-    value: true
-  });
-  Object.defineProperty(_exports, 'default', {
-    enumerable: true,
-    get: function () {
-      return _docfyOutput.default;
-    }
-  });
-});
-`;
-}

package/src/get-config.ts

@@ -1,109 +0,0 @@
-import path from 'path';
-import { pathToFileURL } from 'url';
-import { DocfyConfig } from '@docfy/core/lib/types';
-import remarkHbs from 'remark-hbs';
-import replaceInternalLinksWithDocfyLink from './plugins/replace-internal-links-with-docfy-link';
-import extractDemosToComponents from './plugins/extract-demos-to-components';
-import previewTemplate from './plugins/preview-template';
-import type { RemarkHbsOptions } from 'remark-hbs';
-
-const DEFAULT_CONFIG: DocfyConfig = {
-  sources: [
-    {
-      pattern: '**/*.md',
-      urlPrefix: 'docs'
-    }
-  ]
-};
-
-interface EmberDocfyConfig extends DocfyConfig {
-  remarkHbsOptions?: RemarkHbsOptions;
-}
-
-export default async function getDocfyConfig(
-  root: string
-): Promise<EmberDocfyConfig> {
-  const configPath = path.join(root, '.docfy-config.js');
-  let docfyConfig: Partial<EmberDocfyConfig> = {};
-
-  // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
-  const pkg = require(path.join(root, 'package.json'));
-
-  try {
-    // Attempt to require (CJS)
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    docfyConfig = require(configPath);
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  } catch (e: any) {
-    // Fallback to ESM if the error indicates ESM-only module
-    const isESMError =
-      e.code === 'ERR_REQUIRE_ESM' ||
-      e.message?.includes('must use import to load ES Module') ||
-      e.message?.includes('Cannot use import statement outside a module');
-
-    if (isESMError || e.code === 'ERR_MODULE_NOT_FOUND') {
-      try {
-        const imported = await import(pathToFileURL(configPath).href);
-        docfyConfig = imported?.default ?? imported;
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      } catch (esmErr: any) {
-        const notFound =
-          esmErr.code === 'ERR_MODULE_NOT_FOUND' ||
-          esmErr.message?.includes('Cannot find module');
-        if (!notFound) {
-          throw esmErr;
-        }
-        docfyConfig = {};
-      }
-    } else {
-      throw e;
-    }
-  }
-
-  if (typeof docfyConfig !== 'object' || docfyConfig == null) {
-    docfyConfig = {};
-  }
-
-  if (!Array.isArray(docfyConfig.sources)) {
-    docfyConfig.sources = DEFAULT_CONFIG.sources;
-  }
-
-  if (!Array.isArray(docfyConfig.plugins)) {
-    docfyConfig.plugins = [];
-  }
-
-  docfyConfig.plugins.unshift(
-    replaceInternalLinksWithDocfyLink,
-    previewTemplate,
-    extractDemosToComponents
-  );
-
-  if (!Array.isArray(docfyConfig.remarkPlugins)) {
-    docfyConfig.remarkPlugins = [];
-  }
-
-  docfyConfig.remarkPlugins.push([
-    remarkHbs,
-    docfyConfig.remarkHbsOptions || {}
-  ]);
-
-  const repoUrl = pkg.repository?.url || pkg.repository;
-
-  if (
-    !docfyConfig.repository &&
-    typeof repoUrl === 'string' &&
-    repoUrl !== ''
-  ) {
-    docfyConfig.repository = {
-      url: repoUrl
-    };
-  }
-
-  docfyConfig.sources.forEach((source) => {
-    if (typeof source.root === 'undefined') {
-      source.root = path.join(root, 'docs');
-    }
-  });
-
-  return docfyConfig as EmberDocfyConfig;
-}