@emdaer/core - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

CHANGELOG.md

@@ -6,2 +6,16 @@ # Change Log
 
+<a name="2.0.1"></a>
+## [2.0.1](https://github.com/emdaer/emdaer/compare/v2.0.0...v2.0.1) (2018-04-14)
+
+
+### Bug Fixes
+
+* **core:** override marked to output md. remove minifier ([9fb0c27](https://github.com/emdaer/emdaer/commit/9fb0c27))
+* **core:** work around marked code fence renderer ([a937f9e](https://github.com/emdaer/emdaer/commit/a937f9e)), closes [#87](https://github.com/emdaer/emdaer/issues/87)
+* syntax highlighting and a couple other things ([6b2be61](https://github.com/emdaer/emdaer/commit/6b2be61))
+
+
+
+
+
 <a name="2.0.0"></a>
@@ -8,0 +22,0 @@ # [2.0.0](https://github.com/emdaer/emdaer/compare/v1.8.13...v2.0.0) (2018-02-21)

lib/index.js

@@ -9,15 +9,22 @@ /*  */
 const identifyTransforms = require('./util/identifyTransforms');
+const markedRenderer = require('./util/markedRenderer');
+const fixCodeFences = require('./util/fixCodeFences');
 
-async function emdaer(origin, content) {
-  return minify(
-    marked(
-      await applyTransforms(
-        await executePlugins(content),
-        await identifyTransforms(content)
-      )
-    ),
-    { removeComments: true }
+async function emdaer(
+  origin,
+  content,
+  options = {
+    marked: true,
+    markedOptions: { renderer: markedRenderer, smartypants: true },
+  }
+) {
+  const readme = await applyTransforms(
+    await executePlugins(content),
+    await identifyTransforms(content)
   );
+  return options.marked
+    ? fixCodeFences(minify(marked(readme, options.markedOptions)))
+    : readme;
 }
 
 module.exports = emdaer;

package.json

 {
   "name": "@emdaer/core",
   "description": "emdaer core",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "repository": "emdaer/emdaer",
@@ -16,5 +16,5 @@ "homepage": "https://emdaer.me/",
   "dependencies": {
-    "html-minifier": "^3.5.8",
+    "html-minifier": "^3.5.14",
     "js-yaml": "3.8.4",
-    "marked": "0.3.9"
+    "marked": "^0.3.19"
   },
@@ -21,0 +21,0 @@ "publishConfig": {

README.md

@@ -9,3 +9,3 @@ <!--
 <p>emdaer core</p>
-
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 <h2 id="executeplugins">executePlugins</h2>
@@ -41,3 +41,3 @@ <p>Finds and executes plugins</p>
 <li><code>code</code> <strong><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></strong> </li>
-<li><code>args</code> <strong>...any</strong> </li>
+<li><code>args</code> <strong>…any</strong> </li>
 </ul>
@@ -79,1 +79,8 @@ <h2 id="applytransforms">applyTransforms</h2>
 <p>Returns <strong><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;&gt;</strong> </p>
+<h2 id="fixcodefences">fixCodeFences</h2>
+<p>Applies transforms to generated content</p>
+<p><strong>Parameters</strong></p>
+<ul>
+<li><code>content</code> <strong><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></strong> </li>
+</ul>
+<p>Returns <strong><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></strong> </p>

src/index.js

@@ -9,15 +9,22 @@ /* @flow */
 const identifyTransforms = require('./util/identifyTransforms');
+const markedRenderer = require('./util/markedRenderer');
+const fixCodeFences = require('./util/fixCodeFences');
 
-async function emdaer(origin: string, content: string) {
-  return minify(
-    marked(
-      await applyTransforms(
-        await executePlugins(content),
-        await identifyTransforms(content)
-      )
-    ),
-    { removeComments: true }
+async function emdaer(
+  origin: string,
+  content: string,
+  options: { marked: boolean, markedOptions: Object } = {
+    marked: true,
+    markedOptions: { renderer: markedRenderer, smartypants: true },
+  }
+) {
+  const readme = await applyTransforms(
+    await executePlugins(content),
+    await identifyTransforms(content)
   );
+  return options.marked
+    ? fixCodeFences(minify(marked(readme, options.markedOptions)))
+    : readme;
 }
 
 module.exports = emdaer;

src/index.test.js

@@ -36,2 +36,21 @@ /* eslint-disable import/no-unresolved, import/no-extraneous-dependencies */
   });
+  it('can skip marked', async () => {
+    expect(
+      await emdaer(
+        './.emdaer/README.emdaer.md',
+        `# <!--emdaer-p
+  - '@emdaer/plugin-foo'
+  - a: 0
+    b: 1
+    c: 2
+-->
+
+<!--emdaer-t
+  - '@emdaer/transform-bar'
+-->
+`,
+        { marked: false }
+      )
+    ).toMatchSnapshot();
+  });
 });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

43591

increased by11.06%

Number of package files

42

increased by16.67%

Lines of code

693

increased by16.67%

Number of lines in readme file

84

increased by9.09%

Worsened metrics

Number of medium maintenance alerts

1

increased byInfinity%

Dependency changes

• + Addedmarked@0.3.19(transitive)

• - Removedmarked@0.3.9(transitive)

• Updatedhtml-minifier@^3.5.14

• Updatedmarked@^0.3.19