Skip to content

Packages ready to publish #847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .changeset/commander-eleven.md

This file was deleted.

28 changes: 0 additions & 28 deletions .changeset/cyan-ways-fry.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/early-snakes-brake.md

This file was deleted.

6 changes: 0 additions & 6 deletions .changeset/eight-coats-tie.md

This file was deleted.

8 changes: 0 additions & 8 deletions .changeset/fifty-gifts-sort.md

This file was deleted.

20 changes: 0 additions & 20 deletions .changeset/four-teachers-tan.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/hip-kangaroos-sing.md

This file was deleted.

6 changes: 0 additions & 6 deletions .changeset/lazy-walls-swim.md

This file was deleted.

8 changes: 0 additions & 8 deletions .changeset/perfect-turtles-reply.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/sour-jeans-tell.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/unlucky-stingrays-lick.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/young-carrots-sort.md

This file was deleted.

37 changes: 37 additions & 0 deletions packages/react-docgen-cli/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,42 @@
# Release Notes

## 2.0.0

### Major Changes

- [#848](https://github.com/reactjs/react-docgen/pull/848)
[`dda8915`](https://github.com/reactjs/react-docgen/commit/dda8915ce9f8d5065372570d590405f2c2403bd8)
Thanks [@danez](https://github.com/danez)! - Drop support for Node.js
version 14.

The minimum supported version is now 16.14.0

### Minor Changes

- [`b0a46e7`](https://github.com/reactjs/react-docgen/commit/b0a46e7429f2a7449eebeff329753b25ac4226c9)
Thanks [@danez](https://github.com/danez)! - update dependency commander to
v11

### Patch Changes

- [#859](https://github.com/reactjs/react-docgen/pull/859)
[`7dd2264`](https://github.com/reactjs/react-docgen/commit/7dd22646877d9a454f7809de5cbbb72499758916)
Thanks [@renovate](https://github.com/apps/renovate)! - update dependency
commander to v11.1.0

- Updated dependencies
[[`82154c3`](https://github.com/reactjs/react-docgen/commit/82154c3b59bf22acf3068165f87b089138fdf7ae),
[`6312f2f`](https://github.com/reactjs/react-docgen/commit/6312f2f47b9f679b5bf923a30855e813193ed4af),
[`c01d1a0`](https://github.com/reactjs/react-docgen/commit/c01d1a00fdba76cea38eebc953fd3d2dd3f12fbd),
[`dda8915`](https://github.com/reactjs/react-docgen/commit/dda8915ce9f8d5065372570d590405f2c2403bd8),
[`62e692f`](https://github.com/reactjs/react-docgen/commit/62e692fcca6f3d17dcf81ce72f2db1a95b2d694b),
[`74b6680`](https://github.com/reactjs/react-docgen/commit/74b6680910037b1b4b64dd57769b652bf775675e),
[`0641700`](https://github.com/reactjs/react-docgen/commit/0641700e4425390c0fe50e216a71e5e18322ab3b),
[`40ebb00`](https://github.com/reactjs/react-docgen/commit/40ebb0010a7a380f89e0c79a4a937cf9a50a3245),
[`82154c3`](https://github.com/reactjs/react-docgen/commit/82154c3b59bf22acf3068165f87b089138fdf7ae),
[`3be404e`](https://github.com/reactjs/react-docgen/commit/3be404eee6c8fc7bd867fea9d1987b7f438107d6)]:
- [email protected]

## 1.0.4

### Patch Changes
Expand Down
4 changes: 2 additions & 2 deletions packages/react-docgen-cli/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@react-docgen/cli",
"version": "1.0.4",
"version": "2.0.0",
"description": "A CLI to extract information from React components for documentation generation.",
"repository": {
"type": "git",
Expand Down Expand Up @@ -35,7 +35,7 @@
"commander": "11.1.0",
"debug": "4.3.4",
"fast-glob": "3.3.1",
"react-docgen": "workspace:6.0.4",
"react-docgen": "workspace:7.0.0",
"slash": "5.1.0"
},
"devDependencies": {
Expand Down
99 changes: 99 additions & 0 deletions packages/react-docgen/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,104 @@
# Release Notes

## 7.0.0

### Major Changes

- [#846](https://github.com/reactjs/react-docgen/pull/846)
[`82154c3`](https://github.com/reactjs/react-docgen/commit/82154c3b59bf22acf3068165f87b089138fdf7ae)
Thanks [@danez](https://github.com/danez)! - `getTypeFromReactComponent` now
returns an array of paths to types instead of just one. This can appear when
multiple type definitions are found for a component, for example:

```ts
const Component: React.FC<Props> = (props: { some: string }) => {};
```

In this example both the `Props` definition as well as `{ some: string }` are
now found and used.

Here is a simple diff to illustrate the change when using
`getTypeFromReactComponent`:

```diff

const type = getTypeFromReactComponent(path)

-if (type) {
+if (type.length > 0) {
// do smth
}

```

- [#848](https://github.com/reactjs/react-docgen/pull/848)
[`dda8915`](https://github.com/reactjs/react-docgen/commit/dda8915ce9f8d5065372570d590405f2c2403bd8)
Thanks [@danez](https://github.com/danez)! - Drop support for Node.js
version 14.

The minimum supported version is now 16.14.0

- [#846](https://github.com/reactjs/react-docgen/pull/846)
[`62e692f`](https://github.com/reactjs/react-docgen/commit/62e692fcca6f3d17dcf81ce72f2db1a95b2d694b)
Thanks [@danez](https://github.com/danez)! - `resolveToValue` will not resolve
to `ImportDeclaration` anymore but instead to one of the possible specifiers
(`ImportSpecifier`, `ImportDefaultSpecifier` or `ImportNamespaceSpecifier`).
This gives better understanding to which specifier exactly `resolveToValue`
did resolve a NodePath to.

Here is a possible easy fix for this in a code snippet that uses
`resolveToValue`

```diff
const resolved = resolveToValue(path);

-if (resolved.isImportDeclaration()) {
+if (resolved.parentPath?.isImportDeclaration()) {
// do smth
}
```

### Minor Changes

- [#862](https://github.com/reactjs/react-docgen/pull/862)
[`40ebb00`](https://github.com/reactjs/react-docgen/commit/40ebb0010a7a380f89e0c79a4a937cf9a50a3245)
Thanks [@danez](https://github.com/danez)! - Support `PropsWithoutRef`,
`PropsWithRef` and `PropsWithChildren` in TypeScript.

Component props are now detected correctly when these builtin types are used,
but they do currently not add any props to the documentation.

- [#846](https://github.com/reactjs/react-docgen/pull/846)
[`82154c3`](https://github.com/reactjs/react-docgen/commit/82154c3b59bf22acf3068165f87b089138fdf7ae)
Thanks [@danez](https://github.com/danez)! - Add support for `React.FC` in
TypeScript.

### Patch Changes

- [`6312f2f`](https://github.com/reactjs/react-docgen/commit/6312f2f47b9f679b5bf923a30855e813193ed4af)
Thanks [@renovate[bot]](https://github.com/renovate%5Bbot%5D)! - update
dependency @types/doctrine to ^0.0.7

- [#846](https://github.com/reactjs/react-docgen/pull/846)
[`c01d1a0`](https://github.com/reactjs/react-docgen/commit/c01d1a00fdba76cea38eebc953fd3d2dd3f12fbd)
Thanks [@danez](https://github.com/danez)! - Fix detection of react class
components when super class is imported via named import.

- [#861](https://github.com/reactjs/react-docgen/pull/861)
[`74b6680`](https://github.com/reactjs/react-docgen/commit/74b6680910037b1b4b64dd57769b652bf775675e)
Thanks [@renovate](https://github.com/apps/renovate)! - update dependency
@types/doctrine to ^0.0.8

- [#846](https://github.com/reactjs/react-docgen/pull/846)
[`0641700`](https://github.com/reactjs/react-docgen/commit/0641700e4425390c0fe50e216a71e5e18322ab3b)
Thanks [@danez](https://github.com/danez)! - Remove unnecessary call to
`resolveToValue` when trying to find props type from react components.

- [#858](https://github.com/reactjs/react-docgen/pull/858)
[`3be404e`](https://github.com/reactjs/react-docgen/commit/3be404eee6c8fc7bd867fea9d1987b7f438107d6)
Thanks [@danez](https://github.com/danez)! - Fix detection of React.Children
with ESM imports

## 6.0.4

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/react-docgen/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-docgen",
"version": "6.0.4",
"version": "7.0.0",
"description": "A library to extract information from React components for documentation generation.",
"repository": {
"type": "git",
Expand Down
2 changes: 1 addition & 1 deletion packages/website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"postcss": "8.4.31",
"postcss-lightningcss": "1.0.0",
"react": "18.2.0",
"react-docgen": "workspace:6.0.4",
"react-docgen": "workspace:7.0.0",
"react-dom": "18.2.0",
"tailwindcss": "3.3.3"
},
Expand Down
37 changes: 37 additions & 0 deletions packages/website/src/pages/docs/release-notes/cli.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,42 @@
# Release Notes

## 2.0.0

### Major Changes

- [#848](https://github.com/reactjs/react-docgen/pull/848)
[`dda8915`](https://github.com/reactjs/react-docgen/commit/dda8915ce9f8d5065372570d590405f2c2403bd8)
Thanks [@danez](https://github.com/danez)! - Drop support for Node.js
version 14.

The minimum supported version is now 16.14.0

### Minor Changes

- [`b0a46e7`](https://github.com/reactjs/react-docgen/commit/b0a46e7429f2a7449eebeff329753b25ac4226c9)
Thanks [@danez](https://github.com/danez)! - update dependency commander to
v11

### Patch Changes

- [#859](https://github.com/reactjs/react-docgen/pull/859)
[`7dd2264`](https://github.com/reactjs/react-docgen/commit/7dd22646877d9a454f7809de5cbbb72499758916)
Thanks [@renovate](https://github.com/apps/renovate)! - update dependency
commander to v11.1.0

- Updated dependencies
[[`82154c3`](https://github.com/reactjs/react-docgen/commit/82154c3b59bf22acf3068165f87b089138fdf7ae),
[`6312f2f`](https://github.com/reactjs/react-docgen/commit/6312f2f47b9f679b5bf923a30855e813193ed4af),
[`c01d1a0`](https://github.com/reactjs/react-docgen/commit/c01d1a00fdba76cea38eebc953fd3d2dd3f12fbd),
[`dda8915`](https://github.com/reactjs/react-docgen/commit/dda8915ce9f8d5065372570d590405f2c2403bd8),
[`62e692f`](https://github.com/reactjs/react-docgen/commit/62e692fcca6f3d17dcf81ce72f2db1a95b2d694b),
[`74b6680`](https://github.com/reactjs/react-docgen/commit/74b6680910037b1b4b64dd57769b652bf775675e),
[`0641700`](https://github.com/reactjs/react-docgen/commit/0641700e4425390c0fe50e216a71e5e18322ab3b),
[`40ebb00`](https://github.com/reactjs/react-docgen/commit/40ebb0010a7a380f89e0c79a4a937cf9a50a3245),
[`82154c3`](https://github.com/reactjs/react-docgen/commit/82154c3b59bf22acf3068165f87b089138fdf7ae),
[`3be404e`](https://github.com/reactjs/react-docgen/commit/3be404eee6c8fc7bd867fea9d1987b7f438107d6)]:
- [email protected]

## 1.0.4

### Patch Changes
Expand Down
Loading