@docfy/ember 0.9.0 → 0.9.1-beta.0

package/src/index.ts

@@ -1,229 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import BroccoliBridge from 'broccoli-bridge';
-import Funnel from 'broccoli-funnel';
-import MergeTrees from 'broccoli-merge-trees';
-import Plugin from 'broccoli-plugin';
-import WriteFile from 'broccoli-file-creator';
-import { Node, InputNode } from 'broccoli-node-api';
-import { UnwatchedDir } from 'broccoli-source';
-import Docfy from '@docfy/core';
-import { DocfyConfig, SourceConfig } from '@docfy/core/lib/types';
-import { DemoComponentChunk } from './plugins/types';
-import docfyOutputTemplate from './docfy-output-template';
-import getDocfyConfig from './get-config';
-import { isDemoComponents } from './plugins/utils';
-import cacheKeyForTree from 'calculate-cache-key-for-tree';
-import debugFactory from 'debug';
-const debug = debugFactory('@docfy/ember');
-
-const templateOnlyComponent = `
-import Component from '@glimmer/component';
-export default class extends Component {}
-`;
-
-function ensureDirectoryExistence(filePath: string): void {
-  const dirname = path.dirname(filePath);
-  if (fs.existsSync(dirname)) {
-    return;
-  }
-  ensureDirectoryExistence(dirname);
-  fs.mkdirSync(dirname);
-}
-
-function hasBackingJS(chunks: DemoComponentChunk[]): boolean {
-  for (let i = 0; i < chunks.length; i++) {
-    const chunk = chunks[i];
-
-    if (['js', 'ts', 'gts', 'gjs'].includes(chunk.ext)) {
-      return true;
-    }
-  }
-  return false;
-}
-
-// eslint-disable-next-line
-function isDeepAddonInstance(addon: any): boolean {
-  return addon.parent !== addon.project;
-}
-
-class DocfyBroccoli extends Plugin {
-  config: DocfyConfig;
-
-  constructor(inputNodes: InputNode[], options = {}) {
-    super(inputNodes, options);
-    this.config = options as DocfyConfig;
-  }
-
-  async build(): Promise<void> {
-    debug('Output Path: ', this.outputPath);
-    debug('Config: ', this.config);
-    const docfy = new Docfy(this.config);
-    const result = await docfy.run(this.config.sources as SourceConfig[]);
-    const snippets = {
-      components: {}
-    };
-    result.content.forEach((page) => {
-      const parts = [this.outputPath, 'templates', page.meta.url];
-
-      if (page.meta.url[page.meta.url.length - 1] === '/') {
-        parts.push('index');
-      }
-
-      const fileName = `${path.join(...parts)}.hbs`;
-
-      // console.log(fileName, "RENDERED AS", page.rendered);
-      ensureDirectoryExistence(fileName);
-      fs.writeFileSync(fileName, page.rendered);
-
-      const demoComponents = page.pluginData.demoComponents;
-      if (isDemoComponents(demoComponents)) {
-        demoComponents.forEach((component) => {
-          component.chunks.forEach((chunk) => {
-            const chunkPath = path.join(
-              this.outputPath,
-              'components',
-              `${component.name.dashCase}.${chunk.ext}`
-            );
-            ensureDirectoryExistence(chunkPath);
-
-            snippets.components[`${component.name.dashCase}`] = {
-              ...(snippets.components[`${component.name.dashCase}`] || {}),
-              [chunk.ext]: chunk.code
-            };
-            fs.writeFileSync(chunkPath, chunk.code);
-          });
-
-          if (!hasBackingJS(component.chunks)) {
-            const chunkPath = path.join(
-              this.outputPath,
-              'components',
-              `${component.name.dashCase}.js`
-            );
-            ensureDirectoryExistence(chunkPath);
-            snippets.components[`${component.name.dashCase}`] = {
-              ...(snippets.components[`${component.name.dashCase}`] || {}),
-              js: templateOnlyComponent
-            };
-            fs.writeFileSync(chunkPath, templateOnlyComponent);
-          }
-        });
-      }
-    });
-
-    fs.writeFileSync(
-      path.join(this.outputPath, 'docfy-output.js'),
-      `export default ${JSON.stringify({ nested: result.nestedPageMetadata })};`
-    );
-
-    const urlsJsonFile = path.join(
-      this.outputPath,
-      'public',
-      'docfy-urls.json'
-    );
-
-    ensureDirectoryExistence(urlsJsonFile);
-    fs.writeFileSync(
-      urlsJsonFile,
-      JSON.stringify(result.content.map((page) => page.meta.url))
-    );
-    const snippetsJsonFile = path.join(
-      this.outputPath,
-      'public',
-      'docfy-snippets.json'
-    );
-    ensureDirectoryExistence(snippetsJsonFile);
-    fs.writeFileSync(snippetsJsonFile, JSON.stringify(snippets));
-    result.staticAssets.forEach((asset) => {
-      const dest = path.join(this.outputPath, 'public', asset.toPath);
-      ensureDirectoryExistence(dest);
-      fs.copyFileSync(asset.fromPath, dest);
-    });
-  }
-}
-
-module.exports = {
-  name: require('../package').name, // eslint-disable-line
-
-  docfyConfig: undefined,
-
-  included(...args: unknown[]): void {
-    if (!isDeepAddonInstance(this)) {
-      this.docfyConfig = getDocfyConfig(this.project.root);
-      this.bridge = new BroccoliBridge();
-    }
-    this._super.included.apply(this, args);
-  },
-
-  // Re-enables caching of this addon, due to opting out
-  // of the caching implicitly by specifying treeFor* methods
-  cacheKeyForTree(treeType: string): string {
-    switch (treeType) {
-      case 'app':
-      case 'addon': {
-        return cacheKeyForTree(treeType, this, [this.docfyConfig]);
-      }
-      default:
-        return cacheKeyForTree(treeType, this);
-    }
-  },
-
-  treeForApp(tree: Node): Node {
-    const trees: Node[] = [this._super.treeForApp.call(this, tree)];
-    if (isDeepAddonInstance(this)) {
-      return trees[0];
-    }
-
-    const inputs: InputNode[] = [new UnwatchedDir(this.project.root)];
-
-    (this.docfyConfig as DocfyConfig).sources.forEach((item) => {
-      if (item.root && item.root !== this.project.root) {
-        inputs.push(item.root);
-      }
-    });
-
-    const docfyTree = new DocfyBroccoli(inputs, this.docfyConfig);
-    trees.push(docfyTree);
-
-    (this.bridge as BroccoliBridge).fulfill('docfy-tree', docfyTree);
-
-    return new MergeTrees(trees, { overwrite: true });
-  },
-
-  treeForAddon(tree: Node): Node {
-    const trees: Node[] = [this._super.treeForAddon.call(this, tree)];
-    if (isDeepAddonInstance(this)) {
-      return trees[0];
-    }
-
-    const EmberApp = require('ember-cli/lib/broccoli/ember-app'); // eslint-disable-line
-    const modulePrefix = this.project.config(EmberApp.env()).modulePrefix;
-
-    trees.push(new WriteFile('output.js', docfyOutputTemplate(modulePrefix)));
-
-    return new MergeTrees(trees);
-  },
-
-  treeForPublic(): Node | undefined {
-    if (isDeepAddonInstance(this)) {
-      return;
-    }
-
-    return new Funnel(
-      (this.bridge as BroccoliBridge).placeholderFor('docfy-tree'),
-      {
-        srcDir: 'public',
-        destDir: './'
-      }
-    );
-  },
-
-  urlsForPrember(distDir: string): string[] {
-    try {
-      return require(path.join(distDir, 'docfy-urls.json')); // eslint-disable-line
-    } catch {
-      // empty
-    }
-    return [];
-  }
-};

