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

Support --open with url string #9573

Merged
merged 6 commits into from
Jan 3, 2024
Merged

Support --open with url string #9573

merged 6 commits into from
Jan 3, 2024

Conversation

bluwy
Copy link
Member

@bluwy bluwy commented Jan 2, 2024

Changes

close #8192

Supports passing a url string to server.open and --open to open a specific URL in the browser on dev startup.

Testing

Tested manually with the basic example. e.g. pnpm dev --open /test

Docs

Updated the JSDoc for server.open.

Might need to also update: https://docs.astro.build/en/reference/cli-reference/#--open

server.open seems to not be documented, but probably should: https://docs.astro.build/en/reference/configuration-reference/#server-options (Fixed by adding a missing @docs jsdoc tag)

Copy link

changeset-bot bot commented Jan 2, 2024

🦋 Changeset detected

Latest commit: 0e1b539

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 labels Jan 2, 2024
@ematipico
Copy link
Member

ematipico commented Jan 2, 2024

We should probably double-check with @withastro/maintainers-docs, however, the PR is fine with me!

@bluwy bluwy added the semver: minor Change triggers a `minor` release label Jan 2, 2024
@Princesseuh Princesseuh added this to the 4.1.0 milestone Jan 2, 2024
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.

🍼 suggestion, @bluwy! Thanks for adding this!

packages/astro/src/@types/astro.ts Outdated Show resolved Hide resolved
packages/astro/src/@types/astro.ts Outdated Show resolved Hide resolved
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
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.

Looks great!

@ematipico ematipico merged commit 2a8b9c5 into main Jan 3, 2024
14 checks passed
@ematipico ematipico deleted the open-url-string branch January 3, 2024 13:07
@astrobot-houston astrobot-houston mentioned this pull request Jan 3, 2024
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
4 participants