Merge pull request #114 from spencer516/update-demo-url

Add `homepage` to add-on config in default blueprint

Author: samselikoff

blueprints/ember-cli-addon-docs/index.js

@@ -1,6 +1,8 @@
 'use strict';
 
 const fs = require('fs-extra');
+const path = require('path');
+const updateDemoUrl = require('../../lib/utils/update-demo-url');
 
 module.exports = {
   name: 'ember-cli-addon-docs',
@@ -39,7 +41,7 @@ module.exports = {
     }
 
     fs.writeFileSync(configPath, configContents, 'utf-8');
-    
+
     if (fs.existsSync('.npmignore')) {
       this.insertIntoFile('.npmignore', '/config/addon-docs.js');
     }
@@ -50,10 +52,20 @@ module.exports = {
       return isPlugin || isPluginPack;
     });
 
+    const packageJsonPath = path.join(this.project.root, 'package.json');
+    const updatedDemoUrl = updateDemoUrl(packageJsonPath);
+
+    if (!updatedDemoUrl) {
+      this.ui.writeWarnLine(
+        `Unable to update the "homepage" configuration in your package.json. To include this for ` +
+        `including a link on Ember Observer, set it to https://{ORGANIZATION}.github.io/{REPO}`
+      );
+    }
+
     if (!hasPlugins) {
       return this.addAddonsToProject({
         packages: ['ember-cli-addon-docs-yuidoc']
-      })
+      });
     }
   }
 };

lib/utils/update-demo-url.js

@@ -0,0 +1,42 @@
+'use strict';
+
+const fs = require('fs-extra');
+const hostedGitInfo = require('hosted-git-info');
+const parseGitConfig = require('parse-git-config');
+
+function gitConfigUrl(configPath) {
+  const options = configPath ? { path: configPath } : {};
+  const config = parseGitConfig.sync(options);
+  const originProp = Object.keys(config).find(key => /^remote/.test(key));
+
+  return originProp ? config[originProp].url : '';
+}
+
+function repoFromPackage(packageJson) {
+  const repo = packageJson.repository;
+  return typeof repo === 'object' ? repo.url : repo;
+}
+
+module.exports = function updateDemoUrl(packageJsonPath, gitConfigPath) {
+  const packageJson = fs.readJsonSync(packageJsonPath);
+
+  // https://docs.npmjs.com/files/package.json#homepage
+  if (packageJson.homepage) {
+    return true;
+  }
+
+  const repo = repoFromPackage(packageJson) || gitConfigUrl(gitConfigPath);
+  const gitInfo = hostedGitInfo.fromUrl(repo);
+
+  if (gitInfo) {
+    packageJson.homepage = `https://${gitInfo.user}.github.io/${gitInfo.project}`;
+
+    fs.writeJSONSync(packageJsonPath, packageJson, {
+      spaces: 2
+    });
+
+    return true;
+  } else {
+    return false;
+  }
+}

package.json

@@ -61,6 +61,7 @@
     "lodash": "^4.17.5",
     "lunr": "^2.1.5",
     "marked": "^0.3.12",
+    "parse-git-config": "^1.1.1",
     "quick-temp": "^0.1.8",
     "resolve": "^1.5.0",
     "semver": "^5.5.0",

tests-node/fixtures/update-demo-url/has-existing-homepage/input.json

@@ -0,0 +1,4 @@
+{
+  "repository": "https://github.com/ember-learn/ember-cli-addon-docs",
+  "homepage": "https://www.somewhere-else.com"
+}

tests-node/fixtures/update-demo-url/has-existing-homepage/output.json

@@ -0,0 +1,4 @@
+{
+  "repository": "https://github.com/ember-learn/ember-cli-addon-docs",
+  "homepage": "https://www.somewhere-else.com"
+}

tests-node/fixtures/update-demo-url/has-git-repository-object/input.json

@@ -0,0 +1,5 @@
+{
+  "repository": {
+    "url": "https://github.com/ember-learn/ember-cli-addon-docs"
+  }
+}

tests-node/fixtures/update-demo-url/has-git-repository-object/output.json

@@ -0,0 +1,6 @@
+{
+  "repository": {
+    "url": "https://github.com/ember-learn/ember-cli-addon-docs"
+  },
+  "homepage": "https://ember-learn.github.io/ember-cli-addon-docs"
+}

tests-node/fixtures/update-demo-url/has-git-repository/git-config

@@ -0,0 +1,3 @@
+[remote "origin"]
+	url = git@github.com:ember-learn/ember-cli-addon-docs.git
+	fetch = +refs/heads/*:refs/remotes/origin/*

tests-node/fixtures/update-demo-url/has-git-repository/input.json

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

tests-node/fixtures/update-demo-url/has-git-repository/output.json

@@ -0,0 +1,3 @@
+{
+  "homepage": "https://ember-learn.github.io/ember-cli-addon-docs"
+}