@docfy/ember 0.4.5 → 0.5.0

package/helpers/docfy-eq.d.ts

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

package/lib/index.js

@@ -24,8 +24,9 @@ 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 = debug_1.default('@docfy/ember');
+const debug = (0, debug_1.default)('@docfy/ember');
 const templateOnlyComponent = `
 import Component from '@glimmer/component';
 export default class extends Component {}
@@ -71,7 +72,7 @@ class DocfyBroccoli extends broccoli_plugin_1.default {
                 ensureDirectoryExistence(fileName);
                 fs_1.default.writeFileSync(fileName, page.rendered);
                 const demoComponents = page.pluginData.demoComponents;
-                if (utils_1.isDemoComponents(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}`);
@@ -103,11 +104,23 @@ module.exports = {
     docfyConfig: undefined,
     included(...args) {
         if (!isDeepAddonInstance(this)) {
-            this.docfyConfig = get_config_1.default(this.project.root);
+            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)) {
@@ -131,7 +144,7 @@ module.exports = {
         }
         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', docfy_output_template_1.default(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() {

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

@@ -18,8 +18,7 @@ const path_1 = __importDefault(require("path"));
  * 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];
+    const heading = ctx.remark.runSync(ctx.remark.parse('## Examples')).children[0];
     heading.depth = 2;
     return heading;
 }
@@ -28,7 +27,7 @@ function createHeading(ctx) {
  */
 function insertDemoNodesIntoPage(page, toInsert) {
     if (Array.isArray(page.ast.children)) {
-        const secondHeading = unist_util_find_1.default(page.ast, (node) => node.type === 'heading' && node.depth !== 1);
+        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);
@@ -38,7 +37,7 @@ function insertDemoNodesIntoPage(page, toInsert) {
         }
     }
 }
