Expose compileMarkdown as public API

- closes #318

Author: samselikoff

.eslintrc.js

@@ -36,7 +36,8 @@ module.exports = {
         'config/**/*.js',
         'lib/**/*.js',
         'tests/dummy/config/**/*.js',
-        'tests-node/**/*.js'
+        'tests-node/**/*.js',
+        'addon-docs-shared/**/*.js'
       ],
       excludedFiles: [
         'addon/**',

lib/utils/compile-markdown.js renamed to addon-docs-shared/compile-markdown.js

@@ -0,0 +1,9 @@
+{
+  "name": "addon-docs-shared",
+  "description": "Common code used at both build time and run time",
+  "version": "1.0.0",
+  "dependencies": {
+    "marked": "*",
+    "highlight.js": "*"
+  }
+}

addon-docs-shared/node_modules/.bin

@@ -0,0 +1,3 @@
+import compileMarkdown from 'addon-docs-shared/compile-markdown';
+
+export default compileMarkdown;

addon-docs-shared/package.json

@@ -9,6 +9,9 @@ const EmberApp = require('ember-cli/lib/broccoli/ember-app'); // eslint-disable-
 const Plugin = require('broccoli-plugin');
 const walkSync = require('walk-sync');
 const buildTailwind = require('ember-cli-tailwind/lib/build-tailwind');
+// const foo = require('addon-docs-shared/foo');
+
+// foo();
 
 const LATEST_VERSION_NAME = '-latest';
 

addon/utils/compile-markdown.js

@@ -7,7 +7,7 @@ const CachingWriter = require('broccoli-caching-writer');
 
 const Serializer = require('../serializers/main');
 
-const compileMarkdown = require('../utils/compile-markdown');
+const compileMarkdown = require('addon-docs-shared//compile-markdown');
 const NavigationIndexGenerator = require('./docs-compiler/navigation-index-generator');
 
 function compileDescriptions(objects) {

index.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const stew = require('broccoli-stew');
-const compileMarkdown = require('../utils/compile-markdown');
+const compileMarkdown = require('addon-docs-shared/compile-markdown');
 
 module.exports = class MarkdownTemplateCompiler {
   constructor() {

lib/broccoli/docs-compiler.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const compileMarkdown = require('./compile-markdown');
+const compileMarkdown = require('addon-docs-shared/compile-markdown');
 
 module.exports = function compileDescriptions(docs) {
   for (let doc of docs) {

lib/preprocessors/markdown-template-compiler.js

@@ -26,6 +26,7 @@
   },
   "dependencies": {
     "@glimmer/syntax": "^0.36.4",
+    "addon-docs-shared": "./addon-docs-shared",
     "broccoli-bridge": "^1.0.0",
     "broccoli-caching-writer": "^3.0.3",
     "broccoli-debug": "^0.6.4",
@@ -36,6 +37,7 @@
     "broccoli-plugin": "^1.3.1",
     "broccoli-source": "^1.1.0",
     "broccoli-stew": "^2.0.0",
+    "ember-auto-import": "^1.2.19",
     "ember-cli-autoprefixer": "^0.8.1",
     "ember-cli-babel": "^6.16.0",
     "ember-cli-clipboard": "^0.11.1",
@@ -116,7 +118,7 @@
     "eslint-plugin-node": "^7.0.1",
     "loader.js": "^4.7.0",
     "qunit": "^2.6.2",
-    "qunit-dom": "^0.8.0"
+    "qunit-dom": "^0.8.4"
   },
   "resolutions": {
     "**/tough-cookie": "~2.4.0",

lib/utils/compile-doc-descriptions.js

@@ -20,3 +20,22 @@ for package in "new-addon"; do
     ln -s ../../.. ./ember-cli-addon-docs
     popd > /dev/null
 done
+
+##################################################
+#
+# addon-docs-shared setup
+#
+#
+# Link it, so its packages can be used in node & ember
+mkdir -p ./node_modules
+pushd ./node_modules > /dev/null
+rm -rf ./addon-docs-shared
+ln -s ../addon-docs-shared ./addon-docs-shared
+popd > /dev/null
+
+# Give it a node_modules directory and a .bin link, so it can find its dependencies
+mkdir -p ./addon-docs-shared/node_modules
+rm -rf ./addon-docs-shared/node_modules/.bin
+ln -s ./node_modules/.bin ./addon-docs-shared/node_modules/.bin
+#
+##################################################

package.json

@@ -44,7 +44,8 @@
     "ember-try": "*",
     "eslint-plugin-ember": "*",
     "eslint-plugin-node": "*",
-    "loader.js": "*"
+    "loader.js": "*",
+    "qunit-dom": "*"
   },
   "engines": {
     "node": "^4.5 || 6.* || >= 7.*"

scripts/link-them.sh

@@ -0,0 +1,30 @@
+import { module, test } from 'qunit';
+import { visit, currentURL } from '@ember/test-helpers';
+import { setupApplicationTest } from 'ember-qunit';
+
+module('Acceptance | sanity checks test', function(hooks) {
+  setupApplicationTest(hooks);
+
+  test('the dummy app boots', async function(assert) {
+    await visit('/');
+
+    assert.equal(currentURL(), '/');
+  });
+
+  test('the --brand-primary css variable works', async function(assert) {
+    await visit('/');
+
+    assert.dom(`.docs-bg-brand`).hasStyle({
+      backgroundColor: 'rgb(0, 128, 0)'
+    });
+  });
+
+  test('the compileMarkdown function works', async function(assert) {
+    await visit('/route-using-compile-markdown');
+
+    assert.dom(`.docs-md`).includesText('In the beginning');
+    assert.dom(`pre`).hasStyle({
+      backgroundColor: 'rgb(40, 44, 52)'
+    });
+  });
+});

test-apps/new-addon/package.json

@@ -0,0 +1,29 @@
+import Controller from '@ember/controller';
+import { computed } from '@ember/object';
+import compileMarkdown from 'ember-cli-addon-docs/utils/compile-markdown';
+import { htmlSafe } from '@ember/string';
+
+export default Controller.extend({
+
+  body: `In the beginning, we could only use
+
+\`\`\`js
+function foo() {
+  console.log('bar');
+}
+\`\`\`
+
+Now, we can use
+
+\`\`\`js
+const foo = () => {
+  console.log('bar');
+});
+\`\`\`
+`,
+
+  htmlBody: computed('body', function() {
+    return htmlSafe(compileMarkdown(this.body));
+  })
+
+});

test-apps/new-addon/tests/acceptance/sanity-checks-test.js

@@ -7,6 +7,8 @@ const Router = AddonDocsRouter.extend({
 });
 
 Router.map(function() {
+  this.route('route-using-compile-markdown');
+
   docsRoute(this, function() {
 
   });

test-apps/new-addon/tests/acceptance/smoke-test-test.js

@@ -0,0 +1,7 @@
+<div style="max-width: 800px; margin: 3rem auto;">
+  <h1>AddonDocs' markdown compiler</h1>
+
+  <p>Here's some markdown, compiled using AddonDocs' markdown compiler & syntax highlighting:</p>
+
+  {{htmlBody}}
+</div>

test-apps/new-addon/tests/dummy/app/controllers/route-using-compile-markdown.js

@@ -2,7 +2,7 @@
 
 const QUnit = require('qunit'), test = QUnit.test;
 const stripIndent = require('common-tags').stripIndent;
-const compileMarkdown = require('../../../lib/utils/compile-markdown');
+const compileMarkdown = require('addon-docs-shared/compile-markdown');
 
 QUnit.module('Unit | compile-markdown', function(hooks) {
   test('compacting curly paragraphs', function(assert) {

test-apps/new-addon/tests/dummy/app/router.js

@@ -0,0 +1,13 @@
+import Route from '@ember/routing/route';
+// import renderMarkdown from 'ember-cli-addon-docs/utils/render-markdown';
+// import foo from 'addon-docs-shared/foo';
+
+export default Route.extend({
+
+  model() {
+    // foo();
+    // console.log('hi from route');
+    // console.log(renderMarkdown);
+  }
+
+});