@docfy/ember 0.9.0 → 0.10.0

package/src/plugins/utils.ts

@@ -1,191 +0,0 @@
-import { Node } from 'unist';
-import u from 'unist-builder';
-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 function createDemoNodes(component: DemoComponent): Node[] {
-  const nodes: Node[] = [
-    u('html', `<DocfyDemo @id="${component.name.dashCase}" as |demo|>`)
-  ];
-
-  if (component.description) {
-    nodes.push(
-      u(
-        'html',
-        `<demo.Description
-          ${
-            component.description.title
-              ? `@title="${component.description.title}" `
-              : ''
-          }${
-          component.description.editUrl
-            ? `@editUrl="${component.description.editUrl}"`
-            : ''
-        }>`
-      ),
-      component.description.ast,
-      u('html', '</demo.Description>')
-    );
-  }
-
-  nodes.push(
-    u('html', '<demo.Example>'),
-    u('html', `<${component.name.pascalCase} />`),
-    u('html', '</demo.Example>')
-  );
-
-  if (component.chunks.length > 1) {
-    nodes.push(u('html', '<demo.Snippets as |Snippet|>'));
-    component.chunks.forEach((chunk) => {
-      nodes.push(
-        u('html', `<Snippet @name="${chunk.type}">`),
-        chunk.snippet,
-        u('html', '</Snippet>')
-      );
-    });
-    nodes.push(u('html', '</demo.Snippets>'));
-  } else {
-    component.chunks.forEach((chunk) => {
-      nodes.push(
-        u('html', `<demo.Snippet @name="${chunk.type}">`),
-        chunk.snippet,
-        u('html', '</demo.Snippet>')
-      );
-    });
-  }
-
-  nodes.push(u('html', '</DocfyDemo>'));
-
-  return nodes;
-}
-
-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.
- */
-export function getExt(lang: string): string {
-  lang = lang.toLowerCase();
-  return MAP_LANG_TO_EXT[lang] || lang;
-}
-
-/*
- * Delete a node from a list of nodes
- */
-export function deleteNode(
-  nodes: unknown,
-  nodeToDelete: Node | undefined
-): void {
-  if (!nodeToDelete) {
-    return;
-  }
-
-  if (Array.isArray(nodes)) {
-    const index = nodes.findIndex((item) => item === nodeToDelete);
-
-    if (index !== -1) {
-      nodes.splice(index, 1);
-    }
-  }
-}
-
-/*
- * Replace a node from a list of nodes
- */
-export function replaceNode(
-  nodes: unknown,
-  nodeToDelete: Node,
-  ...newNodes: Node[]
-): void {
-  if (Array.isArray(nodes)) {
-    const index = nodes.findIndex((item) => item === nodeToDelete);
-
-    if (index !== -1) {
-      nodes.splice(index, 1, ...newNodes);
-    }
-  }
-}
-
-/*
- * 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.
- */
-export function generateDemoComponentName(
-  identifier: string,
-  seenNames: Set<string>,
-  tentativeCount = 1
-): DemoComponentName {
-  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
-  };
-}
-
-/**
- * Checks if a property is of type DemoComponent[]
- */
-export function isDemoComponents(
-  components: unknown
-): components is DemoComponent[] {
-  if (
-    Array.isArray(components) &&
-    typeof components[0] == 'object' &&
-    {}.hasOwnProperty.call(components[0], 'name') &&
-    {}.hasOwnProperty.call(components[0], 'chunks')
-  ) {
-    return true;
-  }
-  return false;
-}

package/src/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "strict": false,
-    "baseUrl": ".",
-    "outDir": "../lib",
-    "paths": {
-      "*": ["types/*"]
-    },
-    "typeRoots": ["../../../node_modules/@types", "types"],
-    "types": ["node"]
-  },
-  "include": ["**/*", "types/**/*"]
-}

package/src/types/broccoli-bridge.d.ts

@@ -1,11 +0,0 @@
-declare module 'broccoli-bridge' {
-  import Plugin from 'broccoli-plugin';
-  import { InputNode, Node } from 'broccoli-node-api';
-
-  export default class Funnel extends Plugin {
-    constructor();
-
-    placeholderFor(name: string): InputNode;
-    fulfill(name: string, tree: Node): void;
-  }
-}

package/src/types/broccoli-file-creator.d.ts

