@docfy/ember 0.9.0 → 0.10.0

package/dummy-docs/packages/core/overview.md

@@ -1,19 +0,0 @@
----
-category: core
----
-
-# Overview
-
-## Admovit est tutus nec elusam scrobibus totumque
-
-Lorem markdownum animaeque obsedit adversam, saevi sed resupina tenuesque levius
-tenenti utque. Cornibus et opes crudelia primus procul alvum exit: dum frondes!
-Cornibus e, putat procul nostro erat cunctantem munus inventus quod.
-
-- Unus frondes
-- Gelida vos cultus vada dicta sunt lacerto
-- Utque meum referam
-
-## Helpers
-
-[Link to another category](../core/helpers/genereate-flat-output.md)

package/dummy-docs/packages/ember/components/docfy-link-demo/demo1.md

@@ -1,26 +0,0 @@
----
-order: 2
----
-
-# Demo of DocfyLink component
-
-This is a cool feature.
-
-[Link from a demo](../docfy-output.md)
-
-```hbs template
-<div data-test-id="demo-1">
-  This is my Demo:
-
-  <DocfyLink @to={{this.url}}>My Link</DocfyLink>
-</div>
-<div data-test-id="demo-1-js-data">{{this.url}}</div>
-```
-
-```js component
-import Component from '@glimmer/component';
-
-export default class MyDemo extends Component {
-  url = '/docs/ember/';
-}
-```

package/dummy-docs/packages/ember/components/docfy-link-demo/demo2.md

@@ -1,20 +0,0 @@
----
-order: 1
----
-
-# This demo only has a template
-
-I can use markdown here.
-
-- Item 1
-- Item 2
-
-_Super Cool_
-
-```hbs template
-<DocfyLink @to="/" class="font-bold" data-test-id="demo-2">
-  My Other Demo Link
-</DocfyLink>
-```
-
-This is a cool feature.

package/dummy-docs/packages/ember/components/docfy-link.md

@@ -1,19 +0,0 @@
----
-category: ember
-subcategory: components
----
-
-# Docfy Link Component
-
-Lorem markdownum animaeque obsedit adversam, saevi sed resupina tenuesque levius
-tenenti utque. Cornibus et opes crudelia primus procul alvum exit: dum frondes!
-Cornibus e, putat procul nostro erat cunctantem munus inventus quod.
-
-Another paragraph
-
-## This is another thing
-
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod
-tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
-At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren,
-no sea takimata sanctus est Lorem ipsum dolor sit amet.

package/dummy-docs/packages/ember/components/docfy-output.md

@@ -1,32 +0,0 @@
----
-category: ember
-subcategory: components
----
-
-# Docfy Output Component
-
-Lorem markdownum animaeque obsedit adversam, saevi sed resupina tenuesque levius
-tenenti utque. Cornibus et opes crudelia primus procul alvum exit: dum frondes!
-Cornibus e, putat procul nostro erat cunctantem munus inventus quod.
-
-## Example of "On this page"
-
-```hbs
-
-<DocfyOutput @fromCurrentURL={{true}} as |page|>
-  {{#if page.headings.length}}
-    On this page:
-    <ul>
-      {{#each page.headings as |heading|}}
-        <li>
-          <DocfyLink @to={{page.url}} @anchor={{heading.id}}>
-            {{heading.title}}
-          </DocfyLink>
-        </li>
-      {{/each}}
-    </ul>
-  {{/if}}
-</DocfyOutput>
-```
-
-For documentation of `DocfyLink` [click here](./docfy-link.md)

package/dummy-docs/packages/ember/components/docfy-with-hyphenated-number-2-demo/demo1.md

@@ -1,25 +0,0 @@
----
-order: 1
----
-
-# Demo of DocfyLink component
-
-[Link from a demo](../docfy-output.md)
-
-```hbs template
-<div data-test-id="demo-1">
-  This is my Demo:
-
-  <span class='hyphenated-demo'>Assertable DOM node</span>
-  <DocfyLink @to={{this.url}}>My Link</DocfyLink>
-</div>
-<div data-test-id="demo-1-js-data">{{this.url}}</div>
-```
-
-```js component
-import Component from '@glimmer/component';
-
-export default class MyDemo extends Component {
-  url = '/docs/ember/';
-}
-```

package/dummy-docs/packages/ember/components/docfy-with-hyphenated-number-2.md

@@ -1,9 +0,0 @@
----
-category: ember
-subcategory: components
----
-
-# Docfy With Hyphenated Number 2
-
-Testing doc pages with numbers in their name and how that corresponds with
-automatic component registration.

