fastify-markdown 0.5.0 → 0.5.1

package/Readme.md

@@ -24,7 +24,7 @@ const fastify = require('fastify')({ logger: { level: 'trace' } })
 fastify
   .register(require('fastify-markdown'), { src: true })
   .get('/', (req, reply) => {
-    return reply.markdown(path.join(__dirname, '..', 'Readme.md'))
+    return reply.markdown(path.join(__dirname, 'Readme.md'))
   })
   .listen({ port: 3000 }, err => {
     if (err) throw err
@@ -37,7 +37,7 @@ fastify
  * async using opts.src from file
  */
 fastify
-  .register(require('../'), {
+  .register(require('fastify-markdown'), {
     src: true, markedOptions: { gfm: false }
   })
   .get('/', async (req, reply) => {

package/index.js

@@ -7,30 +7,28 @@ const { marked } = require('marked')
 const fp = require('fastify-plugin')
 
 function none (obj) {
-  if (obj === undefined) return true
-  if (obj && Object.getOwnPropertyNames(obj).length === 0) return true
+  if (obj == null) return true
+  if (typeof obj === 'object' && Object.getOwnPropertyNames(obj).length === 0) return true
   return false
 }
 
-function have (obj) {
-  return !!obj
-}
-
 function isString (str) {
   return typeof str === 'string'
 }
 
 function asyncFileMarked (src, option) {
   const read = util.promisify(fs.readFile)
-  return read(src, 'utf8').then(data => marked.parse(data, option), err => err)
+  return read(src, 'utf8').then(data => marked.parse(data, option))
 }
 
 async function fastifyMarkdown (fastify, opts) {
   const markedOptions = opts.markedOptions || {}
 
   fastify.decorateReply('markdown', function (md) {
-    if (none(opts) && none(md)) return marked
-    if (none(opts) && have(md)) opts = { data: md }
+    if (none(opts)) {
+      if (none(md)) return marked
+      return marked.parse(md, markedOptions)
+    }
 
     if (opts.data) {
       if (none(md) && isString(opts.data)) md = opts.data
@@ -40,9 +38,8 @@ async function fastifyMarkdown (fastify, opts) {
       return asyncFileMarked(md, markedOptions)
     } else if (opts.markedOptions) {
       return marked.setOptions(markedOptions)
-    } else {
-      return marked
     }
+    return marked
   })
 }
 

package/package.json

@@ -1,8 +1,15 @@
 {
   "name": "fastify-markdown",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Plugin for markdown parser",
   "main": "index.js",
+  "types": "./fastify/index.d.ts",
+  "files": [
+    "index.js",
+    "fastify/",
+    "LICENSE",
+    "Readme.md"
+  ],
   "scripts": {
     "test": "npm run lint && npm run unit",
     "lint": "standard | snazzy",
@@ -36,6 +43,5 @@
     "snazzy": "^9.0.0",
     "standard": "^17.1.2",
     "tap": "^21.7.5"
-  },
-  "types": "./fastify/index.d.ts"
+  }
 }

package/.github/workflows/ci.yml

@@ -1,23 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [master]
-  pull_request:
-    branches: [master]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [20, 22, 24]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: npm
-      - run: npm ci
-      - run: npm test

package/example/server.js

@@ -1,71 +0,0 @@
-'use strict'
-
-const path = require('path')
-const fastify = require('fastify')({
-  logger: {
-    level: 'trace'
-  }
-})
-
-/**
- * using opts.src = 'file'
- */
-// fastify
-//   .register(require('../'), {
-//     src: true, markedOptions: { gfm: false }
-//   })
-//   .get('/', (req, reply) => {
-//     return reply.markdown(path.join(__dirname, '..', 'Readme.md'))
-//   })
-//   .listen({ port: 3000 })
-//   .then(() => console.log('server running on http://localhost:3000 ...'))
-
-/**
- * using opts.src = true
- */
-fastify
-  .register(require('../'), {
-    src: true, markedOptions: { gfm: false }
-  })
-  .get('/', (req, reply) => {
-    return reply.markdown(path.join(__dirname, '..', 'Readme.md'))
-  })
-
-/**
- * using opts.data = true
- */
-// fastify
-//   .register(require('../'), {
-//     data: true, markedOptions: { gfm: false }
-//   })
-//   .get('/', (req, reply) => {
-//     const md = reply.markdown('**BOLD**')
-//     reply.send(md)
-//   })
-
-/**
- * default marked data
- */
-// fastify
-//   .register(require('../'))
-//   .get('/', (req, reply) => {
-//     const md = reply.markdown('**BOLD**')
-//     reply.send(md)
-//   })
-
-/**
- * using internal marked and options
- */
-// fastify
-//   .register(require('../'))
-//   .get('/', (req, reply) => {
-//     const md = reply.markdown().parse('**BOLD**', { breaks: true })
-//     reply.send(md)
-//   })
-
-fastify.listen({ port: 3000 })
-  .then(() => console.log('server running on http://localhost:3000 ...'))
-  .catch(err => {
-    fastify.log.error(err)
-    process.exit(1)
-  })

package/test/markdown.test.js

@@ -1,171 +0,0 @@
-'use strict'
-
-const path = require('path')
-const { test } = require('tap')
-const Fastify = require('fastify')
-const plugin = require('../')
-
-test('Should markdown with "opts.data" is', async t => {
-  const fastify = Fastify()
-  fastify.register(plugin, {
-    data: '**BOLD**'
-  })
-  fastify.get('/', (req, reply) => {
-    const md = reply.markdown()
-    reply.send(md)
-  })
-  const res = await fastify.inject({
-    url: '/',
-    method: 'GET'
-  })
-  t.error(res.error)
-  t.equal(res.payload.trim(), '<p><strong>BOLD</strong></p>')
-})
-
-test('Should markdown with "opts.data" and "opts.markedOptions" is', async t => {
-  const fastify = Fastify()
-  fastify.register(plugin, {
-    data: true, markedOptions: { gfm: false }
-  })
-  fastify.get('/', (req, reply) => {
-    const md = reply.markdown('**BOLD**')
-    reply.send(md)
-  })
-  const res = await fastify.inject({
-    url: '/',
-    method: 'GET'
-  })
-  t.error(res.error)
-  t.equal(res.payload, '<p><strong>BOLD</strong></p>\n')
-})
-
-test('Should markdown with "opts.src" is', async t => {
-  const fastify = Fastify()
-  fastify.register(plugin, {
-    src: true
-  })
-  fastify.get('/', (req, reply) => {
-    return reply.markdown(path.join(__dirname, '..', 'Readme.md'))
-  })
-  const res = await fastify.inject({
-    url: '/',
-    method: 'GET'
-  })
-  t.error(res.error)
-  t.ok(res.payload)
-})
-
-test('Should markdown with "opts.src" is incorrect', async t => {
-  const fastify = Fastify()
-  fastify.register(plugin, {
-    src: 'empty'
-  })
-  fastify.get('/', (req, reply) => {
-    reply.markdown().then(md => {
-      reply.send(md)
-    }).catch(err => {
-      reply.send(err)
-    })
-  })
-  const res = await fastify.inject({
-    url: '/',
-    method: 'GET'
-  })
-  t.error(res.error)
-  t.equal(JSON.parse(res.payload).statusCode, 500)
-})
-
-test('Should markdown with "opts.markedOptions" is', async t => {
-  const testOptions = {
-    gfm: false
-  }
-  const fastify = Fastify()
-  fastify.register(plugin, {
-    markedOptions: testOptions
-  })
-  fastify.get('/', (req, reply) => {
-    const gfm = reply.markdown().defaults.gfm
-    reply.send(gfm)
-  })
-  const res = await fastify.inject({
-    url: '/',
-    method: 'GET'
-  })
-  t.error(res.error)
-  t.equal(res.payload, 'false')
-})
-
-test('Should markdown without "opts" is', async t => {
-  const fastify = Fastify()
-  fastify.register(plugin /*, opts */)
-  fastify.get('/', (req, reply) => {
-    const md = reply.markdown().parse('**BOLD**')
-    reply.send(md)
-  })
-  const res = await fastify.inject({
-    url: '/',
-    method: 'GET'
-  })
-  t.error(res.error)
-  t.equal(res.payload.trim(), '<p><strong>BOLD</strong></p>')
-})
-
-test('Should markdown without "opts" and "markdown" method with "md" param is', async t => {
-  const fastify = Fastify()
-  fastify.register(plugin /*, opts */)
-  fastify.get('/', (req, reply) => {
-    const md = reply.markdown('**BOLD**')
-    reply.send(md)
-  })
-  const res = await fastify.inject({
-    url: '/',
-    method: 'GET'
-  })
-  t.error(res.error)
-  t.equal(res.payload.trim(), '<p><strong>BOLD</strong></p>')
-})
-
-test('Should markdown with "opts.data" and "markdown" method with "md" param the result is', async t => {
-  const fastify = Fastify()
-  fastify.register(plugin, { data: '**DATA**' })
-  fastify.get('/', (req, reply) => {
-    const md = reply.markdown('**BOLD**')
-    reply.send(md)
-  })
-  const res = await fastify.inject({
-    url: '/',
-    method: 'GET'
-  })
-  t.error(res.error)
-  t.equal(res.payload.trim(), '<p><strong>BOLD</strong></p>')
-})
-
-test('Should markdown with "opts.data" and "opts.src" is', async t => {
-  const fastify = Fastify()
-  fastify.register(plugin, { src: path.join(__dirname, '..', 'Readme.md'), data: true })
-  fastify.get('/', (req, reply) => {
-    const md = reply.markdown('**BOLD**')
-    reply.send(md)
-  })
-  const res = await fastify.inject({
-    url: '/',
-    method: 'GET'
-  })
-  t.error(res.error)
-  t.equal(res.payload.trim(), '<p><strong>BOLD</strong></p>')
-})
-
-test('Should markdown with "opts" but isnot [data,src,markedOptions] is', async t => {
-  const fastify = Fastify()
-  fastify.register(plugin, { anything: 'anything' })
-  fastify.get('/', (req, reply) => {
-    const md = reply.markdown().parse('**BOLD**')
-    reply.send(md)
-  })
-  const res = await fastify.inject({
-    url: '/',
-    method: 'GET'
-  })
-  t.error(res.error)
-  t.equal(res.payload.trim(), '<p><strong>BOLD</strong></p>')
-})