react-docgen-typescript-plugin - npm Package Compare versions

Comparing version 0.4.2-canary.9.7536c0f.0 to 0.5.0

CHANGELOG.md

@@ -0,1 +1,84 @@
+# v0.5.0 (Tue Jun 16 2020)
+
+#### 🚀 Enhancement
+
+- default to loading root tsconfig.json when no typescript configuration is provided [#9](https://github.com/hipstersmoothie/react-docgen-typescript-plugin/pull/9) ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+#### Authors: 1
+
+- Andrew Lisowski ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+---
+
+# v0.4.1 (Mon Jun 15 2020)
+
+#### 🐛 Bug Fix
+
+- Handle no options passed in [#8](https://github.com/hipstersmoothie/react-docgen-typescript-plugin/pull/8) ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+#### 📝 Documentation
+
+- Correct import usage [#7](https://github.com/hipstersmoothie/react-docgen-typescript-plugin/pull/7) ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+#### Authors: 1
+
+- Andrew Lisowski ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+---
+
+# v0.4.0 (Fri Jun 12 2020)
+
+#### 🚀 Enhancement
+
+- only load plugin when typescript is available [#6](https://github.com/hipstersmoothie/react-docgen-typescript-plugin/pull/6) ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+#### 📝 Documentation
+
+- Update readme.md [#5](https://github.com/hipstersmoothie/react-docgen-typescript-plugin/pull/5) ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+#### Authors: 1
+
+- Andrew Lisowski ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+---
+
+# v0.3.0 (Fri Jun 12 2020)
+
+#### 🚀 Enhancement
+
+- add debug logs [#4](https://github.com/hipstersmoothie/react-docgen-typescript-plugin/pull/4) ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+#### Authors: 1
+
+- Andrew Lisowski ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+---
+
+# v0.2.0 (Fri Jun 12 2020)
+
+### Release Notes
+
+_From #3_
+
+New options:
+
+- `include` - Glob patterns to generate docs for
+- `exclude` - Glob patterns to ignore doc generation. Great for ignoring all of your Icons
+
+---
+
+#### 🚀 Enhancement
+
+- add "include" and "exclude" options [#3](https://github.com/hipstersmoothie/react-docgen-typescript-plugin/pull/3) ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+#### 📝 Documentation
+
+- Add note about slow tsconfig options [#2](https://github.com/hipstersmoothie/react-docgen-typescript-plugin/pull/2) ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+#### Authors: 1
+
+- Andrew Lisowski ([@hipstersmoothie](https://github.com/hipstersmoothie))
+
+---
+
 # v0.1.0 (Wed Jun 10 2020)
@@ -2,0 +85,0 @@

dist/plugin.d.ts

@@ -55,3 +55,3 @@ import * as webpack from "webpack";
     private options;
-    constructor(options: PluginOptions);
+    constructor(options?: PluginOptions);
     apply(compiler: webpack.Compiler): void;
@@ -58,0 +58,0 @@ }

dist/plugin.js

@@ -43,3 +43,3 @@ "use strict";
 class DocgenPlugin {
-    constructor(options) {
+    constructor(options = {}) {
         this.name = "React Docgen Typescript Plugin";
@@ -46,0 +46,0 @@ this.options = options;

package.json

 {
   "name": "react-docgen-typescript-plugin",
-  "version": "0.4.2-canary.9.7536c0f.0",
+  "version": "0.5.0",
   "description": "A webpack plugin to inject react typescript docgen information.",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -22,3 +22,4 @@ <div align="center">
 ```ts
-const ReactDocgenTypescriptPlugin = require("react-docgen-typescript-plugin");
+const ts = require('typescript');
+const ReactDocgenTypescriptPlugin = require("react-docgen-typescript-plugin").default;
 
@@ -48,4 +49,4 @@ module.exports = {
 | typePropName         | string         | Specify the name of the property for docgen info prop type.                                                                                         | `type`                    |
-| exclude              | glob[]         | Glob patterns to ignore and not generate docgen information for. (Great for ignoring large icon libraries)                                          | []                        |
-| include              | glob[]         | Glob patterns to generate docgen information for                                                                                                    | ['**/**.tsx']             |
+| exclude              | glob[]         | Glob patterns to ignore and not generate docgen information for. (Great for ignoring large icon libraries)                                          | `[]`                        |
+| include              | glob[]         | Glob patterns to generate docgen information for                                                                                                    | `['**/**.tsx']`             |
 
@@ -52,0 +53,0 @@ ## Debugging

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

22795

increased by11.99%

Number of lines in readme file

67

increased by1.52%

No dependency changes