package/dummy-docs/packages/ember/demo/my-ember-demo.md

@@ -1,3 +0,0 @@
-```hbs template
-demo for ember folder
-```

package/dummy-docs/packages/ember/index.md

@@ -1,23 +0,0 @@
-# Working with Ember
-
-This is a simple markdown
-
-Where are a lot of cool features here. One of them is to preview a template.
-
-```hbs preview-template
-<DocfyLink @to="/" class="text-blue-700">This is a link to index</DocfyLink>
-
-<div class="p-4 my-2 border border-blue-500 rounded" data-test-id="preview-1">
-  I can have any hbs here and I can use any component avaliable in the host app.
-</div>
-```
-
-## Another content
-
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
-
-```hbs preview-template
-<div data-test-id="preview-2">
-  Another preview here
-</div>
-```

package/dummy-docs/packages/ember/installation.md

@@ -1,14 +0,0 @@
----
-category: ember
----
-
-# Installation
-
-```sh
-
-# Using npm
-npm install --save-dev @docfy/ember
-
-# Using Yarn
-yarn add --dev @docfy/ember
-```

package/dummy-docs/packages/ember/plugins/manual-demo-insertion-demo/tomster.md

@@ -1,15 +0,0 @@
-# Tomster
-
-Lovable hamster
-
-```hbs template
-<div data-test-id="tomster">
-  {{#let (array 1 2 3 4 5) as |numbers|}}
-    <ol>
-      {{#each numbers as |number|}}
-        <li>Here is number {{number}}</li>
-      {{/each}}
-    </ol>
-  {{/let}}
-</div>
-```

package/dummy-docs/packages/ember/plugins/manual-demo-insertion-demo/zoey.md

@@ -1,9 +0,0 @@
-# Zoey
-
-Tomster's sister (also a lovable hamster).
-
-```hbs template
-<div data-test-id="zoey">
-  Ember is <em>so</em> {{concat 'g' 'r' 'e' 'a' 't'}}!
-</div>
-```

package/dummy-docs/packages/ember/plugins/manual-demo-insertion.md

@@ -1,31 +0,0 @@
----
-category: ember
-subcategory: plugins
-manualDemoInsertion: true
----
-
-# Manual Demo Insertion
-
-Docfy will automatically insert demos for a page into the page at build time. However, this convenience comes at the cost of choosing where the demos should be rendered.
-
-If you want control over where demos are rendered in a page, add `manualDemoInsertion: true` to your page's frontmatter. Then you can use `[[demo:name]]` or `[[demos-all]]` to mark where a specific demo or all demos should be rendered.
-
-These markers must be on their own line!
-
-## It works like this
-
-Here is the tomster demo
-
-[[demo:tomster]]
-
-And here is the zoey demo
-
-[[demo:zoey]]
-
-## Or you can add all demos
-
-[[demos-all]]
-
-## Conclusion
-
-With Docfy you get demos added to your pages for free, but with a little more work you can also get a bit more control.

package/dummy-docs/packages/ember/preview.md

@@ -1,20 +0,0 @@
----
-category: ember
----
-
-# Preview works with gts, gjs
-
-This works
-
-```gts preview
-import Component from '@glimmer/component';
-
-// components/hello.gjs
-export default class Hello extends Component {
-  isThisCool = true;
-
-  <template>
-    Is This Cool?: {{this.isThisCool}}
-  </template>
-}
-```

package/ember-cli-addon.js

@@ -1,3 +0,0 @@
-'use strict';
-
-module.exports = require('./lib');

package/helpers/docfy-eq.d.ts

@@ -1,7 +0,0 @@
-export declare function docfyEq(params: unknown[]): boolean;
-declare const _default: import("@ember/component/helper").FunctionBasedHelper<{
-    PositionalArgs: unknown[];
-    NamedArgs: Record<string, unknown>;
-    Return: boolean;
-}>;
-export default _default;

package/index.d.ts

@@ -1,3 +0,0 @@
-import RouterDSL from '@ember/routing/-private/router-dsl';
-export { default as DocfyService } from './services/docfy';
-export declare function addDocfyRoutes(context: RouterDSL): void;

package/lib/docfy-output-template.d.ts

@@ -1 +0,0 @@
-export default function docfyOutputTemplate(modulePrefix: string): string;

