add filterProperty to getTypeDocumentation

[souporserious]

This adds the ability to filter specific properties in getTypeDocumentation by passing a custom filter. Take the following source file:

import * as React from 'react';

type ButtonVariant = 'primary' | 'secondary' | 'danger';

type ButtonProps = {
  variant?: ButtonVariant;
} & React.ButtonHTMLAttributes<HTMLButtonElement>

export const Button = (props: ButtonProps) => {
  return <button {...props} />
};

When processing documentation from this source file, a filter can now be provided to allow specific properties from node_modules to be processed for documentation:

const types = getTypeDocumentation(
  sourceFile.getVariableDeclarationOrThrow('Button'),
  (property) => {
    if (property.getName() === 'onClick') {
      return true
    }
    return !property.getSourceFile().isInNodeModules()
  }
)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
tsxmod	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 12, 2024 4:39pm

[changeset-bot]

🦋 Changeset detected

Latest commit: 5f988c6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@tsxmod/utils	Minor
tsxmod	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR