@docfy/ember 0.4.4 → 0.4.8

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

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

package/lib/index.js

@@ -24,6 +24,7 @@ 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 templateOnlyComponent = `
@@ -108,6 +109,18 @@ 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) {
+        switch (treeType) {
+            case 'app':
+            case 'addon': {
+                return calculate_cache_key_for_tree_1.default(treeType, this, [this.docfyConfig]);
+            }
+            default:
+                return calculate_cache_key_for_tree_1.default(treeType, this);
+        }
+    },
     treeForApp(tree) {
         const trees = [this._super.treeForApp.call(this, tree)];
         if (isDeepAddonInstance(this)) {

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

@@ -56,7 +56,10 @@ exports.default = plugin_1.default({
                             });
                         }
                     });
-                    const componentName = utils_1.generateDemoComponentName(`docfy-demo-${path_1.default.basename(page.source).split('.')[0]}-${path_1.default.basename(demo.source).split('.')[0]}`, seenNames);
+                    // 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);
                     if (demoTitle) {
                         demoTitle.depth = 3;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docfy/ember",
-  "version": "0.4.4",
+  "version": "0.4.8",
   "description": "Ember integration with Docfy",
   "keywords": [
     "ember-addon",
@@ -38,6 +38,7 @@
     "broccoli-node-api": "^1.7.0",
     "broccoli-plugin": "^4.0.3",
     "broccoli-source": "^3.0.0",
+    "calculate-cache-key-for-tree": "2.0.0",
     "debug": "^4.3.1",
     "ember-cli-babel": "^7.23.1",
     "ember-cli-htmlbars": "^5.3.1",
@@ -121,5 +122,5 @@
       "prember"
     ]
   },
-  "gitHead": "0a5553db528f22491f703c45a66be3073f59217a"
+  "gitHead": "367f4946c144db8c5ef4e03fe44ba7450c89849e"
 }

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

@@ -71,8 +71,13 @@ export default plugin({
               });
             }
           });
+
+          // 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-${path.basename(page.source).split('.')[0]}-${
+            `docfy-demo-${baseName}-${
               path.basename(demo.source).split('.')[0]
             }`,
             seenNames