Merge pull request #57 from pxgrid/upgrade-marked-v17

marked を v7.0.5 から v17.0.5 に更新

Author: myakura

index.d.ts

@@ -7,16 +7,11 @@ export default class CodeGridMarkdown {
  * Options for CodeGridMarkdown.
  *
  * Basically the same as MarkedOptions.
- * `renderer` and `headerIds` are used internally and cannot be overridden.
+ * `renderer` is used internally and cannot be overridden.
  *
  * See also https://marked.js.org/using_advanced#options
  */
 export interface CodeGridMarkdownOptions {
-  /**
-   * A prefix URL for any relative link.
-   */
-  baseUrl?: string;
-
   /**
    * Enable GFM line breaks. This option requires the gfm option to be true.
    */
@@ -27,11 +22,6 @@ export interface CodeGridMarkdownOptions {
    */
   gfm?: boolean;
 
-  /**
-   * Set the prefix for header tag ids.
-   */
-  headerPrefix?: string;
-
   /**
    * Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
    */
@@ -41,14 +31,4 @@ export interface CodeGridMarkdownOptions {
    * Shows an HTML error message when rendering fails.
    */
   silent?: boolean;
-
-  /**
-   * Use "smart" typographic punctuation for things like quotes and dashes.
-   */
-  smartypants?: boolean;
-
-  /**
-   * Generate closing slash for self-closing tags (<br/> instead of <br>)
-   */
-  xhtml?: boolean;
 }

lib/renderer/md.js

@@ -20,8 +20,6 @@ class MDRenderer {
     this.options = options;
 
     this.options.renderer = new marked.Renderer();
-    // markedのアップデートで初期値が変わったもの
-    this.options.headerIds = '';
 
     Object.keys(renderFunc).forEach((key) => {
       this.options.renderer[key] = renderFunc[key];

lib/renderer/md/code.js

@@ -23,28 +23,29 @@ const renderLivecodeSection = (title, codeHtml) => `
  * ```html#たいとる 言語指定とタイトル指定 ```
  * みたいにすると、拡張したやつでレンダリングして返す
  *
- * @param {string} code
- * @param {string} lang
- * @param {string} escaped
+ * @param {object} token
+ *   marked v17 のコードトークン ({type, raw, lang, text})
  * @return {string}
  *   HTML文字列
  *
  */
-export default function(code, lang, escaped) {
+export default function(token) {
+  const { lang } = token;
+
   // そもそも言語指定ないやつ
   if (!lang) {
-    return origCodeRender.apply(this, [code, lang, escaped]);
+    return origCodeRender.call(this, token);
   }
 
   const langArr = lang.split('#').map((t) => t.trim());
   // 言語の指定はあったが、タイトルがない = 今まで通り
   if (langArr.length === 1 || langArr[1].length === 0) {
-    return origCodeRender.apply(this, [code, langArr[0], escaped]);
+    return origCodeRender.call(this, { ...token, lang: langArr[0] });
   }
 
   // 言語の指定もタイトル指定もちゃんとあるやつ
   return renderLivecodeSection(
     langArr[1], // タイトル
-    origCodeRender.apply(this, [code, langArr[0], escaped]) // コード本体
+    origCodeRender.call(this, { ...token, lang: langArr[0] }) // コード本体
   );
 }

package-lock.json

@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "cheerio": "^1.2.0",
-    "marked": "7.0.5"
+    "marked": "^17.0.5"
   },
   "devDependencies": {
     "@power-assert/node": "^0.6.0"

package.json

@@ -7,11 +7,15 @@ describe('CodeGridMarkdown', function() {
 
 describe('#constructor', function() {
   it('markedにオプションが渡せる', function() {
-    const original = '<img>';
-    const expect = '<p>&lt;img&gt;</p>\n';
+    const original = 'line1\nline2';
+    const withBreaks = '<p>line1<br>line2</p>\n';
+    const withoutBreaks = '<p>line1\nline2</p>\n';
 
-    const cgmd = new CodeGridMarkdown({ sanitize: true });
-    assert(cgmd.render(original) === expect);
+    const cgmd = new CodeGridMarkdown({ breaks: true });
+    assert(cgmd.render(original) === withBreaks);
+
+    const cgmdDefault = new CodeGridMarkdown();
+    assert(cgmdDefault.render(original) === withoutBreaks);
   });
 });