@@ -1,11 +0,0 @@
-declare module 'broccoli-file-creator' {
-  import Plugin from 'broccoli-plugin';
-
-  export default class WriteFile extends Plugin {
-    constructor(
-      filename: string,
-      content: string,
-      _options?: Record<string, unknown>
-    );
-  }
-}

package/src/types/broccoli-funnel.d.ts

@@ -1,19 +0,0 @@
-declare module 'broccoli-funnel' {
-  import Plugin from 'broccoli-plugin';
-  import { InputNode } from 'broccoli-node-api';
-
-  interface Options {
-    annotation?: string;
-    srcDir?: string;
-    destDir?: string;
-    allowEmpty?: boolean;
-    include?: (string | RegExp | ((arg0: string) => boolean))[];
-    exclude?: (string | ((arg0: string) => boolean))[];
-    files?: string[];
-    getDestinationPath?(file: string): string;
-  }
-
-  export default class Funnel extends Plugin {
-    constructor(inputNode: InputNode, options?: Options);
-  }
-}

package/src/types/broccoli-merge-trees.d.ts

@@ -1,13 +0,0 @@
-declare module 'broccoli-merge-trees' {
-  import Plugin from 'broccoli-plugin';
-  import { InputNode } from 'broccoli-node-api';
-  import { PluginOptions } from 'broccoli-plugin/dist/interfaces';
-
-  interface Options extends PluginOptions {
-    overwrite?: boolean;
-  }
-
-  export default class MergeTrees extends Plugin {
-    constructor(inputNodes: InputNode[], options?: Options);
-  }
-}

package/src/types/broccoli-source.d.ts

@@ -1,9 +0,0 @@
-declare module 'broccoli-source' {
-  import { PluginOptions } from 'broccoli-plugin/dist/interfaces';
-  import Plugin from 'broccoli-plugin';
-  import { InputNode } from 'broccoli-node-api';
-
-  export class UnwatchedDir extends Plugin {
-    constructor(inputNode: InputNode, options?: PluginOptions);
-  }
-}

package/src/types/mdast-util-to-string.d.ts

@@ -1,5 +0,0 @@
-declare module 'mdast-util-to-string' {
-  import { Node } from 'unist';
-
-  export default function (ast: Node): string;
-}

package/src/types/unist-util-find.d.ts

@@ -1,8 +0,0 @@
-declare module 'unist-util-find' {
-  import { Node } from 'unist';
-
-  export default function (
-    ast: Node,
-    condition: string | Record<string, unknown> | ((node: Node) => boolean)
-  ): Node | undefined;
-}

package/tsconfig.json

@@ -1,42 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2017",
-    "allowJs": true,
-    "moduleResolution": "node",
-    "allowSyntheticDefaultImports": true,
-    "noImplicitAny": true,
-    "noImplicitThis": true,
-    "alwaysStrict": true,
-    "strictNullChecks": true,
-    "strictPropertyInitialization": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noEmitOnError": false,
-    "noEmit": true,
-    "inlineSourceMap": true,
-    "inlineSources": true,
-    "baseUrl": ".",
-    "module": "es6",
-    "experimentalDecorators": true,
-    "paths": {
-      "dummy/tests/*": ["tests/*"],
-      "dummy/*": ["tests/dummy/app/*", "app/*"],
-      "@docfy/ember": ["addon"],
-      "@docfy/ember/*": ["addon/*"],
-      "@docfy/ember/test-support": ["addon-test-support"],
-      "@docfy/ember/test-support/*": ["addon-test-support/*"],
-      "*": ["types/*"]
-    }
-  },
-  "include": [
-    "app/**/*",
-    "addon/**/*",
-    "tests/**/*",
-    "types/**/*",
-    "test-support/**/*",
-    "addon-test-support/**/*"
-  ]
-}

package/types/ember-get-config/index.d.ts

@@ -1,9 +0,0 @@
-declare const config: {
-  environment: string;
-  modulePrefix: string;
-  podModulePrefix: string;
-  locationType: string;
-  rootURL: string;
-};
-
-export default config;

package/types/global.d.ts

@@ -1,6 +0,0 @@
-// Types for compiled templates
-declare module '@docfy/ember/templates/*' {
-  import { TemplateFactory } from 'htmlbars-inline-precompile';
-  const tmpl: TemplateFactory;
-  export default tmpl;
-}