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.

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

chore(repo): Add "directory" to package.json repository fields. #826

Merged
merged 1 commit into from
Apr 22, 2021

Conversation

developit
Copy link
Contributor

@developit developit commented Mar 4, 2021

Rollup Plugin Name: (all plugins)

This PR contains:

  • bugfix
  • feature
  • refactor
  • documentation
  • other

Are tests included?

  • yes
  • no (non-functional change)

Breaking Changes?

  • yes
  • no

Description

This is a trivial thing, but every time I search for a Rollup plugin, the top results are npm package listing pages. That's great, but of the two sidebar links, one points to the plugins repo itself, whereas the other points to the package's README. This uses npm's repository.directory package.json field to make them both point to the correct location (see npm cli source that confirms the logic).

@shellscape
Copy link
Collaborator

@developit good to see you outside of twitter :)

The way this PR is structured, our publishing scripts won't pick up anything for each plugin. It needs an upgrade to a more robust recognition of changes, and to take advantage of a new pnpm feature since it was written, but like all things I lack the time at the moment. With the one commit, none of the plugins will pick this up for publish until a commit targeting each plugin has been merged.

Regardless, this can play well with what we have, but the commits in this branch/PR need to be setup differently. We don't get these commits often (maybe 3 or 4 since the repo was conceived) so it hasn't been documented. Essentially, each plugin needs it's own commit. e.g. chore(auto-install): add directory to package.json. We'll then use a plain old merge commit for the PR and magically each plugin will see a change that'll allow us to run the publish scripts as they are. It's silly busy work, and I don't expect you to take the time to jump through that hoop. Without the hoop, you may not see your change for a bit in each plugin.

The choice is yours on which way to go with this, and we'll gladly accept either.

@shellscape
Copy link
Collaborator

Welp, we'll merge this, but please be aware that it won't affect any plugins until they're published again. Which means most won't get this update published.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants