Merge pull request #77 from marp-team/warn-twemojibase-deprecation

Output warning when used deprecated twemojiBase option

CHANGELOG.md

@@ -9,6 +9,7 @@
 ### Changed
 
 - Upgrade Node and dependent packages to the latest ([#76](https://github.com/marp-team/marp-core/pull/76))
+- Output warning when used deprecated `twemojiBase` option ([#77](https://github.com/marp-team/marp-core/pull/77))
 
 ## v0.6.2 - 2019-03-09
 

src/emoji/emoji.ts

@@ -33,7 +33,16 @@ export function markdown(md, opts: EmojiOptions): void {
     twemoji.parse(content, {
       attributes: () => ({ 'data-marp-twemoji': '' }),
       base:
-        twemojiOpts.base || opts.twemojiBase || 'https://twemoji.maxcdn.com/2/',
+        twemojiOpts.base ||
+        (() => {
+          if (opts.twemojiBase) {
+            console.warn(
+              'Deprecation warning: twemojiBase option has been deprecated and would remove in next version. Please use twemoji.base option instead.'
+            )
+          }
+          return opts.twemojiBase
+        })() ||
+        'https://twemoji.maxcdn.com/2/',
       ext: `.${twemojiExt}`,
       size: twemojiExt === 'svg' ? 'svg' : 72,
     })

test/marp.ts

@@ -14,6 +14,8 @@ const marpitDisablePlugin = md =>
 jest.mock('../src/browser')
 jest.mock('../src/math/katex.scss')
 
+afterEach(() => jest.restoreAllMocks())
+
 describe('Marp', () => {
   const marp = (opts?: MarpOptions): Marp => new Marp(opts)
 
@@ -158,15 +160,19 @@ describe('Marp', () => {
       })
     })
 
-    describe('twemojiBase option [soft-deprecated]', () => {
+    describe('twemojiBase option [deprecated]', () => {
       const instance = (emoji: EmojiOptions = {}) => new Marp({ emoji })
 
       it('uses specified base when twemojiBase option is defined', () => {
+        const warn = jest.spyOn(console, 'warn')
         const marp = instance({ twemojiBase: '/assets/twemoji/' })
         const $ = cheerio.load(marp.render('# :ok_hand:').html)
         const src = $('h1 > img[data-marp-twemoji]').attr('src')
 
         expect(src).toBe('/assets/twemoji/svg/1f44c.svg')
+        expect(warn).toBeCalledWith(
+          expect.stringContaining('Deprecation warning')
+        )
       })
     })