terra-markdown - npm Package Compare versions

Comparing version 2.28.0 to 2.29.0

CHANGELOG.md

@@ -7,2 +7,10 @@ Changelog
 
+2.29.0 - (July 16, 2019)
+------------------
+### Added
+* Added documentation on required peerDependencies
+
+### Changed
+* Update tests to use `Terra.describeViewports` for setting viewports and use `Terra.it.validatesElement`
+
 2.28.0 - (June 28, 2019)
@@ -9,0 +17,0 @@ ------------------

docs/README.md

@@ -11,2 +11,19 @@ # Terra Markdown
 
+<!-- AUTO-GENERATED-CONTENT:START Peer Dependencies -->
+## Peer Dependencies
+
+<details>
+<summary>View information on this component's peer dependencies.</summary>
+
+This component requires the following peer dependencies be installed in your app for the component to properly function.
+
+| Peer Dependency | Version |
+|-|-|
+| react | ^16.8.5 |
+| react-dom | ^16.8.5 |
+
+
+</details>
+<!-- AUTO-GENERATED-CONTENT:END -->
+
 ## Usage
@@ -13,0 +30,0 @@

lib/Markdown.js

@@ -28,4 +28,6 @@ "use strict";
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; var ownKeys = Object.keys(source); if (typeof Object.getOwnPropertySymbols === 'function') { ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function (sym) { return Object.getOwnPropertyDescriptor(source, sym).enumerable; })); } ownKeys.forEach(function (key) { _defineProperty(target, key, source[key]); }); } return target; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { keys.push.apply(keys, Object.getOwnPropertySymbols(object)); } if (enumerableOnly) keys = keys.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); return keys; }
 
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(source, true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(source).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -89,3 +91,3 @@
         baseUrl: props.baseUrl
-      }, props.hasHeadingAnchors && {
+      }, {}, props.hasHeadingAnchors && {
         renderer: renderer
@@ -92,0 +94,0 @@ }))

lib/terra-dev-site/test/markdown/scss.md

@@ -9,20 +9,2 @@ ### scss
 
-@mixin container {
-    max-width: 980px;
-}
-
-// mixins with parameters
-@mixin button($color:green) {
-    @if ($color == green) {
-        background-color: #008000;
-    }
-    @else if ($color == red) {
-        background-color: #B22222;
-    }
-}
-
-button {
-    @include button(red);
-}
-
 div,
@@ -36,32 +18,11 @@ .navbar,
     display: block;
-}
-
-.row-12 > [class*="spans"] {
-    border-left: 1px solid #B5C583;
-}
-
-// nested definitions
-ul {
-    width: 100%;
+    &:hover { color: $colorGreenDark; }
+    .home {
+          background: url('http://placehold.it/20') scroll no-repeat 0 0;
+    }
     padding: {
         left: 5px; right: 5px;
     }
-  li {
-      float: left; margin-right: 10px;
-      .home {
-          background: url('http://placehold.it/20') scroll no-repeat 0 0;
-    }
-  }
 }
 
-.banner {
-    @extend .container;
-}
-
-a {
-  color: $colorGreen;
-  &:hover { color: $colorGreenDark; }
-  &:visited { color: #c458cb; }
-}
-
 @for $i from 1 through 5 {
@@ -68,0 +29,0 @@ .span#{$i} {

package.json

 {
   "name": "terra-markdown",
   "main": "lib/Markdown.js",
-  "version": "2.28.0",
+  "version": "2.29.0",
   "description": "React component to display the content of markdown files.",
@@ -6,0 +6,0 @@ "repository": {

README.md

@@ -17,2 +17,19 @@ # Terra Markdown
 
+<!-- AUTO-GENERATED-CONTENT:START Peer Dependencies -->
+## Peer Dependencies
+
+<details>
+<summary>View information on this component's peer dependencies.</summary>
+
+This component requires the following peer dependencies be installed in your app for the component to properly function.
+
+| Peer Dependency | Version |
+|-|-|
+| react | ^16.8.5 |
+| react-dom | ^16.8.5 |
+
+
+</details>
+<!-- AUTO-GENERATED-CONTENT:END -->
+
 ## LICENSE
@@ -19,0 +36,0 @@

src/terra-dev-site/test/markdown/scss.md

@@ -9,20 +9,2 @@ ### scss
 
-@mixin container {
-    max-width: 980px;
-}
-
-// mixins with parameters
-@mixin button($color:green) {
-    @if ($color == green) {
-        background-color: #008000;
-    }
-    @else if ($color == red) {
-        background-color: #B22222;
-    }
-}
-
-button {
-    @include button(red);
-}
-
 div,
@@ -36,32 +18,11 @@ .navbar,
     display: block;
-}
-
-.row-12 > [class*="spans"] {
-    border-left: 1px solid #B5C583;
-}
-
-// nested definitions
-ul {
-    width: 100%;
+    &:hover { color: $colorGreenDark; }
+    .home {
+          background: url('http://placehold.it/20') scroll no-repeat 0 0;
+    }
     padding: {
         left: 5px; right: 5px;
     }
-  li {
-      float: left; margin-right: 10px;
-      .home {
-          background: url('http://placehold.it/20') scroll no-repeat 0 0;
-    }
-  }
 }
 
-.banner {
-    @extend .container;
-}
-
-a {
-  color: $colorGreen;
-  &:hover { color: $colorGreenDark; }
-  &:visited { color: #c458cb; }
-}
-
 @for $i from 1 through 5 {
@@ -68,0 +29,0 @@ .span#{$i} {

tests/jest/markdown.test.jsx

 import React from 'react';
 import Markdown from '../../src/Markdown';
-import MockREADME from '../../src/terra-dev-site/test/markdown/Markdown.md';
+import MockREADME from './Markdown.md';
 
@@ -5,0 +5,0 @@ const headings = [

tests/wdio/markdown-spec.js

@@ -1,9 +0,2 @@
-describe('Markdown', () => {
-  before(() => browser.setViewportSize({ width: 1000, height: 10000, name: 'large' }));
-  describe('Default', () => {
-    before(() => browser.url('/#/raw/tests/terra-markdown/markdown/markdown'));
-
-    Terra.it.validatesElement({ selector: '#root' });
-  });
-
+Terra.describeViewports('Markdown', ['large'], () => {
   describe('css', () => {
@@ -10,0 +3,0 @@ before(() => browser.url('/#/raw/tests/terra-markdown/markdown/css'));

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

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

Number of lines in readme file

43

increased by65.38%

Worsened metrics

Total package byte prevSize

85217

decreased by-12%

Number of package files

50

decreased by-5.66%

Lines of code

424

decreased by-5.57%

No dependency changes