[Feature request] Support monorepos in integration catalog

benedfit commented 1 year ago

Describe the bug

Currently when adding items to the integration catalog, addons that are stored in monorepos do not current display the correct information

Steps to reproduce the behavior

Go to https://storybook.js.org/addons/@newhighsco/storybook-addon-svgr/
See that the README is not available
Click on "View in Github"
See that you land on https://github.com/newhighsco/storybook, the monorepo root, rather than the directory that contains the addon

Expected behavior

The package.json for @newhighsco/storybook-addon-svg contains details of the directory that contains the source and README - https://github.com/newhighsco/storybook/blob/0d6c60da90e33ba609da122c429e3af4932ec320/packages/storybook-addon-svgr/package.json#L15-L19:

"repository": {
    "type": "git",
    "url": "https://github.com/newhighsco/storybook.git",
    "directory": "packages/storybook-addon-svgr"
 }

It would be great is the integration catalog could use the additional directory information, use it to find the README and append it to the "View in Github" href

ShaunEvening commented 1 year ago

Hey @benedfit 👋

Thanks for the suggestion :) I'll definitely get around to this during my next round of maintenance on the scraper. In the mean time I can look at making sure that your README is at least shown on the details page. Apologies for that!

kylegach commented 1 year ago

Noting an offline discussion we had about this.

We use the homepage property (and sometimes the repository.url property) to grab the README. Yours is:

"homepage": "https://github.com/newhighsco/storybook/tree/main/packages/storybook-addon-svgr#readme"

And apparently, the #readme portion is what's breaking this.

We can probably just filter out /#.*$/.

benedfit commented 5 months ago

I removed the anchor from the "homepage" field and now it's showing up. So feel free to just close this issue if you don't have time to fix the scraper

storybookjs / frontpage