host the lint details ourselves. (#6)

* move files into src
* use markdown

Author: paulirish

__tests__/index.js

@@ -1,4 +1,4 @@
-const commitlintbot = require('../');
+const commitlintbot = require('../src/index');
 
 test.skip('commitlint should not throw', async () => {
   const prData = {

__tests__/lint.js

@@ -1,4 +1,4 @@
-const lint = require('../lint');
+const lint = require('../src/lint');
 
 test('commitlint should work', async () => {
 

package.json

@@ -9,7 +9,7 @@
   },
   "scripts": {
     "test": "jest",
-    "start": "node --trace-warnings server.js"
+    "start": "node --trace-warnings src/server.js"
   },
   "files": [
     "dist"
@@ -23,6 +23,7 @@
     "commitlint-config-cz": "^0.5.0",
     "express": "^4.14.0",
     "github-build": "^1.2.0",
+    "marked": "^0.3.19",
     "promise-queue": "^2.2.3",
     "raven": "^2.2.1",
     "require-from-string": "^2.0.1"

default-commitlint.config.js renamed to src/default-commitlint.config.js

@@ -7,19 +7,18 @@ Raven.config(
 ).install();
 
 const requireFromString = require('require-from-string');
-const lhClintConfig = require('./lighthouse.commitlint.config');
 const {getPRTitle, getFileContents} = require('./github');
 
 const lint = require('./lint');
 
 const MAXIMUM_STATUS_LENGTH = 140;
 const czConfigFilename = `.cz-config.js`;
-const czConfigPath = `${__dirname}/${czConfigFilename}`;
+const czConfigPath = `${__dirname}/../${czConfigFilename}`;
 const clintConfigFilename = 'commitlint.config.js';
 
 const baseGithubData = {
   token: process.env.GHTOKEN, // (github oauth token: https://developer.github.com/v3/oauth)
-  label: 'commitlint'
+  label: 'pr title lint'
 };
 
 async function init(prData) {
@@ -42,7 +41,7 @@ async function init(prData) {
       lintOpts.clintConfig = requireFromString(clintConfigContent);
       // FIXME: remove this hack for backwards compatibility
     } else if (githubData.repo.includes('lighthouse')) {
-      lintOpts.clintConfig = lhClintConfig;
+      lintOpts.clintConfig = require('./lighthouse.commitlint.config'); // where even is this
     }
 
     // FIXME: can't write to disk on now.sh. will have to find a workaround.
@@ -89,25 +88,25 @@ async function init(prData) {
     return {status, data: {error}};
   }
 
-  function generateURL(prTitle, reportArr) {
-    const titlePrefix = `Commit message:
+
+}
+
+module.exports = init;
+
+function generateURL(prTitle, reportArr) {
+  const outputStr = `
+### Pull request title
 > ${prTitle}
 
-commitlint results:
-`;
-    const link = `
+### Commitlint results
 
-Expected PR title format is: {type}({optional-scope}): {subject}
+* ${reportArr.join('\n* ')}
 
-See commitlint rules: https://github.com/marionebl/commitlint/blob/master/docs/reference-rules.md`;
-    const preparedString = `${titlePrefix}${reportArr.join('
')}`
-      .replace(/✖/g, '✖')
-      .replace(/✔/g, '✔')
-      .replace(/⚠/g, '⚠');
-    return `https://unhtml.appspot.com/escape?%3Cpre%3E${encodeURIComponent(
-      preparedString
-    )}%3C/pre%3E${encodeURIComponent(link)}`;
-  }
+Expected PR title format is: \`{type}({optional-scope}): {subject}\`
+
+[Full docs of commitlint rules](https://github.com/marionebl/commitlint/blob/master/docs/reference-rules.md)
+    `;
+
+  return `https://commitlintbot.now.sh/details/?msg=${encodeURIComponent(outputStr)}`;
 }
 
-module.exports = init;

github.js renamed to src/github.js

@@ -1,10 +1,11 @@
 const bodyParser = require('body-parser');
 const server = require('express')();
 const Queue = require('promise-queue');
-const {version} = require('./package.json');
+const {version} = require('../package.json');
 const commitlintbot = require('./');
 
 const Raven = require('raven');
+const viewDetails = require('./view-details');
 
 const log = console;
 
@@ -14,6 +15,8 @@ const queue = new Queue(1, process.env.STAGE_CI_MAX_QUEUE || 100);
 // github's webhook MUST use `application/json`
 server.use(bodyParser.json());
 
+server.get('/details/', viewDetails);
+
 server.get('/', (request, response) => {
   response.json({version, queue});
 });