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

Rename entryPoint to entrypoint #9161

Merged
merged 4 commits into from
Nov 22, 2023
Merged

Rename entryPoint to entrypoint #9161

merged 4 commits into from
Nov 22, 2023

Conversation

bluwy
Copy link
Member

@bluwy bluwy commented Nov 22, 2023

Changes

There's only one instance where we use entryPoint which is for the injectRoute() API. This PR renames it to entrypoint, and emit a warning if the old name is used

Testing

Existing tests should pass.

Docs

withastro/docs#5475

I also added a warning at packages/astro/src/integrations/index.ts

Copy link

changeset-bot bot commented Nov 22, 2023

🦋 Changeset detected

Latest commit: 09c3540

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

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

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review semver: minor Change triggers a `minor` release labels Nov 22, 2023
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

null,
`The injected route "${injectRoute.pattern}" by ${integration.name} specifies the entry point with the "entryPoint" property. This property is deprecated, please use "entrypoint" instead.`
);
injectRoute.entrypoint = injectRoute.entryPoint as string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can't wait until 5.0 to remove this :D

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning looks good! I left a comment re: changeset.

And noticed that @bluwy is way ahead of me and has already added this to the Breaking changes tracker issue in docs! Perfect!

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@bluwy bluwy merged commit bd0c2e9 into next Nov 22, 2023
14 checks passed
@bluwy bluwy deleted the plt-1176-entrypoint branch November 22, 2023 15:05
@astrobot-houston astrobot-houston mentioned this pull request Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review semver: minor Change triggers a `minor` release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants