bajo-markdown 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ardhi Lukianto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,27 @@
+# bajo-markdown
+
+Plugin name: **bajoMarkdown**, alias: **md**
+
+![GitHub package.json version](https://img.shields.io/github/package-json/v/ardhi/bajo-markdown) ![NPM Version](https://img.shields.io/npm/v/bajo-markdown)
+
+> <br />**Attention**: I do NOT accept any pull request at the moment, thanks!<br /><br />
+
+Markdown support for [Bajo](https://github.com/ardhi/bajo).
+
+## Installation
+
+Goto your ```<bajo-base-dir>``` and type:
+
+```bash
+$ npm install bajo-markdown
+```
+
+Now open your ```<bajo-data-dir>/config/.plugins``` and put ```bajo-markdown``` in it
+
+## Class Method
+
+- ```function parse(text)```
+
+## License
+
+[MIT](LICENSE)

package/bajo/.alias

@@ -0,0 +1 @@
+md

package/bajo/config.json

@@ -0,0 +1,8 @@
+{
+  "renderer": {
+    "tableClass": "table my-3",
+    "tableHeadClass": "",
+    "tableBodyClass": "table-group-divider"
+  },
+  "dependencies": ["bajo-config"]
+}

package/bajo/method/parse-content.js

@@ -0,0 +1,9 @@
+function parseContent (input, options = {}) {
+  let html = this.instance.parse(input)
+  html = this.unescapeBlock(html, '<<c:', '>>')
+  html = this.unescapeBlock(html, '<</c:', '>>')
+  html = this.unescapeBlock(html, '<<%', '%>>') // lodash template
+  return html
+}
+
+export default parseContent

package/bajo/method/parse-front-matter.js

@@ -0,0 +1,18 @@
+function parseFrontMatter (input) {
+  const { isPlainObject, isArray } = this.app.bajo.lib._
+  const { fromYaml, fromToml, fromJson } = this.app.bajoConfig
+
+  const handlers = []
+  handlers.push(fromYaml, fromToml, fromJson)
+  let success
+  for (const handler of handlers) {
+    if (success) break
+    try {
+      const result = handler(input, true)
+      if (isPlainObject(result) || isArray(result)) success = result
+    } catch (err) {}
+  }
+  return success ?? {}
+}
+
+export default parseFrontMatter

package/bajo/method/parse.js

@@ -0,0 +1,15 @@
+function parse (input, opts = {}) {
+  const { omit, pick } = this.app.bajo.lib._
+  opts.parseContent = opts.parseContent ?? true
+
+  let { frontMatter, content } = this.split(input, pick(opts, ['readFile']))
+  frontMatter = this.parseFrontMatter(frontMatter)
+  const html = opts.parseContent ? this.parseContent(content, omit(opts, ['parseContent', 'readFile'])) : undefined
+  return {
+    frontMatter,
+    html,
+    content
+  }
+}
+
+export default parse

package/bajo/method/split.js

@@ -0,0 +1,21 @@
+const start = '---\n'
+const end = '\n---'
+
+function split (input, { readFile } = {}) {
+  const { fs } = this.app.bajo.lib
+  let content = readFile ? fs.readFileSync(input, 'utf8') : input
+  let text = content.replaceAll('\r\n', '\n')
+  const open = text.indexOf(start)
+  let frontMatter
+  if (open > -1) {
+    text = text.slice(open + end.length)
+    const close = text.indexOf(end)
+    if (close > -1) {
+      frontMatter = text.slice(0, close)
+      content = text.slice(close + end.length)
+    }
+  }
+  return { frontMatter, content }
+}
+
+export default split

package/bajo/method/unescape-block.js

@@ -0,0 +1,16 @@
+function unescape (text) {
+  if (this.app.waibu) return this.app.waibu.unescape(text)
+  return text.replaceAll('&lt;', '<').replaceAll('&gt;', '>')
+}
+
+function unescapeBlock (content, start, end) {
+  const { sliceString } = this.app.bajo
+  const sliced = sliceString(content, start, end)
+  if (!sliced) return content
+  const unescaped = unescape.call(this, sliced)
+  const replacer = unescaped.slice(1, unescaped.length - 1)
+  const result = content.replaceAll(sliced, replacer)
+  return unescapeBlock.call(this, result, start, end)
+}
+
+export default unescapeBlock

package/bajo/start.js

@@ -0,0 +1,38 @@
+import { Marked } from 'marked'
+import { markedHighlight } from 'marked-highlight'
+import customHeadingId from 'marked-custom-heading-id'
+import { mangle } from 'marked-mangle'
+import katex from 'marked-katex-extension'
+import { emoji } from '../lib/emoji.js'
+import Renderer from '../lib/renderer.js'
+
+async function start () {
+  const { importPkg } = this.app.bajo
+  const renderer = await Renderer.call(this)
+  const options = [
+    customHeadingId(),
+    mangle(),
+    katex({ throwOnError: false })
+  ]
+  if (this.app.waibuExtra) {
+    const hljs = await importPkg('waibuExtra:highlight.js')
+    const highlight = markedHighlight({
+      langPrefix: 'hljs language-',
+      highlight (code, lang) {
+        const language = hljs.getLanguage(lang) ? lang : 'plaintext'
+        return hljs.highlight(code, { language }).value
+      }
+    })
+    options.push(highlight)
+  }
+  const marked = new Marked(options)
+  marked.use({ renderer, extensions: [emoji] })
+  marked.Renderer.prototype.paragraph = (text) => {
+    if (text.startsWith('<c:')) return text + '\n' // for weibu component
+    return '<p>' + text + '</p>'
+  }
+
+  this.instance = marked
+}
+
+export default start

package/lib/emoji.js

@@ -0,0 +1,24 @@
+// based on: https://github.com/rinzool/marked-twemoji/blob/main/index.js
+import * as nodeEmoji from 'node-emoji'
+
+export const emoji = {
+  name: 'emoji',
+  level: 'inline',
+  start (src) {
+    return src.indexOf(':')
+  },
+  tokenizer (src, _) {
+    const rule = /^:(\w+):/
+    const match = rule.exec(src)
+    if (match) {
+      return {
+        type: 'emoji',
+        raw: match[0],
+        emoji: match[1]
+      }
+    }
+  },
+  renderer (token) {
+    return nodeEmoji.emojify(token.raw)
+  }
+}

package/lib/renderer.js

@@ -0,0 +1,15 @@
+async function renderer () {
+  const config = this.config
+  return {
+    table (header, body) {
+      return `
+        <table class="${config.renderer.tableClass}">
+          <thead class="${config.renderer.tableHeadClass}">${header}</thead>
+          <tbody class="${config.renderer.tableBodyClass}">${body}</tbody>
+        </table>
+        `
+    }
+  }
+}
+
+export default renderer

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "bajo-markdown",
+  "version": "1.0.1",
+  "description": "Markdown support for Bajo Framework",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ardhi/bajo-markdown.git"
+  },
+  "keywords": [
+    "markdown",
+    "bajo",
+    "framework",
+    "fastify",
+    "modular"
+  ],
+  "author": "Ardhi Lukianto <ardhi@lukianto.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ardhi/bajo-markdown/issues"
+  },
+  "homepage": "https://github.com/ardhi/bajo-markdown#readme",
+  "dependencies": {
+    "gray-matter": "^4.0.3",
+    "marked": "^15.0.6",
+    "marked-custom-heading-id": "^2.0.11",
+    "marked-extended-tables": "^1.1.0",
+    "marked-highlight": "^2.2.1",
+    "marked-katex-extension": "^5.1.4",
+    "marked-mangle": "^1.1.10",
+    "node-emoji": "^2.2.0"
+  }
+}