@docfy/ember 0.6.0 → 0.7.0

package/docs/components/docfy-output-demo/edit-page.md

@@ -20,3 +20,35 @@ repository URL as well as the branch to edit.
   {{/if}}
 </DocfyOutput>
 ```
+
+For this to work, you need to include `repository` in your docfy-config:
+
+```js
+// in your docfy-config.js
+module.exports = {
+  repository: {
+    url: 'https://github.com/@username/repo-name',
+    editBranch: 'main',
+  },
+  ...// rest of your config
+}
+```
+
+
+## Enterprise (aka on premise) git services
+
+`page.editUrl` works for Github, Bitbucket, Gitlab and Sourcehut.
+
+For on-premise instances git solutions (i.e. on-premise Gitlab, or on-premise Bitbucket), we expose the `page.relativePath` so that you might construct your own custom editUrl:
+
+```hbs 
+<DocfyOutput @fromCurrentURL={{true}} as |page|>
+  {{#if page.relativePath}}
+    <a href=(concat "http://some-enterpise.com/browse/" page.relativePath)
+      Click here to edit this page
+    </a>
+  {{/if}}
+</DocfyOutput>
+```
+
+Note: the edit url for your on-premise instance might be more complex than the example above. But the `page.relativePath` will give you the relative path to that file in your repo. 

package/lib/index.js

@@ -63,12 +63,16 @@ class DocfyBroccoli extends broccoli_plugin_1.default {
             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;
@@ -77,11 +81,13 @@ class DocfyBroccoli extends broccoli_plugin_1.default {
                         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);
                         }
                     });
@@ -91,6 +97,9 @@ class DocfyBroccoli extends broccoli_plugin_1.default {
             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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docfy/ember",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Ember integration with Docfy",
   "keywords": [
     "ember-addon",
@@ -30,7 +30,7 @@
     "test:ember-compatibility": "echo 'ember try:each TODO'"
   },
   "dependencies": {
-    "@docfy/core": "^0.6.0",
+    "@docfy/core": "^0.7.0",
     "broccoli-bridge": "^1.0.0",
     "broccoli-file-creator": "^2.1.1",
     "broccoli-funnel": "^3.0.8",
@@ -52,7 +52,7 @@
   },
   "devDependencies": {
     "@babel/helper-define-map": "^7.16.7",
-    "@docfy/plugin-with-prose": "^0.6.0",
+    "@docfy/plugin-with-prose": "^0.7.0",
     "@ember/optional-features": "^2.0.0",
     "@ember/test-helpers": "^2.6.0",
     "@embroider/compat": "^1.0.0",
@@ -135,5 +135,5 @@
       "prember"
     ]
   },
-  "gitHead": "3745bd3c8c45202a0c11d8fd502b52a5e3f62493"
+  "gitHead": "d24cfd0a838a890c850d0030ec30856d0608267c"
 }

package/src/index.ts

@@ -60,7 +60,9 @@ class DocfyBroccoli extends Plugin {
     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];
 
@@ -70,6 +72,7 @@ class DocfyBroccoli extends Plugin {
 
       const fileName = `${path.join(...parts)}.hbs`;
 
+      // console.log(fileName, "RENDERED AS", page.rendered);
       ensureDirectoryExistence(fileName);
       fs.writeFileSync(fileName, page.rendered);
 
@@ -83,6 +86,11 @@ class DocfyBroccoli extends Plugin {
               `${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);
           });
 
@@ -93,6 +101,10 @@ class DocfyBroccoli extends Plugin {
               `${component.name.dashCase}.js`
             );
             ensureDirectoryExistence(chunkPath);
+            snippets.components[`${component.name.dashCase}`] = {
+              ...(snippets.components[`${component.name.dashCase}`] || {}),
+              js: templateOnlyComponent
+            };
             fs.writeFileSync(chunkPath, templateOnlyComponent);
           }
         });
@@ -109,11 +121,19 @@ class DocfyBroccoli extends Plugin {
       '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);