terra-props-table - npm Package Compare versions

Comparing version 2.34.0 to 2.35.0

CHANGELOG.md

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

docs/README.md

@@ -11,2 +11,19 @@ # Terra Props Table
 
+<!-- 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 @@

package.json

 {
   "name": "terra-props-table",
   "main": "lib/PropsTable.js",
-  "version": "2.34.0",
+  "version": "2.35.0",
   "description": "React component to render a table view for the props metadata of another react component.",
@@ -36,3 +36,3 @@ "repository": {
     "react-docgen": "^2.15.0",
-    "terra-markdown": "^2.28.0"
+    "terra-markdown": "^2.29.0"
   },
@@ -39,0 +39,0 @@ "scripts": {

README.md

@@ -17,2 +17,19 @@ # Terra Props Table
 
+<!-- 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 -->
+
 ## CLI
@@ -19,0 +36,0 @@ Props table is also a command utility used to generate markdown tables. The CLI accepts multiple files as input and has a single output directory.

tests/wdio/props-table-spec.js

@@ -1,11 +0,8 @@
-const viewports = Terra.viewports('medium', 'large');
-
-describe('Props Table', () => {
+Terra.describeViewports('Props Table', ['medium'], () => {
   describe('Default', () => {
     before(() => {
       browser.url('/#/raw/tests/terra-props-table/props-table-test/mock-props-table');
-      browser.setViewportSize(Terra.viewports('medium')[0]);
     });
 
-    Terra.it.matchesScreenshot('should display a string prop', { selector: '#PropsTable > tbody > tr:nth-child(1)' });
+    Terra.it.validatesElement('should display a string prop', { selector: '#PropsTable > tbody > tr:nth-child(1)' });
 
@@ -38,4 +35,2 @@ Terra.it.matchesScreenshot('should display a number prop', { selector: '#PropsTable > tbody > tr:nth-child(2)' });
     Terra.it.matchesScreenshot('should display a shape prop', { selector: '#PropsTable > tbody > tr:nth-child(10)' });
-
-    Terra.it.isAccessible({ viewports });
   });
@@ -46,6 +41,5 @@
       browser.url('/#/raw/tests/terra-props-table/props-table-test/mock-private-props-table');
-      browser.setViewportSize(Terra.viewports('medium')[0]);
     });
 
-    Terra.it.matchesScreenshot('should not render private prop information', { selector: '#PrivatePropsTable' });
+    Terra.it.validatesElement('should not render private prop information', { selector: '#PrivatePropsTable' });
   });
@@ -56,9 +50,6 @@
       browser.url('/#/raw/tests/terra-props-table/props-table-test/mock-props-table-with-title');
-      browser.setViewportSize(Terra.viewports('medium')[0]);
     });
 
-    Terra.it.matchesScreenshot('should display the title', { selector: '[class*="props-table-markdown"] > h2' });
-
-    Terra.it.isAccessible({ viewports });
+    Terra.it.validatesElement('should display the title', { selector: '[class*="props-table-markdown"] > h2' });
   });
 });

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

Total package byte prevSize

86471

increased by0.88%

Number of lines in readme file

83

increased by25.76%

Worsened metrics

Lines of code

965

decreased by-0.62%

Dependency changes

• Updatedterra-markdown@^2.29.0