Skip to content

Commit

Permalink
Deprecate Marp.ready() and provide browser.js
Browse files Browse the repository at this point in the history
  • Loading branch information
yhatt committed Oct 18, 2019
1 parent 005c8f2 commit 7af96d9
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 18 deletions.
1 change: 1 addition & 0 deletions browser.d.ts
@@ -0,0 +1 @@
export * from './types/src/browser'
1 change: 1 addition & 0 deletions browser.js
@@ -0,0 +1 @@
module.exports = require('./lib/browser.cjs')
4 changes: 3 additions & 1 deletion package.json
Expand Up @@ -30,7 +30,9 @@
"types": "types/src/marp.d.ts",
"files": [
"lib/",
"types/"
"types/",
"browser.js",
"browser.d.ts"
],
"engines": {
"node": ">=8"
Expand Down
7 changes: 6 additions & 1 deletion src/marp.ts
Expand Up @@ -144,7 +144,12 @@ export class Marp extends Marpit {
return base
}

static ready = browser
static ready() {
console.warn(
'[DEPRECATION WARNING] A script for the browser that is equivalent to Marp.ready() has injected into rendered Markdown by default. Marp.ready() will remove in future so you have to use "@marp-team/marp-core/browser" instead if you want to execute browser script in script-disabled HTML manually via using such as webpack.'
)
browser()
}
}

export default Marp
3 changes: 1 addition & 2 deletions test/browser.ts
@@ -1,6 +1,5 @@
/** @jest-environment jsdom */
import browser from '../src/browser'
import observer from '../src/observer'
import browser, { observer } from '../src/browser'
import fittingObserver from '../src/fitting/observer'

const polyfill = jest.fn()
Expand Down
14 changes: 0 additions & 14 deletions version.js

This file was deleted.

0 comments on commit 7af96d9

Please sign in to comment.