Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Bump react-docgen to ^7.1.0 #44022

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Bump react-docgen to ^7.1.0 #44022

wants to merge 1 commit into from
+23 −58

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Oct 6, 2024 •
edited
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
react-docgen (source) ^5.4.3 -> ^7.1.0 age adoption passing confidence

Release Notes

reactjs/react-docgen (react-docgen)

v7.1.0

Compare Source

Minor Changes

  • #​923
    3033ca0
    Thanks @​rvetere! - Support generic types on
    React.forwardRef calls.

    Example:

    react-docgen will now find IButtonProps.

    export const FullWidthButton = forwardRef<HTMLButtonElement, IButtonProps>(
  () => {},
);

v7.0.3

Compare Source

Patch Changes

v7.0.2

Compare Source

Patch Changes

v7.0.1

Compare Source

Patch Changes

v7.0.0

Compare Source

Major Changes

  • #​846
    82154c3
    Thanks @​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:

    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:

    const type = getTypeFromReactComponent(path)

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

  • #​848
    dda8915
    Thanks @​danez! - Drop support for Node.js
    version 14.

    The minimum supported version is now 16.14.0

  • #​846
    62e692f
    Thanks @​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

    const resolved = resolveToValue(path);

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

  • #​862
    40ebb00
    Thanks @​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
    82154c3
    Thanks @​danez! - Add support for React.FC in
    TypeScript.

Patch Changes

v6.0.4

Compare Source

Patch Changes

v6.0.3

Compare Source

Patch Changes

v6.0.2

Compare Source

Patch Changes

v6.0.1

Compare Source

Patch Changes

v6.0.0

Compare Source

Major Changes

  • 96d6e9e
    Thanks @​danez! - Rename flowTypeHandler to
    codeTypeHandler because it handles Flow and TypeScript

  • #​719
    d7a39af
    Thanks @​danez! - Refactored
    resolveComponentDefinition utility.

    • Renamed to findComponentDefinition
    • Removed named export isComponentDefinition
    • The utility now does a lot more than previously, check out the commit to see
      the changes in detail.

  • #​761
    dfc2f85
    Thanks @​danez! - Renamed propDocBlockHandler to
    propDocblockHandler for consistency

  • 96d6e9e
    Thanks @​danez! - Simplify
    resolveObjectValuesToArray and remove type handling. None of the code that
    was handling types was used.

  • caae6bf
    Thanks @​danez! - The return values of
    resolveObjectValuesToArray are now in the order they are defined in the
    source code.

  • #​744
    e956802
    Thanks @​danez! - Removed match utility.

    The utility can be replaced by babel helpers and is not needed anymore. Also
    using explicit checks like path.isMemberExpression() is better for type
    safety and catching potential bugs.

  • 96d6e9e
    Thanks @​danez! - Migrate react-docgen to ES
    modules. Please read
    this

  • #​693
    3b28f6e
    Thanks @​danez! - The CLI was removed from
    react-docgen into its own package @react-docgen/cli.

    Check out https://react-docgen.dev/docs/getting-started/cli for the
    documentation.

  • 96d6e9e
    Thanks @​danez! - The main parse API had some
    breaking changes.

    • The arguments were changed from previously 5 to just 2. The following diff
      illustrates how to migrate:

      -parse(src, resolver, handlers, importer, options: { filename, ...babelOptions})
+parse(src, { resolver, handlers, importer, filename, babelOptions: {} })

    • The return type is now always an array, independent of the resolver, even if
      only one component was found in the file.

  • #​786
    0a2481d
    Thanks @​danez! - Renamed the method toObject to
    build in the DocumentationBuilder.

    This method might be used by integrations.

  • 96d6e9e
    Thanks @​danez! - Renamed some of the main exports
    for clarity.

    Renamed handlers to builtinHandlers Renamed resolver to
    builtinResolvers Renamed importers to builtinImporters

  • #​743
    5215bab
    Thanks @​danez! - Removed support for the
    @extends React.Component annotation on react class components.

    Instead, you can use the new @component annotation or define your own
    annotation by creating a custom FindAnnotatedDefinitionsResolver instance

  • #​714
    80e4c74
    Thanks @​danez! - Renamed and migrated built-in
    resolvers to classes.

    • findAllComponentDefinitions was renamed to FindAllDefinitionsResolver
      and is now a class.

      -const resolver = builtinResolvers.findAllComponentDefinitions
