terra-props-table - npm Package Compare versions

Comparing version 2.24.0 to 2.25.0

CHANGELOG.md

@@ -7,2 +7,7 @@ Changelog
 
+2.24.0 - (January 8, 2019)
+------------------
+### Added
+* Added support for private props suppression in PropsTable output.
+
 2.23.0 - (January 2, 2019)
@@ -9,0 +14,0 @@ ------------------

docs/README.md

@@ -21,2 +21,4 @@ # Terra Props Table
 
+> Any prop that includes the string `@private` in its description will not be included in the PropsTable output.
+
 ## Component Features
@@ -23,0 +25,0 @@ * [Cross-Browser Support](https://github.com/cerner/terra-ui/blob/master/src/terra-dev-site/contributing/ComponentStandards.e.contributing.md#cross-browser-support)

lib/PropsTable.js

@@ -220,2 +220,6 @@ 'use strict';
           var prop = componentProps[key];
+          if (prop.description && prop.description.match(/@private/)) {
+            return null;
+          }
+
           var type = determineType(prop.type);
@@ -222,0 +226,0 @@

package.json

 {
   "name": "terra-props-table",
   "main": "lib/PropsTable.js",
-  "version": "2.24.0",
+  "version": "2.25.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.18.0"
+    "terra-markdown": "^2.19.0"
   },
@@ -49,3 +49,4 @@ "scripts": {
     "test:wdio": "../../node_modules/.bin/wdio ../../node_modules/terra-dev-site/config/wdio/wdio.conf.js"
-  }
+  },
+  "gitHead": "41ba5362f55e42c3e7f6230725aab5812a002ed5"
 }

README.md

@@ -59,3 +59,3 @@ # Terra Props Table
 
-Copyright 2017 Cerner Innovation, Inc.
+Copyright 2017 - 2019 Cerner Innovation, Inc.
 
@@ -62,0 +62,0 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

src/PropsTable.jsx

@@ -150,2 +150,6 @@ /* eslint-disable import/no-extraneous-dependencies */
             const prop = componentProps[key];
+            if (prop.description && prop.description.match(/@private/)) {
+              return null;
+            }
+
             const type = determineType(prop.type);
@@ -152,0 +156,0 @@

tests/wdio/props-table-spec.js

@@ -42,2 +42,11 @@ const viewports = Terra.viewports('medium', 'large');
 
+  describe('Private Props', () => {
+    before(() => {
+      browser.url('/#/raw/tests/terra-props-table/props-table-test/mock-private-props-table');
+      browser.setViewportSize(Terra.viewports('medium')[0]);
+    });
+
+    Terra.should.matchScreenshot('should not render private prop information', { selector: '#PrivatePropsTable' });
+  });
+
   describe('With Title', () => {
@@ -44,0 +53,0 @@ before(() => {

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

60636

increased by8.05%

Number of package files

31

increased by14.81%

Lines of code

1047

increased by10.56%

Dependency changes

• Updatedterra-markdown@^2.19.0