@storybook/react-docgen-typescript-plugin
Advanced tools
Comparing version 1.0.1 to 1.0.2--canary.7.324a727c65a1819f7f3ede5abc1f32d440e4530a.0
{ | ||
"name": "@storybook/react-docgen-typescript-plugin", | ||
"version": "1.0.1", | ||
"version": "1.0.2--canary.7.324a727c65a1819f7f3ede5abc1f32d440e4530a.0", | ||
"description": "A webpack plugin to inject react typescript docgen information.", | ||
"license": "MIT", | ||
"repository": "hipstersmoothie/react-docgen-typescript-plugin", | ||
"repository": "storybookjs/react-docgen-typescript-plugin", | ||
"author": "Andrew Lisowski <lisowski54@gmail.com>", | ||
@@ -41,3 +41,3 @@ "main": "dist/index.js", | ||
"micromatch": "^4.0.2", | ||
"react-docgen-typescript": "^2.0.0", | ||
"react-docgen-typescript": "^2.1.1", | ||
"tslib": "^2.0.0" | ||
@@ -55,3 +55,3 @@ }, | ||
"@typescript-eslint/parser": "^4.9.0", | ||
"auto": "^10.2.3", | ||
"auto": "^10.3.0", | ||
"auto-config-hipstersmoothie": "^4.0.0", | ||
@@ -58,0 +58,0 @@ "eslint": "^7.14.0", |
<div align="center"> | ||
<img height="200" | ||
src="https://upload.wikimedia.org/wikipedia/commons/thumb/a/a7/React-icon.svg/512px-React-icon.svg.png"> | ||
<h1>react-docgen-typescript-plugin</h1> | ||
<h1>@storybook/react-docgen-typescript-plugin</h1> | ||
<p>A webpack plugin to inject react typescript docgen information</p> | ||
@@ -11,5 +11,5 @@ </div> | ||
```sh | ||
npm install --save-dev react-docgen-typescript-plugin | ||
npm install --save-dev @storybook/react-docgen-typescript-plugin | ||
# or | ||
yarn add -D react-docgen-typescript-plugin | ||
yarn add -D @storybook/react-docgen-typescript-plugin | ||
``` | ||
@@ -23,4 +23,5 @@ | ||
```ts | ||
const ts = require('typescript'); | ||
const ReactDocgenTypescriptPlugin = require("react-docgen-typescript-plugin").default; | ||
const ts = require("typescript"); | ||
const ReactDocgenTypescriptPlugin = require("react-docgen-typescript-plugin") | ||
.default; | ||
@@ -34,3 +35,5 @@ module.exports = { | ||
// or with compiler options | ||
new ReactDocgenTypescriptPlugin({ compilerOptions: { jsx: ts.JsxEmit.Preserve } }), | ||
new ReactDocgenTypescriptPlugin({ | ||
compilerOptions: { jsx: ts.JsxEmit.Preserve }, | ||
}), | ||
], | ||
@@ -51,4 +54,4 @@ }; | ||
| 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']` | | ||
@@ -97,2 +100,2 @@ ## Debugging | ||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! | ||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
67509
97
2
+ Addedcaniuse-lite@1.0.30001690(transitive)
+ Addedelectron-to-chromium@1.5.75(transitive)
+ Addedenhanced-resolve@5.18.0(transitive)
- Removedcaniuse-lite@1.0.30001689(transitive)
- Removedelectron-to-chromium@1.5.73(transitive)
- Removedenhanced-resolve@5.17.1(transitive)