-exports.default = plugin_1.default({
+exports.default = (0, plugin_1.default)({
     runWithMdast(ctx) {
         const seenNames = new Set();
         ctx.pages.forEach((page) => {
@@ -46,12 +45,12 @@ exports.default = plugin_1.default({
                 const demoComponents = [];
                 page.demos.forEach((demo) => {
                     const chunks = [];
-                    unist_util_visit_1.default(demo.ast, 'code', (node) => {
+                    (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: utils_1.getExt(node.lang || (node.meta === 'template' ? 'hbs' : 'js')),
+                                ext: (0, utils_1.getExt)(node.lang || (node.meta === 'template' ? 'hbs' : 'js')),
                                 type: node.meta
                             });
                         }
@@ -59,8 +58,8 @@ exports.default = plugin_1.default({
                     // 1. exclude extension
                     // 2. remove /index.md because of web conventions
                     const baseName = page.source.replace('/index.md', '').split('.')[0];
-                    const componentName = utils_1.generateDemoComponentName(`docfy-demo-${baseName}-${path_1.default.basename(demo.source).split('.')[0]}`, seenNames);
-                    const demoTitle = unist_util_find_1.default(demo.ast, (node) => node.type === 'heading' && node.depth === 1);
+                    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
@@ -70,22 +69,22 @@ exports.default = plugin_1.default({
                         name: componentName,
                         chunks,
                         description: {
-                            title: demoTitle ? mdast_util_to_string_1.default(demoTitle) : undefined,
+                            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 }) => {
-                        utils_1.deleteNode(demo.ast.children, snippet);
+                        (0, utils_1.deleteNode)(demo.ast.children, snippet);
                     });
                 });
                 const toInsert = [createHeading(ctx)];
                 demoComponents.forEach((component) => {
-                    toInsert.push(...utils_1.createDemoNodes(component));
+                    toInsert.push(...(0, utils_1.createDemoNodes)(component));
                 });
                 insertDemoNodesIntoPage(page, toInsert);
-                if (utils_1.isDemoComponents(page.pluginData.demoComponents)) {
+                if ((0, utils_1.isDemoComponents)(page.pluginData.demoComponents)) {
                     page.pluginData.demoComponents.push(...demoComponents);
                 }
                 else {

package/lib/plugins/preview-template.js

@@ -7,20 +7,20 @@ 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 = plugin_1.default({
+exports.default = (0, plugin_1.default)({
     runWithMdast(ctx) {
         const seenNames = new Set();
         ctx.pages.forEach((page) => {
             const demoComponents = [];
-            unist_util_visit_1.default(page.ast, 'code', (node) => {
+            (0, unist_util_visit_1.default)(page.ast, 'code', (node) => {
                 if (['preview-template'].includes(node.meta || '')) {
                     demoComponents.push({
-                        name: utils_1.generateDemoComponentName(`docfy-demo-preview-${path_1.default.basename(page.meta.url)}`, seenNames),
+                        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: utils_1.getExt(node.lang || 'hbs'),
+                                ext: (0, utils_1.getExt)(node.lang || 'hbs'),
                                 type: node.meta
                             }
                         ]
@@ -28,9 +28,9 @@ exports.default = plugin_1.default({
                 }
             });
             demoComponents.forEach((demoComponent) => {
-                utils_1.replaceNode(page.ast.children, demoComponent.chunks[0].snippet, ...utils_1.createDemoNodes(demoComponent));
+                (0, utils_1.replaceNode)(page.ast.children, demoComponent.chunks[0].snippet, ...(0, utils_1.createDemoNodes)(demoComponent));
             });
-            if (utils_1.isDemoComponents(page.pluginData.demoComponents)) {
+            if ((0, utils_1.isDemoComponents)(page.pluginData.demoComponents)) {
                 page.pluginData.demoComponents.push(...demoComponents);
             }
             else {

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

@@ -7,7 +7,7 @@ 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) {
-    unist_util_visit_1.default(page.ast, 'link', (node, index, parent) => {
+    (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 = {}));
@@ -18,9 +18,9 @@ function visitor(page) {
             })
                 .join(' ');
             const toInsert = [
-                unist_builder_1.default('html', `<DocfyLink @to="${urlParts[0]}" ${urlParts[1] ? `@anchor="${urlParts[1]}"` : ''} ${attributes}>`),
+                (0, unist_builder_1.default)('html', `<DocfyLink @to="${urlParts[0]}" ${urlParts[1] ? `@anchor="${urlParts[1]}"` : ''} ${attributes}>`),
                 ...node.children,
-                unist_builder_1.default('html', `</DocfyLink>`)
+                (0, unist_builder_1.default)('html', `</DocfyLink>`)
             ];
             parent === null || parent === void 0 ? void 0 : parent.children.splice(index, 1, ...toInsert);
         }
@@ -30,7 +30,7 @@ function visitor(page) {
  * This function finds all the links starting with an `/` and replace them with
  * the `DocfyLink` component.
  */
-exports.default = plugin_1.default({
+exports.default = (0, plugin_1.default)({
     runWithMdast(ctx) {
         ctx.pages.forEach((page) => {
             visitor(page);

package/lib/plugins/utils.js

@@ -27,30 +27,30 @@ const unist_builder_1 = __importDefault(require("unist-builder"));
  */
 function createDemoNodes(component) {
     const nodes = [
-        unist_builder_1.default('html', `<DocfyDemo @id="${component.name.dashCase}" as |demo|>`)
+        (0, unist_builder_1.default)('html', `<DocfyDemo @id="${component.name.dashCase}" as |demo|>`)
     ];
     if (component.description) {
-        nodes.push(unist_builder_1.default('html', `<demo.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, unist_builder_1.default('html', '</demo.Description>'));
+            : ''}>`), component.description.ast, (0, unist_builder_1.default)('html', '</demo.Description>'));
     }
-    nodes.push(unist_builder_1.default('html', '<demo.Example>'), unist_builder_1.default('html', `<${component.name.pascalCase} />`), unist_builder_1.default('html', '</demo.Example>'));
+    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(unist_builder_1.default('html', '<demo.Snippets as |Snippet|>'));
+        nodes.push((0, unist_builder_1.default)('html', '<demo.Snippets as |Snippet|>'));
         component.chunks.forEach((chunk) => {
-            nodes.push(unist_builder_1.default('html', `<Snippet @name="${chunk.type}">`), chunk.snippet, unist_builder_1.default('html', '</Snippet>'));
+            nodes.push((0, unist_builder_1.default)('html', `<Snippet @name="${chunk.type}">`), chunk.snippet, (0, unist_builder_1.default)('html', '</Snippet>'));
         });
-        nodes.push(unist_builder_1.default('html', '</demo.Snippets>'));
+        nodes.push((0, unist_builder_1.default)('html', '</demo.Snippets>'));
     }
     else {
         component.chunks.forEach((chunk) => {
-            nodes.push(unist_builder_1.default('html', `<demo.Snippet @name="${chunk.type}">`), chunk.snippet, unist_builder_1.default('html', '</demo.Snippet>'));
+            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(unist_builder_1.default('html', '</DocfyDemo>'));
+    nodes.push((0, unist_builder_1.default)('html', '</DocfyDemo>'));
     return nodes;
 }
 exports.createDemoNodes = createDemoNodes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docfy/ember",
-  "version": "0.4.5",
+  "version": "0.5.0",
   "description": "Ember integration with Docfy",
   "keywords": [
     "ember-addon",
@@ -30,80 +30,94 @@
     "test:ember-compatibility": "echo 'ember try:each TODO'"
   },
   "dependencies": {
-    "@docfy/core": "^0.4.4",
+    "@docfy/core": "^0.5.0",
     "broccoli-bridge": "^1.0.0",
     "broccoli-file-creator": "^2.1.1",
-    "broccoli-funnel": "^3.0.3",
+    "broccoli-funnel": "^3.0.8",
     "broccoli-merge-trees": "^4.2.0",
     "broccoli-node-api": "^1.7.0",
-    "broccoli-plugin": "^4.0.3",
-    "broccoli-source": "^3.0.0",
-    "debug": "^4.3.1",
-    "ember-cli-babel": "^7.23.1",
-    "ember-cli-htmlbars": "^5.3.1",
-    "ember-cli-typescript": "^4.0.0",
-    "ember-get-config": "^0.3.0",
+    "broccoli-plugin": "^4.0.7",
+    "broccoli-source": "^3.0.1",
+    "calculate-cache-key-for-tree": "2.0.0",
+    "debug": "^4.3.3",
+    "ember-cli-babel": "^7.26.11",
+    "ember-cli-htmlbars": "^6.0.1",
+    "ember-cli-typescript": "^4.2.1",
+    "ember-get-config": "^1.0.2",
     "mdast-util-to-string": "^2.0.0",
-    "remark-hbs": "^0.4.0",
+    "remark-hbs": "^0.4.1",
     "unist-builder": "^2.0.3",
     "unist-util-find": "^1.0.2",
     "unist-util-visit": "^2.0.2"
   },
   "devDependencies": {
-    "@docfy/plugin-with-prose": "^0.4.4",
+    "@babel/helper-define-map": "^7.16.7",
+    "@docfy/plugin-with-prose": "^0.5.0",
     "@ember/optional-features": "^2.0.0",
-    "@ember/test-helpers": "^2.1.4",
-    "@embroider/compat": "^0.36.0",
-    "@embroider/core": "^0.36.0",
-    "@embroider/webpack": "^0.36.0",
-    "@glimmer/component": "^1.0.3",
-    "@glimmer/tracking": "^1.0.3",
+    "@ember/test-helpers": "^2.6.0",
+    "@embroider/compat": "^1.0.0",
+    "@embroider/core": "^1.0.0",
+    "@embroider/webpack": "^1.0.0",
+    "@glimmer/component": "^1.0.4",
+    "@glimmer/tracking": "^1.0.4",
     "@mapbox/rehype-prism": "^0.5.0",
     "@tailwindcss/typography": "^0.4.0",
-    "@types/debug": "^4.1.5",
-    "@types/ember": "^3.16.3",
-    "@types/ember-qunit": "^3.4.13",
-    "@types/ember__test-helpers": "^1.7.3",
-    "@types/jest": "^26.0.20",
-    "@types/qunit": "^2.11.1",
-    "@types/rsvp": "^4.0.3",
+    "@types/ember-qunit": "^5.0.0",
+    "@types/ember-resolver": "^5.0.11",
+    "@types/ember__application": "^4.0.0",
+    "@types/ember__array": "^4.0.1",
+    "@types/ember__component": "^4.0.1",
+    "@types/ember__debug": "^4.0.0",
+    "@types/ember__error": "^4.0.0",
+    "@types/ember__object": "^4.0.0",
+    "@types/ember__routing": "^4.0.2",
+    "@types/ember__runloop": "^4.0.0",
+    "@types/ember__service": "^4.0.0",
+    "@types/ember__string": "^3.0.9",
+    "@types/ember__template": "^4.0.0",
+    "@types/ember__test": "^4.0.0",
+    "@types/ember__test-helpers": "^2.6.1",
+    "@types/htmlbars-inline-precompile": "^3.0.0",
+    "@types/qunit": "^2.11.3",
+    "@types/rsvp": "^4.0.4",
     "@types/sinon": "^9.0.10",
-    "autoprefixer": "^10.2.4",
+    "autoprefixer": "^10.4.2",
     "broccoli-asset-rev": "^3.0.0",
-    "ember-auto-import": "^1.10.1",
-    "ember-cli": "~3.24.0",
+    "ember-auto-import": "^2.4.0",
+    "ember-cli": "~4.1.1",
     "ember-cli-dependency-checker": "^3.2.0",
-    "ember-cli-fastboot": "^2.2.3",
-    "ember-cli-fastboot-testing": "^0.4.0",
-    "ember-cli-inject-live-reload": "^2.0.2",
-    "ember-cli-postcss": "^7.0.0",
+    "ember-cli-fastboot": "^3.2.0-beta.5",
+    "ember-cli-fastboot-testing": "^0.6.0",
+    "ember-cli-inject-live-reload": "^2.1.0",
+    "ember-cli-postcss": "^8.0.0",
     "ember-cli-sri": "^2.1.1",
     "ember-cli-typescript-blueprints": "^3.0.0",
     "ember-cli-uglify": "^3.0.0",
     "ember-disable-prototype-extensions": "^1.1.3",
     "ember-export-application-global": "^2.0.1",
     "ember-load-initializers": "^2.1.2",
-    "ember-maybe-import-regenerator": "^0.1.6",
-    "ember-qunit": "^5.1.1",
-    "ember-resolver": "^8.0.2",
+    "ember-maybe-import-regenerator": "^1.0.0",
+    "ember-qunit": "^5.1.5",
+    "ember-resolver": "^8.0.3",
     "ember-router-helpers": "^0.4.0",
     "ember-sinon": "^5.0.0",
-    "ember-source": "~3.24.1",
+    "ember-source": "~4.1.0",
     "ember-source-channel-url": "^3.0.0",
     "ember-template-lint": "^2.18.0",
-    "ember-try": "^1.4.0",
+    "ember-try": "^2.0.0",
     "loader.js": "^4.7.0",
     "npm-run-all": "^4.1.5",
-    "postcss-import": "^14.0.0",
-    "postcss-nested": "^5.0.3",
-    "prember": "^1.0.5",
-    "qunit": "^2.14.0",
-    "qunit-dom": "^1.6.0",
-    "refractor": "^3.3.1",
+    "postcss-import": "^14.0.2",
+    "postcss-nested": "^5.0.6",
+    "prember": "^1.1.0",
+    "qunit": "^2.17.2",
+    "qunit-dom": "^2.0.0",
+    "refractor": "^3.0.0",
     "remark-autolink-headings": "^6.0.0",
     "remark-code-import": "^0.2.0",
     "tailwindcss": "^2.0.2",
-    "typescript": "^4.1.3"
+    "typescript": "^4.1.3",
+    "webpack": "^5.67.0"
   },
   "engines": {
     "node": ">= 12"
@@ -121,5 +135,5 @@
       "prember"
     ]
   },
-  "gitHead": "000552c8389ba2104c9ad44f51dea4d5a1c1e51b"
+  "gitHead": "660408a83302ec4dc727acc0339a506fe0316b54"
 }

package/src/index.ts

@@ -13,6 +13,7 @@ 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');
 
@@ -134,6 +135,19 @@ module.exports = {
     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)) {

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

@@ -23,8 +23,9 @@ import path from 'path';
  * 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];
+  const heading = (
+    ctx.remark.runSync(ctx.remark.parse('## Examples')).children as Node[]
+  )[0];
   heading.depth = 2;
   return heading;
 }

package/tsconfig.json

@@ -9,6 +9,7 @@
     "alwaysStrict": true,
     "strictNullChecks": true,
     "strictPropertyInitialization": true,
+    "skipLibCheck": true,
     "noFallthroughCasesInSwitch": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,