feat(prism): caption

README.md

@@ -451,6 +451,7 @@ Option | Description | Default
 `isPreprocess` | Enable preprocess or not | true
 `mark` | Highlight specific line |
 `firstLine` | First line number |
+`caption` | Caption |
 
 When `isPreprocess` is enabled, `prismHighlight()` will return PrismJS processed HTML snippet. Otherwise `str` will only be escaped and `prismHighlight()` will return the HTML snippet that is suitable for `prism.js` working in the Browser.
 

lib/prism.js

@@ -62,7 +62,8 @@ function PrismUtil(str, options = {}) {
     tab,
     mark,
     firstLine,
-    isPreprocess = true
+    isPreprocess = true,
+    caption
   } = options;
 
   // To be consistent with highlight.js
@@ -97,7 +98,9 @@ function PrismUtil(str, options = {}) {
 
   if (tab) str = replaceTabs(str, tab);
 
-  const startTag = `<pre class="${preTagClassArr.join(' ')}"${preTagAttr}><code class="language-${language}">`;
+  const codeCaption = caption ? `<div>${caption}</div>` : '';
+
+  const startTag = `<pre class="${preTagClassArr.join(' ')}"${preTagAttr}>${codeCaption}<code class="language-${language}">`;
   const endTag = '</code></pre>';
 
   let parsedCode = '';

test/prism.spec.js

@@ -150,7 +150,7 @@ describe('prismHighlight', () => {
          - using 32 bit cells causes an overflow after several millions of digits
 
         It's about ~38 times shorter than pi16.b, ~364 times faster and works with
-        not-wrapping (bignum) implementations. 
+        not-wrapping (bignum) implementations.
 
         by Felix Nawothnig (felix.nawothnig@t-online.de) ]
 
@@ -229,7 +229,7 @@ describe('prismHighlight', () => {
          - using 32 bit cells causes an overflow after several millions of digits
 
         It's about ~38 times shorter than pi16.b, ~364 times faster and works with
-        not-wrapping (bignum) implementations. 
+        not-wrapping (bignum) implementations.
 
         by Felix Nawothnig (felix.nawothnig@t-online.de) ]
 
@@ -292,7 +292,7 @@ describe('prismHighlight', () => {
          - using 32 bit cells causes an overflow after several millions of digits
 
         It's about ~38 times shorter than pi16.b, ~364 times faster and works with
-        not-wrapping (bignum) implementations. 
+        not-wrapping (bignum) implementations.
 
         by Felix Nawothnig (felix.nawothnig@t-online.de) ]
 
@@ -320,4 +320,19 @@ describe('prismHighlight', () => {
     // Only validate the result2
     validateHtmlAsync(result2, done);
   });
+
+  it('caption', done => {
+    const input = `
+    {
+      "foo": 1,
+      "bar": 2
+    }`;
+    const caption = 'foo';
+    const result = prismHighlight(input, { caption });
+
+    result.should.contains('<div>' + caption + '</div>');
+
+    validateHtmlAsync(result, done);
+  });
+
 });