+const resolver = new builtinResolvers.FindAllDefinitionsResolver()

    • findAllExportedComponentDefinitions was renamed to
      FindExportedDefinitionsResolver and is now a class.

      -const resolver = builtinResolvers.findAllExportedComponentDefinitions
+const resolver = new builtinResolvers.FindExportedDefinitionsResolver()

    • findExportedComponentDefinition was removed. Use
      FindExportedDefinitionsResolver with the limit option instead.

      This is still the default resolver.

      -const resolver = builtinResolvers.findExportedComponentDefinition
+const resolver = new builtinResolvers.FindExportedDefinitionsResolver({ limit: 1 })

  • 96d6e9e
    Thanks @​danez! - Migrated to babel toolchain

    This is one of the big changes in this new version of react-docgen. It made
    the code a lot more robust because there are now finally working TypeScript
    types for the ASTs.

    Another benefit from this change is that react-docgen is now a lot faster. 🚀
    In some tests an improvement of nearly 50% was seen in comparison to
    version 5.

  • #​707
    d4c27d4
    Thanks @​danez! - Improve performance of file
    system importer.

    The file system importer now also caches the resolving of files in addition to
    parsing files. If the importer is used in an environment where files do change
    at runtime (like a watch command) then the caches will need to be cleared on
    every file change.

  • 96d6e9e
    Thanks @​danez! - Changed the minimum Node.js
    version to 14.18.0

Minor Changes

  • 96d6e9e
    Thanks @​danez! - Add support for .cts and .mts
    extension when using typescript

  • 96d6e9e
    Thanks @​danez! - Treat functions returning
    React.Children.map as components

  • 96d6e9e
    Thanks @​danez! - Improve performance by creating
    all visitors only once

  • 96d6e9e
    Thanks @​danez! - Support all possible kinds of
    functions in the displayNameHandler

  • #​786
    0a2481d
    Thanks @​danez! - Export the type for the
    DocumentationBuilder.

  • #​786
    0a2481d
    Thanks @​danez! - The types NodePath and
    babelTypes are now exported.

    These types are useful when building integrations in TypeScript.

    babelTypes includes all types from @babel/types.

  • #​714
    80e4c74
    Thanks @​danez! - Add the new ChainResolver which
    allows multiple resolvers to be chained.

    import { builtinResolvers } from 'react-docgen';

const { ChainResolver } = builtinResolvers;
const resolver = new ChainResolver([resolver1, resolver2], {
  chainingLogic: ChainResolver.Logic.ALL, // or ChainResolver.Logic.FIRST_FOUND,
});

  • 96d6e9e
    Thanks @​danez! - Support all literal types in
    typescript

  • 96d6e9e
    Thanks @​danez! - Support flow qualified type names

  • 96d6e9e
    Thanks @​danez! - Support class and function
    declarations without identifier

  • 96d6e9e
    Thanks @​danez! - Support resolving of
    destructuring in resolveToValue

  • #​714
    80e4c74
    Thanks @​danez! - Allow resolvers to be classes in
    addition to functions.

    import type { ResolverClass, ResolverFunction } from 'react-docgen';

// This was the only option until now
const functionResolver: ResolverFunction = (file: FileState) => {
  //needs to return array of found components
};

// This is the new class resolver
class MyResolver implements ResolverClass {
  resolve(file: FileState) {
    //needs to return array of found components
  }
}

