Docusaurus: package.json repository/directory metadata incomplete

Created on 20 Oct 2020  路  5Comments  路  Source: facebook/docusaurus

馃悰 Bug Report

The package.json files within packages/* contain incomplete metadata for source repo and source directory. e.g. as according to this advice from npm's package.json documentation:

image

Have you read the [Contributing Guidelines on issues]

Yes

To Reproduce

View any package.json within packages/*. I think all are missing the directory field and some are also missing the source repository information altogether (e.g. @docusaurus/preset-classic)

Expected behavior

Monorepo package.json files should all contain a valid repository object including directory field.

I can try correcting this if you agree to receive a PR.

Actual Behavior

N/A

Your Environment

N/A

Reproducible Demo

N/A

bug needs triage

Most helpful comment

@slorber happy to help on that aspect too. Anyway, for now please see the linked PR #3613

All 5 comments

I can try correcting this if you agree to receive a PR.

Yes, of course, it would be great!

Is this something new related to npm 7 support for workspace?

Or is it something that could improve the npm package links? for example on this page? https://www.npmjs.com/package/@docusaurus/core

@slorber it wasn't related to npm 7 specifically. I help run Renovate Bot and correct source URLs help us with both automated grouping as well as changelog retrieval. An example of one which is missing source links is https://www.npmjs.com/package/@docusaurus/preset-classic

Thanks, I see. PR welcome ;)

Are you able to retrieve easily the changelogs, as we have v1 and v2 changelogs at the root?
We don't have a changelog per package.

We have an issue about Renovate Bot here, will have to check that and see how Docusaurus can benefit from it.
https://github.com/facebook/docusaurus/issues/3552

@slorber happy to help on that aspect too. Anyway, for now please see the linked PR #3613

Was this page helpful?
0 / 5 - 0 ratings

Related issues

muuvmuuv picture muuvmuuv  路  3Comments

nebrelbug picture nebrelbug  路  3Comments

sebqq picture sebqq  路  3Comments

rickyvetter picture rickyvetter  路  3Comments

azu picture azu  路  3Comments