Use named exports for public api (#354)

Default exports are always a headache for public api. They are hard to
use when same module is used for both node and webpack via commonjs.
We have this problem

webpack/webpack#6584

Mixing named and default exports works even buggier.

webpack/webpack#7973

The best solution is using only named exports. They fits perfectly with
interops and may work without interop for commonjs.

(module.exports = was a mistake, export default IMO too)

Author: TrySound

README.md

@@ -33,13 +33,24 @@ npm install remarkable --save
 ## Usage
 
 ```js
-var Remarkable = require('remarkable');
+import { Remarkable } from 'remarkable';
 var md = new Remarkable();
 
 console.log(md.render('# Remarkable rulezz!'));
 // => <h1>Remarkable rulezz!</h1>
 ```
 
+or with commonjs
+
+```js
+const { Remarkable } = require('remarkable');
+var md = new Remarkable();
+
+console.log(md.render('# Remarkable rulezz!'));
+// => <h1>Remarkable rulezz!</h1>
+```
+
+
 If installed globally with `npm`:
 
 ```sh
@@ -101,7 +112,8 @@ console.log(md.render('# Remarkable rulezz!'));
 Or define options via the `.set()` method:
 
 ```js
-var Remarkable = require('remarkable');
+import { Remarkable } from 'remarkable';
+
 var md = new Remarkable();
 
 md.set({
@@ -126,7 +138,7 @@ active syntax rules and options for common use cases.
 Enable strict [CommonMark](http://commonmark.org/) mode with the `commonmark` preset:
 
 ```js
-var Remarkable = require('remarkable');
+import { Remarkable } from 'remarkable';
 var md = new Remarkable('commonmark');
 ```
 
@@ -135,7 +147,7 @@ var md = new Remarkable('commonmark');
 Enable all available rules (but still with default options, if not set):
 
 ```js
-var Remarkable = require('remarkable');
+import { Remarkable } from 'remarkable';
 var md = new Remarkable('full');
 
 // Or with options:
@@ -151,8 +163,8 @@ var md = new Remarkable('full', {
 Apply syntax highlighting to fenced code blocks with the `highlight` option:
 
 ```js
-var Remarkable = require('remarkable');
-var hljs       = require('highlight.js') // https://highlightjs.org/
+import { Remarkable } from 'remarkable';
+import hljs from 'highlight.js' // https://highlightjs.org/
 
 // Actual default values
 var md = new Remarkable({
@@ -233,7 +245,7 @@ Although full-weight typographical replacements are language specific, `remarkab
 provides coverage for the most common and universal use cases:
 
 ```js
-var Remarkable = require('remarkable');
+import { Remarkable } from 'remarkable';
 var md = new Remarkable({
   typographer: true,
   quotes: '“”‘’'
@@ -281,12 +293,20 @@ plugins.
 Autoconvert URL-like text to links
 
 ```js
-import Remarkable from 'remarkable';
-import linkify from 'remarkable/linkify';
+import { Remarkable } from 'remarkable';
+import { linkify } from 'remarkable/linkify';
 
 var md = new Remarkable().use(linkify);
 ```
 
+### UMD
+
+UMD bundle provides linkify out of the box
+
+```js
+const { Remarkable, linkify, utils } = window.remarkable;
+```
+
 
 ## References / Thanks
 

lib/cli.js

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import argparse from 'argparse';
-import Remarkable from './index';
-import linkify from './linkify';
+import { Remarkable } from './index';
+import { linkify } from './linkify';
 import { version } from '../package.json';
 
 ////////////////////////////////////////////////////////////////////////////////

lib/index.js

@@ -8,6 +8,15 @@ import defaultConfig from './configs/default';
 import fullConfig from './configs/full';
 import commonmarkConfig from './configs/commonmark';
 
+/**
+ * Expose `utils`, Useful helper functions for custom
+ * rendering.
+ */
+
+export {
+  utils
+}
+
 /**
  * Preset configs
  */
@@ -47,7 +56,7 @@ function StateCore(instance, str, env) {
  * @param {Object} `options`
  */
 
-export default function Remarkable(preset, options) {
+export function Remarkable(preset, options) {
   if (typeof preset !== 'string') {
     options = preset;
     preset = 'default';
@@ -186,10 +195,3 @@ Remarkable.prototype.renderInline = function (str, env) {
   env = env || {};
   return this.renderer.render(this.parseInline(str, env), this.options, env);
 };
-
-/**
- * Expose `utils`, Useful helper functions for custom
- * rendering.
- */
-
-Remarkable.utils = utils;

lib/linkify.js

@@ -155,6 +155,6 @@ function parseTokens(state) {
   }
 };
 
-export default function linkify(md) {
+export function linkify(md) {
   md.core.ruler.push('linkify', parseTokens);
 };

lib/umd.js

@@ -1,6 +1,2 @@
-import Remarkable from './index';
-import linkify from './linkify';
-
-Remarkable.linkify = linkify;
-
-export default Remarkable;
+export { Remarkable, utils } from './index';
+export { linkify } from './linkify';

rollup.config.js

@@ -3,7 +3,7 @@ import nodeResolve from 'rollup-plugin-node-resolve';
 import json from 'rollup-plugin-json';
 import { terser } from 'rollup-plugin-terser';
 
-const name = 'Remarkable';
+const name = 'remarkable';
 const external = id => !id.startsWith('.') && !path.isAbsolute(id);
 
 export default [

support/specsplit.js

@@ -7,7 +7,7 @@
 import fs from 'fs';
 import util from 'util';
 import argparse from 'argparse';
-import Remarkable from '../lib/index.js';
+import { Remarkable } from '../lib/index.js';
 import pkg from '../package.json';
 
 var cli = new argparse.ArgumentParser({

test/commonmark.js

@@ -1,6 +1,6 @@
 import path from 'path';
 import { addTests } from './utils';
-import Remarkable from '../lib/index';
+import { Remarkable } from '../lib/index';
 
 describe('CommonMark', function () {
   var md = new Remarkable('commonmark');

test/linkify.js

@@ -1,8 +1,8 @@
 import path from 'path';
 import assert from 'assert';
 import { addTests } from './utils';
-import Remarkable from '../lib/index';
-import linkify from '../lib/linkify';
+import { Remarkable } from '../lib/index';
+import { linkify } from '../lib/linkify';
 
 describe('linkify plugin', function () {
   var md = new Remarkable({ html: true }).use(linkify);

test/misc.js

@@ -1,8 +1,6 @@
 import assert from 'assert';
-import Remarkable from '../lib/index';
-import linkify from '../lib/linkify';
-
-const { utils } = Remarkable
+import { Remarkable, utils } from '../lib/index';
+import { linkify } from '../lib/linkify';
 
 
 describe('Utils', function () {

test/remarkable.js

@@ -1,6 +1,6 @@
 import path from 'path';
 import { addTests } from './utils';
-import Remarkable from '../lib/index';
+import { Remarkable } from '../lib/index';
 
 describe('remarkable', function () {
   var md = new Remarkable('full', {