package/lib/docfy-output-template.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function docfyOutputTemplate(modulePrefix) {
-    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;
-    }
-  });
-});
-`;
-}
-exports.default = docfyOutputTemplate;

package/lib/get-config.d.ts

@@ -1,7 +0,0 @@
-import { DocfyConfig } from '@docfy/core/lib/types';
-import type { RemarkHbsOptions } from 'remark-hbs';
-interface EmberDocfyConfig extends DocfyConfig {
-    remarkHbsOptions?: RemarkHbsOptions;
-}
-export default function getDocfyConfig(root: string): Promise<EmberDocfyConfig>;
-export {};

package/lib/get-config.js

@@ -1,118 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const url_1 = require("url");
-const remark_hbs_1 = __importDefault(require("remark-hbs"));
-const replace_internal_links_with_docfy_link_1 = __importDefault(require("./plugins/replace-internal-links-with-docfy-link"));
-const extract_demos_to_components_1 = __importDefault(require("./plugins/extract-demos-to-components"));
-const preview_template_1 = __importDefault(require("./plugins/preview-template"));
-const DEFAULT_CONFIG = {
-    sources: [
-        {
-            pattern: '**/*.md',
-            urlPrefix: 'docs'
-        }
-    ]
-};
-function getDocfyConfig(root) {
-    var _a, _b, _c, _d, _e;
-    return __awaiter(this, void 0, void 0, function* () {
-        const configPath = path_1.default.join(root, '.docfy-config.js');
-        let docfyConfig = {};
-        // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
-        const pkg = require(path_1.default.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) {
-            // Fallback to ESM if the error indicates ESM-only module
-            const isESMError = e.code === 'ERR_REQUIRE_ESM' ||
-                ((_a = e.message) === null || _a === void 0 ? void 0 : _a.includes('must use import to load ES Module')) ||
-                ((_b = e.message) === null || _b === void 0 ? void 0 : _b.includes('Cannot use import statement outside a module'));
-            if (isESMError || e.code === 'ERR_MODULE_NOT_FOUND') {
-                try {
-                    const imported = yield Promise.resolve().then(() => __importStar(require((0, url_1.pathToFileURL)(configPath).href)));
-                    docfyConfig = (_c = imported === null || imported === void 0 ? void 0 : imported.default) !== null && _c !== void 0 ? _c : imported;
-                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                }
-                catch (esmErr) {
-                    const notFound = esmErr.code === 'ERR_MODULE_NOT_FOUND' ||
-                        ((_d = esmErr.message) === null || _d === void 0 ? void 0 : _d.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(replace_internal_links_with_docfy_link_1.default, preview_template_1.default, extract_demos_to_components_1.default);
-        if (!Array.isArray(docfyConfig.remarkPlugins)) {
-            docfyConfig.remarkPlugins = [];
-        }
-        docfyConfig.remarkPlugins.push([
-            remark_hbs_1.default,
-            docfyConfig.remarkHbsOptions || {}
-        ]);
-        const repoUrl = ((_e = pkg.repository) === null || _e === void 0 ? void 0 : _e.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_1.default.join(root, 'docs');
-            }
-        });
-        return docfyConfig;
-    });
-}
-exports.default = getDocfyConfig;

package/lib/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/index.js

@@ -1,177 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const broccoli_bridge_1 = __importDefault(require("broccoli-bridge"));
-const broccoli_funnel_1 = __importDefault(require("broccoli-funnel"));
-const broccoli_merge_trees_1 = __importDefault(require("broccoli-merge-trees"));
-const broccoli_plugin_1 = __importDefault(require("broccoli-plugin"));
-const broccoli_file_creator_1 = __importDefault(require("broccoli-file-creator"));
-const broccoli_source_1 = require("broccoli-source");
-const core_1 = __importDefault(require("@docfy/core"));
-const docfy_output_template_1 = __importDefault(require("./docfy-output-template"));
-const get_config_1 = __importDefault(require("./get-config"));
-const utils_1 = require("./plugins/utils");
-const calculate_cache_key_for_tree_1 = __importDefault(require("calculate-cache-key-for-tree"));
-const debug_1 = __importDefault(require("debug"));
-const debug = (0, debug_1.default)('@docfy/ember');
-const templateOnlyComponent = `
-import Component from '@glimmer/component';
-export default class extends Component {}
-`;
-function ensureDirectoryExistence(filePath) {
-    const dirname = path_1.default.dirname(filePath);
-    if (fs_1.default.existsSync(dirname)) {
-        return;
-    }
-    ensureDirectoryExistence(dirname);
-    fs_1.default.mkdirSync(dirname);
-}
-function hasBackingJS(chunks) {
-    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) {
-    return addon.parent !== addon.project;
-}
-class DocfyBroccoli extends broccoli_plugin_1.default {
-    constructor(inputNodes, options = {}) {
-        super(inputNodes, options);
-        this.config = options;
-    }
-    build() {
-        return __awaiter(this, void 0, void 0, function* () {
-            debug('Output Path: ', this.outputPath);
-            debug('Config: ', this.config);
-            const docfy = new core_1.default(this.config);
-            const result = yield docfy.run(this.config.sources);
-            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_1.default.join(...parts)}.hbs`;
-                // console.log(fileName, "RENDERED AS", page.rendered);
-                ensureDirectoryExistence(fileName);
-                fs_1.default.writeFileSync(fileName, page.rendered);
-                const demoComponents = page.pluginData.demoComponents;
-                if ((0, utils_1.isDemoComponents)(demoComponents)) {
-                    demoComponents.forEach((component) => {
-                        component.chunks.forEach((chunk) => {
-                            const chunkPath = path_1.default.join(this.outputPath, 'components', `${component.name.dashCase}.${chunk.ext}`);
-                            ensureDirectoryExistence(chunkPath);
-                            snippets.components[`${component.name.dashCase}`] = Object.assign(Object.assign({}, (snippets.components[`${component.name.dashCase}`] || {})), { [chunk.ext]: chunk.code });
-                            fs_1.default.writeFileSync(chunkPath, chunk.code);
-                        });
-                        if (!hasBackingJS(component.chunks)) {
-                            const chunkPath = path_1.default.join(this.outputPath, 'components', `${component.name.dashCase}.js`);
-                            ensureDirectoryExistence(chunkPath);
-                            snippets.components[`${component.name.dashCase}`] = Object.assign(Object.assign({}, (snippets.components[`${component.name.dashCase}`] || {})), { js: templateOnlyComponent });
-                            fs_1.default.writeFileSync(chunkPath, templateOnlyComponent);
-                        }
-                    });
-                }
-            });
-            fs_1.default.writeFileSync(path_1.default.join(this.outputPath, 'docfy-output.js'), `export default ${JSON.stringify({ nested: result.nestedPageMetadata })};`);
-            const urlsJsonFile = path_1.default.join(this.outputPath, 'public', 'docfy-urls.json');
-            ensureDirectoryExistence(urlsJsonFile);
-            fs_1.default.writeFileSync(urlsJsonFile, JSON.stringify(result.content.map((page) => page.meta.url)));
-            const snippetsJsonFile = path_1.default.join(this.outputPath, 'public', 'docfy-snippets.json');
-            ensureDirectoryExistence(snippetsJsonFile);
-            fs_1.default.writeFileSync(snippetsJsonFile, JSON.stringify(snippets));
-            result.staticAssets.forEach((asset) => {
-                const dest = path_1.default.join(this.outputPath, 'public', asset.toPath);
-                ensureDirectoryExistence(dest);
-                fs_1.default.copyFileSync(asset.fromPath, dest);
-            });
-        });
-    }
-}
-module.exports = {
-    name: require('../package').name,
-    docfyConfig: undefined,
-    included(...args) {
-        if (!isDeepAddonInstance(this)) {
-            this.docfyConfig = (0, get_config_1.default)(this.project.root);
-            this.bridge = new broccoli_bridge_1.default();
-        }
-        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) {
-        switch (treeType) {
-            case 'app':
-            case 'addon': {
-                return (0, calculate_cache_key_for_tree_1.default)(treeType, this, [this.docfyConfig]);
-            }
-            default:
-                return (0, calculate_cache_key_for_tree_1.default)(treeType, this);
-        }
-    },
-    treeForApp(tree) {
-        const trees = [this._super.treeForApp.call(this, tree)];
-        if (isDeepAddonInstance(this)) {
-            return trees[0];
-        }
-        const inputs = [new broccoli_source_1.UnwatchedDir(this.project.root)];
-        this.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.fulfill('docfy-tree', docfyTree);
-        return new broccoli_merge_trees_1.default(trees, { overwrite: true });
-    },
-    treeForAddon(tree) {
-        const trees = [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 broccoli_file_creator_1.default('output.js', (0, docfy_output_template_1.default)(modulePrefix)));
-        return new broccoli_merge_trees_1.default(trees);
-    },
-    treeForPublic() {
-        if (isDeepAddonInstance(this)) {
-            return;
-        }
-        return new broccoli_funnel_1.default(this.bridge.placeholderFor('docfy-tree'), {
-            srcDir: 'public',
-            destDir: './'
-        });
-    },
-    urlsForPrember(distDir) {
-        try {
-            return require(path_1.default.join(distDir, 'docfy-urls.json')); // eslint-disable-line
-        }
-        catch (_a) {
-            // empty
-        }
-        return [];
-    }
-};

package/lib/plugins/extract-demos-to-components.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;