package/src/plugins/extract-demos-to-components.ts

@@ -1,196 +0,0 @@
-import visit from 'unist-util-visit';
-import { Context, PageContent } from '@docfy/core/lib/types';
-import plugin from '@docfy/core/lib/plugin';
-import { Node, Parent } from 'unist';
-import findNode from 'unist-util-find';
-import toString from 'mdast-util-to-string';
-import { DemoComponent, DemoComponentChunk, CodeNode } from './types';
-import {
-  generateDemoComponentName,
-  getExt,
-  createDemoNodes,
-  deleteNode,
-  isDemoComponents
-} from './utils';
-import path from '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: Context): Node {
-  const heading = (
-    ctx.remark.runSync(ctx.remark.parse('## Examples')).children as Node[]
-  )[0];
-  heading.depth = 2;
-  return heading;
-}
-
-const isTextMarker = (node: Parent): boolean =>
-  node.type === 'paragraph' &&
-  node.children.length === 1 &&
-  node.children[0].type === 'text';
-
-const demoMarkerRegex = /^\[\[demo:(.+?)\]\]$/;
-const demoMarker = (node: Parent): boolean =>
-  isTextMarker(node) && demoMarkerRegex.test(node.children[0].value as string);
-
-const demosAllMarkerRegex = /^\[\[demos-all\]\]$/;
-const demosAllMarker = (node: Parent): boolean =>
-  isTextMarker(node) &&
-  demosAllMarkerRegex.test(node.children[0].value as string);
-
-/*
- * Insert Demo nodes into the page.
- */
-function insertDemoNodesIntoPage(page: PageContent, toInsert: Node[]): void {
-  if (Array.isArray(page.ast.children)) {
-    const secondHeading = findNode(
-      page.ast,
-      (node: 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: PageContent, demos: DemoComponent[]): void {
-  if (Array.isArray(page.ast.children)) {
-    const markers: Parent[] = [];
-    const allMarkers: Parent[] = [];
-
-    visit(page.ast, 'paragraph', (node: Parent) => {
-      if (demoMarker(node)) markers.push(node);
-      if (demosAllMarker(node)) allMarkers.push(node);
-    });
-
-    markers.forEach((marker) => {
-      const child = marker.children[0];
-      const matches = (child.value as string).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, ...createDemoNodes(demo));
-    });
-
-    allMarkers.forEach((marker) => {
-      const demoNodes = demos
-        .map((component) => createDemoNodes(component))
-        .flat();
-
-      marker.type = 'div';
-      marker.children.splice(0, 1, ...demoNodes);
-    });
-  }
-}
-
-export default plugin({
-  runWithMdast(ctx: Context): void {
-    const seenNames: Set<string> = new Set();
-
-    ctx.pages.forEach((page) => {
-      if (page.demos) {
-        const demoComponents: DemoComponent[] = [];
-
-        page.demos.forEach((demo) => {
-          const chunks: DemoComponentChunk[] = [];
-
-          visit(demo.ast, 'code', (node: CodeNode) => {
-            if (['component', 'template', 'styles'].includes(node.meta || '')) {
-              chunks.push({
-                snippet: node,
-                code: node.value.replace(/\\{{/g, '{{'), // un-escape hbs
-                ext: getExt(
-                  node.lang || (node.meta === 'template' ? 'hbs' : 'js')
-                ),
-                type: node.meta as string
-              });
-            }
-          });
-
-          // 1. exclude extension
-          // 2. remove /index.md because of web conventions
-          const baseName = page.source.replace('/index.md', '').split('.')[0];
-
-          const componentName = generateDemoComponentName(
-            `docfy-demo-${baseName}-${
-              path.basename(demo.source).split('.')[0]
-            }`,
-            seenNames
-          );
-
-          const demoTitle = findNode(
-            demo.ast,
-            (node: Node) => node.type === 'heading' && node.depth === 1
-          );
-
-          if (demoTitle) {
-            demoTitle.depth = 3;
-            demoTitle.data = {
-              ...(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 ? toString(demoTitle) : undefined,
-              ast: demo.ast,
-              editUrl: demo.meta.editUrl
-            }
-          });
-
-          // Delete used code blocks
-          chunks.forEach(({ snippet }) => {
-            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: Node[] = [createHeading(ctx)];
-          demoComponents.forEach((component) => {
-            toInsert.push(...createDemoNodes(component));
-          });
-          insertDemoNodesIntoPage(page, toInsert);
-        }
-
-        if (isDemoComponents(page.pluginData.demoComponents)) {
-          page.pluginData.demoComponents.push(...demoComponents);
-        } else {
-          page.pluginData.demoComponents = demoComponents;
-        }
-      }
-    });
-  }
-});

package/src/plugins/preview-template.ts

@@ -1,54 +0,0 @@
-import visit from 'unist-util-visit';
-import plugin from '@docfy/core/lib/plugin';
-import { DemoComponent, CodeNode } from './types';
-import {
-  generateDemoComponentName,
-  getExt,
-  createDemoNodes,
-  isDemoComponents,
-  replaceNode
-} from './utils';
-import path from 'path';
-
-export default plugin({
-  runWithMdast(ctx): void {
-    const seenNames: Set<string> = new Set();
-
-    ctx.pages.forEach((page) => {
-      const demoComponents: DemoComponent[] = [];
-
-      visit(page.ast, 'code', (node: CodeNode) => {
-        if (['preview-template', 'preview'].includes(node.meta || '')) {
-          demoComponents.push({
-            name: generateDemoComponentName(
-              `docfy-demo-preview-${path.basename(page.meta.url)}`,
-              seenNames
-            ),
-            chunks: [
-              {
-                snippet: node,
-                code: node.value.replace(/\\{{/g, '{{'), // un-escape hbs
-                ext: getExt(node.lang || 'hbs'),
-                type: node.meta as string
-              }
-            ]
-          });
-        }
-      });
-
-      demoComponents.forEach((demoComponent) => {
-        replaceNode(
-          page.ast.children,
-          demoComponent.chunks[0].snippet,
-          ...createDemoNodes(demoComponent)
-        );
-      });
-
-      if (isDemoComponents(page.pluginData.demoComponents)) {
-        page.pluginData.demoComponents.push(...demoComponents);
-      } else {
-        page.pluginData.demoComponents = demoComponents;
-      }
-    });
-  }
-});

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

@@ -1,61 +0,0 @@
-import plugin from '@docfy/core/lib/plugin';
-import visit from 'unist-util-visit';
-import { PageContent } from '@docfy/core/lib/types';
-import { Node } from 'unist';
-import u from 'unist-builder';
-
-interface LinkNode extends Node {
-  title: string | null;
-  url: string;
-  children: Node[];
-}
-
-function visitor(page: PageContent): void {
-  visit(page.ast, 'link', (node: LinkNode, index, parent) => {
-    if (node.url[0] === '/') {
-      const data = node.data || (node.data = {});
-      const props = (data.hProperties || (data.hProperties = {})) as Record<
-        string,
-        unknown
-      >;
-
-      const urlParts = node.url.split('#');
-      const attributes = Object.keys(props)
-        .map((key) => {
-          return `${key}=${String(props[key])}`;
-        })
-        .join(' ');
-
-      const toInsert: Node[] = [
-        u(
-          'html',
-          `<DocfyLink @to="${urlParts[0]}" ${
-            urlParts[1] ? `@anchor="${urlParts[1]}"` : ''
-          } ${attributes}>`
-        ),
-        ...node.children,
-        u('html', `</DocfyLink>`)
-      ];
-
-      parent?.children.splice(index, 1, ...toInsert);
-    }
-  });
-}
-
-/**
- * This function finds all the links starting with an `/` and replace them with
- * the `DocfyLink` component.
- */
-export default plugin({
-  runWithMdast(ctx): void {
-    ctx.pages.forEach((page) => {
-      visitor(page);
-
-      if (Array.isArray(page.demos)) {
-        page.demos.forEach((demo) => {
-          visitor(demo);
-        });
-      }
-    });
-  }
-});

package/src/plugins/types.ts

@@ -1,33 +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;
-}