const classResolver = new MyResolver();

  • 96d6e9e
    Thanks @​danez! - Improve performance drastically
    by making changes to AST traversal

    Visitors are now pre-exploded and are cached in the module scope instead of
    creating them on every call. This change brought the benchmark from 170ops/s
    to 225ops/sec

  • 96d6e9e
    Thanks @​danez! - Add codes to errors to be able to
    easily detect them

    There is a new export ERROR_CODES that contains all possible error codes.
    The two errors that have codes right now are:

    • MISSING_DEFINITION: No component found in a file
    • MULTIPLE_DEFINITIONS: Multiple components found in one file

  • 96d6e9e
    Thanks @​danez! - Support handling
    useImperativeHandle correctly

  • #​743
    5215bab
    Thanks @​danez! - Added a new resolver that finds
    annotated components. This resolver is also enabled by default.

    To use this feature simply annotated a component with @component.

    // @&#8203;component
class MyComponent {}
Patch Changes

Configuration

📅 Schedule: Branch creation - "on sunday before 6:00am" in timezone UTC, Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the dependencies Update of dependencies label Oct 6, 2024
@mui-bot
Copy link

mui-bot commented Oct 6, 2024 •
edited
Loading

Netlify deploy preview

https://deploy-preview-44022--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against d0382fb

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 10, 2024
@DiegoAndai DiegoAndai added the on hold There is a blocker, we need to wait label Oct 10, 2024
@DiegoAndai
Copy link
Member

@ZeeshanTamboli what did you mean with this: #37887 (comment)

What is required to be ESM?

@DiegoAndai DiegoAndai self-requested a review October 10, 2024 15:53
@renovate renovate bot force-pushed the renovate/react-docgen-7.x branch from eeded3b to e098a59 Compare October 10, 2024 15:57
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 10, 2024
@renovate renovate bot force-pushed the renovate/react-docgen-7.x branch from e098a59 to 236049e Compare October 19, 2024 19:11
@renovate renovate bot changed the title Bump react-docgen to ^7.0.3 Bump react-docgen to ^7.1.0 Oct 19, 2024
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 22, 2024
@renovate renovate bot force-pushed the renovate/react-docgen-7.x branch from 236049e to 066b81a Compare October 22, 2024 13:21
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 22, 2024
@aarongarciah
Copy link
Member

@ZeeshanTamboli what did you mean with this: #37887 (comment)

What is required to be ESM?

@ZeeshanTamboli ping

@ZeeshanTamboli
Copy link
Member

ZeeshanTamboli commented Oct 24, 2024 •
edited
Loading

@ZeeshanTamboli what did you mean with this: #37887 (comment)

What is required to be ESM?

I was out of the office for the last two weeks hence I couldn't reply.
I don't know much about ESM. However, I saw that from v5 to v6, the package became pure ESM with no CommonJS compatibility (docs). The guide here also says that projects should support ESM, so in our case, packages/api-docs-builder should support ESM packages with changes in package.json and file imports. I could be mistaken.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 27, 2024
@renovate renovate bot force-pushed the renovate/react-docgen-7.x branch from 066b81a to 484b757 Compare October 27, 2024 08:53
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 27, 2024
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 7, 2024
@renovate renovate bot force-pushed the renovate/react-docgen-7.x branch from 484b757 to 7386464 Compare November 7, 2024 09:11
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 7, 2024
@DiegoAndai
Copy link
Member

Indeed something seems broken when generating the documentation: https://app.circleci.com/pipelines/github/mui/material-ui/142193/workflows/0045335b-63ca-4ca2-814a-d23babdfc501/jobs/766104

Assigning @mui/docs-infra

@DiegoAndai DiegoAndai requested a review from a team November 7, 2024 19:19
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Dec 2, 2024
@renovate renovate bot force-pushed the renovate/react-docgen-7.x branch from 7386464 to 809f9ec Compare December 2, 2024 08:27
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Dec 2, 2024
@DiegoAndai DiegoAndai removed their request for review December 2, 2024 21:56
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Dec 10, 2024
@renovate renovate bot force-pushed the renovate/react-docgen-7.x branch from 809f9ec to d0382fb Compare December 10, 2024 11:53
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
dependencies Update of dependencies on hold There is a blocker, we need to wait
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mui-bot @DiegoAndai @aarongarciah @ZeeshanTamboli