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

Fallback to undefined rather than false when resolving CLI flags #4362

Merged
merged 2 commits into from
Aug 17, 2022
Merged

Fallback to undefined rather than false when resolving CLI flags #4362

merged 2 commits into from
Aug 17, 2022

Conversation

joseph-lozano
Copy link
Contributor

@joseph-lozano joseph-lozano commented Aug 17, 2022

Changes

  • If a user did not set their CLI to --draft, then typeof flags.drafts === 'boolean' will not be true, which would cause the drafts config to be set to false, overriding user configuration.

Testing

I was unable to run pnpm install on my machine. Any additional commits to add tests (or even pointing me the right direction to add them myself) would be very much appreciated.

I tested that this fix solves the issue by fiddling with dist/core/config.js on my own project.

Docs

This actually makes the behavior of astro build conform to the current documentation: https://docs.astro.build/en/guides/markdown-content/#markdown-drafts

@changeset-bot
Copy link

changeset-bot bot commented Aug 17, 2022

🦋 Changeset detected

Latest commit: f6aa568

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

This PR includes changesets to release 13 packages
Name Type
astro Patch
@e2e/astro-component Patch
@e2e/error-react-spectrum Patch
@e2e/error-sass Patch
@e2e/errors Patch
@e2e/lit-component Patch
@e2e/preact-component Patch
@e2e/react-component Patch
@e2e/solid-component Patch
@e2e/solid-recurse Patch
@e2e/svelte-component Patch
@e2e/e2e-tailwindcss Patch
@e2e/ts-resolution Patch

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 the pkg: astro Related to the core `astro` package (scope) label Aug 17, 2022
@joseph-lozano
Copy link
Contributor Author

joseph-lozano commented Aug 17, 2022

⚠️ No Changeset found

I was unable to get pnpm install (and therefore pnpm exec changeset) to work on my computer. Unsure how I should proceed.

Copy link
Member

@bluwy bluwy left a comment

Choose a reason for hiding this comment

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

This make sense to me. Otherwise it would always override at:

if (typeof flags.drafts === 'boolean') astroConfig.markdown.drafts = flags.drafts;

Re pnpm i issue, what exact issues are you getting? We're happy to help if you're in the Astro discord server too!

I've added a changeset for this PR here.

@bluwy bluwy merged commit aa5118e into withastro:main Aug 17, 2022
@astrobot-houston astrobot-houston mentioned this pull request Aug 17, 2022
@joseph-lozano joseph-lozano deleted the fix-drafts-config branch August 17, 2022 12:44
@astrobot-houston astrobot-houston mentioned this pull request Aug 22, 2022
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)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants