react-remarkable - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

dist/index.js

 'use strict';
 
-var _interopRequireDefault = function (obj) { return obj && obj.__esModule ? obj : { 'default': obj }; };
-
 Object.defineProperty(exports, '__esModule', {
@@ -9,64 +7,84 @@ value: true
 
-var _React = require('react');
+var _createClass = (function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ('value' in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; })();
 
-var _React2 = _interopRequireDefault(_React);
+var _get = function get(_x, _x2, _x3) { var _again = true; _function: while (_again) { var object = _x, property = _x2, receiver = _x3; _again = false; if (object === null) object = Function.prototype; var desc = Object.getOwnPropertyDescriptor(object, property); if (desc === undefined) { var parent = Object.getPrototypeOf(object); if (parent === null) { return undefined; } else { _x = parent; _x2 = property; _x3 = receiver; _again = true; desc = parent = undefined; continue _function; } } else if ('value' in desc) { return desc.value; } else { var getter = desc.get; if (getter === undefined) { return undefined; } return getter.call(receiver); } } };
 
-var _Markdown = require('remarkable');
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
 
-var _Markdown2 = _interopRequireDefault(_Markdown);
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError('Cannot call a class as a function'); } }
 
-'use strict';
+function _inherits(subClass, superClass) { if (typeof superClass !== 'function' && superClass !== null) { throw new TypeError('Super expression must either be null or a function, not ' + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
-var Remarkable = _React2['default'].createClass({
-  displayName: 'Remarkable',
+var _react = require('react');
 
-  getDefaultProps: function getDefaultProps() {
-    return {
-      container: 'div',
-      options: {} };
-  },
+var _react2 = _interopRequireDefault(_react);
 
-  render: function render() {
-    var Container = this.props.container;
+var _remarkable = require('remarkable');
 
-    return _React2['default'].createElement(
-      Container,
-      null,
-      this.content()
-    );
-  },
+var _remarkable2 = _interopRequireDefault(_remarkable);
 
-  componentWillUpdate: function componentWillUpdate(nextProps, nextState) {
-    if (nextProps.options !== this.props.options) {
-      this.md = new _Markdown2['default'](nextProps.options);
-    }
-  },
+var Remarkable = (function (_React$Component) {
+  _inherits(Remarkable, _React$Component);
 
-  content: function content() {
-    var _this = this;
+  function Remarkable() {
+    _classCallCheck(this, Remarkable);
 
-    if (this.props.source) {
-      return _React2['default'].createElement('span', { dangerouslySetInnerHTML: { __html: this.renderMarkdown(this.props.source) } });
-    } else {
-      return _React2['default'].Children.map(this.props.children, function (child) {
-        if (typeof child === 'string') {
-          return _React2['default'].createElement('span', { dangerouslySetInnerHTML: { __html: _this.renderMarkdown(child) } });
-        } else {
-          return child;
-        }
-      });
+    _get(Object.getPrototypeOf(Remarkable.prototype), 'constructor', this).apply(this, arguments);
+  }
+
+  _createClass(Remarkable, [{
+    key: 'render',
+    value: function render() {
+      var Container = this.props.container;
+
+      return _react2['default'].createElement(
+        Container,
+        null,
+        this.content()
+      );
     }
-  },
+  }, {
+    key: 'componentWillUpdate',
+    value: function componentWillUpdate(nextProps, nextState) {
+      if (nextProps.options !== this.props.options) {
+        this.md = new _remarkable2['default'](nextProps.options);
+      }
+    }
+  }, {
+    key: 'content',
+    value: function content() {
+      var _this = this;
 
-  renderMarkdown: function renderMarkdown(source) {
-    if (!this.md) {
-      this.md = new _Markdown2['default'](this.props.options);
+      if (this.props.source) {
+        return _react2['default'].createElement('span', { dangerouslySetInnerHTML: { __html: this.renderMarkdown(this.props.source) } });
+      } else {
+        return _react2['default'].Children.map(this.props.children, function (child) {
+          if (typeof child === 'string') {
+            return _react2['default'].createElement('span', { dangerouslySetInnerHTML: { __html: _this.renderMarkdown(child) } });
+          } else {
+            return child;
+          }
+        });
+      }
     }
+  }, {
+    key: 'renderMarkdown',
+    value: function renderMarkdown(source) {
+      if (!this.md) {
+        this.md = new _remarkable2['default'](this.props.options);
+      }
 
-    return this.md.render(source);
-  }
+      return this.md.render(source);
+    }
+  }]);
 
-});
+  return Remarkable;
+})(_react2['default'].Component);
 
+Remarkable.defaultProps = {
+  container: 'div',
+  options: {}
+};
+
 exports['default'] = Remarkable;
 module.exports = exports['default'];

package.json

 {
   "name": "react-remarkable",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "A React component for rendering Markdown with remarkable",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -27,3 +27,3 @@ react-remarkable
         {/* You can nest React components, too */}
-        <Markdown>
+        <Markdown>{`
           ## Reasons React is great
@@ -37,3 +37,3 @@
           Pretty neat!
-        </Markdown>
+        `}</Markdown>
       </div>
@@ -51,5 +51,21 @@ );
 - `source`  - Markdown source. You can also pass the source as children, which allows you to mix React components and Markdown.
-- `container` - Element to use as container. Defaults to `span`.
+- `container` - Element to use as container. Defaults to `div`.
 
+## Syntax Highlighting
+
+### Atom
+
+You can enable syntax highlighting in Atom using the following steps:
+
+Go to Settings > Packages > language-babel Settings > Enter this for JavaScript Tagged Literal Grammar Extensions:
+
+`"(?<=<Markdown>{)":source.gfm`
+
+<img width="527" alt="screen shot 2017-05-28 at 9 04 27 am" src="https://cloud.githubusercontent.com/assets/108938/26529400/fe7ea216-4384-11e7-9eab-3259eb684648.png">
+
+Shortly you'll see that markdown syntax highlighting is enabled.
+
+<img width="449" alt="screen shot 2017-05-28 at 9 06 31 am" src="https://cloud.githubusercontent.com/assets/108938/26529401/fe7faf4e-4384-11e7-8977-f1fe39537524.png">
+
 ## License
 MIT

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6688

increased by76.65%

Lines of code

72

increased by38.46%

Number of lines in readme file

69

increased by30.19%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes