merged with ember-learn#164

Author: Savannah Mastrangelo

addon/components/docs-demo/template.hbs

@@ -3,7 +3,6 @@
   {{yield (hash
     example=(component 'docs-demo/x-example')
     snippet=(component 'docs-demo/x-snippet' did-init=(action 'registerSnippet') activeSnippet=activeSnippet)
-    live-example=(component 'docs-demo/x-live-example')
   )}}
 
   {{#if snippets}}

addon/components/docs-demo/x-live-example-demo/component.js

@@ -7,7 +7,7 @@ import { addonLogo } from 'ember-cli-addon-docs/utils/computed';
 import { inject as service } from '@ember/service';
 import { reads } from '@ember/object/computed';
 
-const { projectName, projectHref } = config['ember-cli-addon-docs'];
+const { projectName, projectHref, latestVersionName } = config['ember-cli-addon-docs'];
 
 /**
   Render a header showing a link to your documentation, your project logo, a
@@ -36,6 +36,7 @@ export default Component.extend({
   projectVersion: service(),
 
   projectHref,
+  latestVersionName,
 
   didInsertElement() {
     this._super(...arguments);

addon/components/docs-demo/x-live-example/component.js

@@ -25,7 +25,7 @@
       {{#docs-header/link on-click=(action (toggle 'isShowingVersionSelector' this)) data-test-id='current-version'}}
         <span data-version-selector class='flex items-center'>
 
-          {{#if (or (eq currentVersion.name 'latest'))}}
+          {{#if (or (eq currentVersion.name latestVersionName))}}
             {{#if currentVersion.tag}}
               {{currentVersion.tag}}
             {{else}}

addon/components/docs-demo/x-live-example/styles.scss

@@ -3,17 +3,23 @@ import { inject as service } from '@ember/service';
 import layout from './template';
 import { sort } from '@ember/object/computed';
 import { reads } from '@ember/object/computed';
+import config from 'dummy/config/environment';
+
+const { latestVersionName, primaryBranch } = config['ember-cli-addon-docs'];
 
 export default Component.extend({
   layout,
 
+  latestVersionName,
+  primaryBranch,
+
   projectVersion: service(),
   'on-close'() {},
 
   currentVersion: reads('projectVersion.currentVersion'),
 
   sortedVersions: sort('projectVersion.versions', function(a, b) {
-    if (['latest', 'master'].includes(a.name) || ['latest', 'master'].includes(b.name) ) {
+    if ([latestVersionName, primaryBranch].includes(a.name) || [latestVersionName, primaryBranch].includes(b.name) ) {
       return a.name > b.name;
     } else {
       return a.name < b.name;

addon/components/docs-demo/x-live-example/template.hbs

@@ -14,18 +14,18 @@
             {{/if}}
           </span>
           <span class='font-medium'>
-            {{if (eq version.name 'latest') 'Latest' version.name}}
+            {{if (eq version.name latestVersionName) 'Latest' version.name}}
           </span>
 
           <span class="ml-auto pl-8 flex items-center opacity-50">
-            {{#if (or (eq version.name 'latest') (eq version.name 'master'))}}
+            {{#if (or (eq version.name latestVersionName) (eq version.name primaryBranch))}}
               {{svg-jar (if version.tag 'git-tag' 'git-sha') height=16 width=16}}
             {{else}}
               {{svg-jar 'git-sha' height=16 width=16}}
             {{/if}}
 
             <span class='text-xs font-mono pl-1'>
-              {{#if (or (eq version.name 'latest') (eq version.name 'master'))}}
+              {{#if (or (eq version.name latestVersionName) (eq version.name primaryBranch))}}
                 {{#if version.tag}}
                   {{version.tag}}
                 {{else}}

addon/components/docs-header/component.js

@@ -9,7 +9,7 @@ import { getOwner } from '@ember/application';
 
 import layout from './template';
 
-const projectHref = config['ember-cli-addon-docs'].projectHref;
+const { projectHref, primaryBranch } = config['ember-cli-addon-docs'];
 
 const tagToSize = { H2: 'xs', H3: 'xs' };
 const tagToIndent = { H2: '0', H3: '4' };
@@ -76,14 +76,14 @@ export default Component.extend({
       let file = addonFiles.find(f => f.match(path));
 
       if (file) {
-        return `${projectHref}/edit/master/addon/${file}`;
+        return `${projectHref}/edit/${primaryBranch}/addon/${file}`;
       }
     } else {
       let file = appFiles
         .filter(file => file.match(/template.(hbs|md)/))
         .find(file => file.match(path));
 
-      return `${projectHref}/edit/master/tests/dummy/app/${file}`;
+      return `${projectHref}/edit/${primaryBranch}/tests/dummy/app/${file}`;
     }
   })
 

addon/components/docs-header/template.hbs

@@ -2,13 +2,16 @@ import Service, { inject as service } from '@ember/service';
 import { getOwner } from '@ember/application';
 import { computed } from '@ember/object';
 import { task } from 'ember-concurrency';
+import config from 'dummy/config/environment';
+
+const { latestVersionName } = config['ember-cli-addon-docs'];
 
 export default Service.extend({
   docsFetch: service(),
 
   _loadAvailableVersions: task(function*() {
     let response = yield this.get('docsFetch').fetch({ url: `${this.get('root')}versions.json` }).response();
-    let json = yield response.ok ? response.json() : { latest: this.get('currentVersion') };
+    let json = yield response.ok ? response.json() : { [latestVersionName]: this.get('currentVersion') };
 
     this.set('versions', Object.keys(json).map(key => {
       let version = json[key];
@@ -38,7 +41,7 @@ export default Service.extend({
     // In development, this token won't have been replaced replaced
     if (currentVersion === 'ADDON_DOCS_DEPLOY_VERSION') {
       currentVersion = {
-        name: 'latest',
+        name: latestVersionName,
         tag: config.projectTag,
         path: '',
         sha: 'abcde'

addon/components/docs-header/version-selector/component.js

@@ -4,6 +4,6 @@
 const AddonDocsConfig = require('ember-cli-addon-docs/lib/config');
 
 module.exports = class extends AddonDocsConfig {
-  // See https://ember-learn.github.io/ember-cli-addon-docs/latest/docs/deploying
+  // See https://ember-learn.github.io/ember-cli-addon-docs/docs/deploying
   // for details on configuration you can override here.
 };

addon/components/docs-header/version-selector/template.hbs

@@ -2,21 +2,21 @@
 
 const fs = require('fs');
 const path = require('path');
-const resolve = require('resolve');
 const UnwatchedDir = require('broccoli-source').UnwatchedDir;
 const MergeTrees = require('broccoli-merge-trees');
 const Funnel = require('broccoli-funnel');
 const EmberApp = require('ember-cli/lib/broccoli/ember-app'); // eslint-disable-line node/no-unpublished-require
 const Plugin = require('broccoli-plugin');
 const walkSync = require('walk-sync');
 
+const LATEST_VERSION_NAME = '-latest';
+
 module.exports = {
   name: 'ember-cli-addon-docs',
 
+  LATEST_VERSION_NAME,
+
   options: {
-    ace: {
-      modes: ['handlebars']
-    },
     nodeAssets: {
       'highlight.js': {
         public: {
@@ -42,6 +42,7 @@ module.exports = {
   config(env, baseConfig) {
     let repo = this.parent.pkg.repository;
     let info = require('hosted-git-info').fromUrl(repo.url || repo);
+    let userConfig = this._readUserConfig();
 
     let config = {
       'ember-component-css': {
@@ -51,6 +52,8 @@ module.exports = {
         projectName: this.parent.pkg.name,
         projectTag: this.parent.pkg.version,
         projectHref: info && info.browse(),
+        primaryBranch: userConfig.getPrimaryBranch(),
+        latestVersionName: LATEST_VERSION_NAME,
         deployVersion: 'ADDON_DOCS_DEPLOY_VERSION'
       }
     };
@@ -93,13 +96,12 @@ module.exports = {
     includer.options.includeFileExtensionInSnippetNames = includer.options.includeFileExtensionInSnippetNames || false;
     includer.options.snippetSearchPaths = includer.options.snippetSearchPaths || ['tests/dummy/app'];
     includer.options.snippetRegexes = Object.assign({}, {
-      begin: /{{#(?:docs-snippet|demo.example|demo.live-example)\sname=(?:"|')(\S+)(?:"|')/,
-      end: /{{\/(?:docs-snippet|demo.example|demo.live-example)}}/,
+      begin: /{{#(?:docs-snippet|demo.example)\sname=(?:"|')(\S+)(?:"|')/,
+      end: /{{\/(?:docs-snippet|demo.example)}}/,
     }, includer.options.snippetRegexes);
 
     let importer = findImporter(this);
 
-    importer.import(`${this._hasEmberSource() ? 'vendor' : 'bower_components'}/ember/ember-template-compiler.js`);
     importer.import('vendor/lunr/lunr.js', {
       using: [{ transformation: 'amd', as: 'lunr' }]
     });
@@ -112,10 +114,7 @@ module.exports = {
 
   createDeployPlugin() {
     const AddonDocsDeployPlugin = require('./lib/deploy/plugin');
-    const readConfig = require('./lib/utils/read-config');
-
-    let userConfig = readConfig(this.project);
-    return new AddonDocsDeployPlugin(userConfig);
+    return new AddonDocsDeployPlugin(this._readUserConfig());
   },
 
   setupPreprocessorRegistry(type, registry) {
@@ -157,8 +156,7 @@ module.exports = {
     return new MergeTrees([
       vendor,
       this._highlightJSTree(),
-      this._lunrTree(),
-      this._templateCompilerTree()
+      this._lunrTree()
     ].filter(Boolean));
   },
 
@@ -218,17 +216,13 @@ module.exports = {
     });
   },
 
-  _templateCompilerTree() {
-    if (this._hasEmberSource()) {
-      return new Funnel(path.dirname(resolve.sync('ember-source/package.json'), { basedir: this.project.root }), {
-        srcDir: 'dist',
-        destDir: 'ember'
-      });
+  _readUserConfig() {
+    if (!this._userConfig) {
+      const readConfig = require('./lib/utils/read-config');
+      this._userConfig = readConfig(this.project);
     }
-  },
 
-  _hasEmberSource() {
-    return 'ember-source' in this.project.pkg.devDependencies;
+    return this._userConfig;
   }
 };
 

addon/components/docs-viewer/x-main/component.js

@@ -10,6 +10,10 @@ module.exports = class AddonDocsConfig {
     this.repoInfo = gitRepoInfo();
   }
 
+  getPrimaryBranch() {
+    return 'master';
+  }
+
   getRootURL() {
     let repository = this.project.pkg.repository || '';
     let info = hostedGitInfo.fromUrl(repository.url || repository);