fix: code component was missing support for meta string #11605

jcayzac · 2024-08-03T02:51:49Z

Fixes withastro/roadmap#990

Changes

This fixes Code.astro so that passing the meta option to the shiki highlighter is supported.

Testing

The change is just a new prop and passing it to Shiki. Tests are implemented in Shiki.

Docs

The jsdoc is up-to-date.

/cc @withastro/maintainers-docs for feedback!

docs pr: withastro/docs#9054

Fixed #11604

changeset-bot · 2024-08-03T02:51:54Z

🦋 Changeset detected

Latest commit: 2d20fb7

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

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

packages/astro/components/Code.astro

bluwy · 2024-08-09T11:29:38Z

We also need docs to update this section: https://docs.astro.build/en/reference/api-reference/#code-. @jcayzac are you able to update them and address the review? If not we can also help out.

jcayzac · 2024-08-09T14:18:13Z

@bluwy

We also need docs to update this section: https://docs.astro.build/en/reference/api-reference/#code-. @jcayzac are you able to update them and address the review? If not we can also help out.

I can do it now, but I have a question: since this is a separate repo, how do you sync merges and versions? How will the new docs be released at the same time as the feature?

jcayzac · 2024-08-10T00:53:26Z

@bluwy @Princesseuh done adding the docs to astro-docs.

sarah11918 · 2024-08-12T10:41:32Z

I can do it now, but I have a question: since this is a separate repo, how do you sync merges and versions? How will the new docs be released at the same time as the feature?

Hi, hello, it's me. I'm how they are sync'd. 😄

ematipico · 2024-08-12T10:49:40Z

@bluwy

We also need docs to update this section: docs.astro.build/en/reference/api-reference#code-. @jcayzac are you able to update them and address the review? If not we can also help out.

I can do it now, but I have a question: since this is a separate repo, how do you sync merges and versions? How will the new docs be released at the same time as the feature?

@jcayzac Send a PR to the withastro/docs repository with the new information, @sarah11918 will help you with the correct format.

sarah11918 · 2024-08-12T11:23:24Z

Yup, PR has been sent to docs and already has my initial review!

sarah11918 · 2024-08-12T11:25:33Z

Sorry, quick question about use here: the docs PR made it seem like this meta value is only/primarily used to pass options to Shiki transformers. This changeset mentions a different use case and does not mention transformers.

Does this work outside of transformers, too? Is this just a general string of data that our <Code /> component can use independent of transformers?

sarah11918

Blocking until docs are done!

Princesseuh · 2024-08-12T11:37:20Z

Sorry, quick question about use here: the docs PR made it seem like this meta value is only/primarily used to pass options to Shiki transformers. This changeset mentions a different use case and does not mention transformers.

Does this work outside of transformers, too? Is this just a general string of data that our <Code /> component can use independent of transformers?

Only Shiki transformers use it, just forgot to mention it explicitly in the changeset

sarah11918 · 2024-08-12T12:01:47Z

Perfect, thanks Erika! That means the docs suggestion I made is probably fine then. 😄

Just got thrown when I came back here!

bluwy

Looks good for the code

sarah11918

Thank you for adding this helpful property, @jcayzac ! I pulled from our discussion in the docs PR to align the changeset more with what's going in docs. See what you think!

.changeset/odd-buttons-pay.md

no longer blocked by docs! in review!

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

sarah11918

Approving for docs! 🫡

jcayzac · 2024-08-13T00:39:19Z

.changeset/odd-buttons-pay.md


 ```astro
+// src/pages/index.astro


This probably would not be a page, since it doesn't have a layout and just calls a component, no?

Sure! We could fix this by changing it to be a component URL, or by adding some HTML comment for "missing stuff". I'll update to a component name, but the other would be fine if you want to suggest it!

jcayzac · 2024-08-13T00:40:47Z

.changeset/odd-buttons-pay.md


 ```astro
+// src/pages/index.astro


This is invalid Astro markup. Comments above the --- mark are not allowed.

D'oh, great catch! I'm so spoiled living in the docs repo... (we always just use title= there)

.changeset/odd-buttons-pay.md

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

merge day

* fix: code component was missing support for meta string Fixed #11604 * Create odd-buttons-pay.md * <Code>: add reference link for meta prop * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/odd-buttons-pay.md * Update .changeset/odd-buttons-pay.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> --------- Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>

* Empty commit * Changeset * feat: add Content Layer loader (#11334) * wip * wip * wip * Update demo * Add meta * wip * Add file loader * Add schema validation * Remove log * Changeset * Format * Lockfile * Fix type * Handle loading for data store JSON * Use rollup util to import JSON * Fix types * Format * Add tests * Changes from review * fix: sync content layer in dev (#11365) * wip * wip * wip * Update demo * Add meta * wip * Add file loader * Add schema validation * Remove log * Changeset * Format * Lockfile * Fix type * Handle loading for data store JSON * Use rollup util to import JSON * Fix types * Format * Add tests * Changes from review * Sync content layer in dev * feat: add typegen for loaders (#11358) * fix: watch for content layer changes (#11371) * fix: watch for content layer changes * Add test * feat: adds simple loader (#11386) * wip * Add simple loader * Fix type guard * Tighten loader schema * Add loader function to type * Reinstall vitest * feat: add glob loader (#11398) * feat: add glob loader * Enable watching and fix paths * Store the full entry object, not just data * Add generateId support * Fix test * Rename loaders to sync * Refacctor imports * Use getEntry * Format * Fix import * Remove type from output * Windows path * Add test for absolute path * Update lockfile * Debugging windows * Allow file URL for base dir * Reset time limit * feat: add markdown rendering to content layer (#11440) * feat: add glob loader * Enable watching and fix paths * Store the full entry object, not just data * Add generateId support * Fix test * Rename loaders to sync * Refacctor imports * Use getEntry * Format * Fix import * Remove type from output * Windows path * Add test for absolute path * Update lockfile * Debugging windows * Allow file URL for base dir * Reset time limit * wip: add markdown rendering to content layer * use cached entries * CLean up types * Instrument more of the build * Add digest helper * Add comments * Make image extraction work * feat: image support for content layer (#11469) * wip * wip * Add image to benchmark * Stub assets if missing * Resolve assets in data * Ignore virtual module * Format * rm log * Handle images when using cached data * Fix CCC * Add a comment * Changes from review * Format * Use relative paths for asset files * Pass all md props to getImage * Ensure dotastro dir exists * Fix tests * Changes from review * Don't use temp array in getcollection * Add error handling * Format * Handle paths that are already relative * Dedupe sync runs * Fix syncing in dev * Changes from review * Windows paths ftw * feat(content-layer): support references in content layer (#11494) * Support references in content layer * Fix utf8 rendering * Warn for invalid entries * Fix test * lol windows paths * Remove assertion * chore: fix content layer types (#11527) * Add experimental_content type * Fix import * Make data store methods generic * fix loader types * Lockfile * Clean content layer with `--force` (#11541) * Clearn content layer with `--force` * Add tests * Document --force flag * Fixes to content layer render types (#11558) * Lockfile * feat: use devalue to serialize content layer data (#11562) * feat: use devalue to serialize content layer data * Fix import * Use devalue stringify * Unused import * Propagate error messages correctly * Support --force flag in sync and dev (#11581) * Support --force flag in sync and dev * Fix test * Separate render function and merge content layer types (#11579) * Separate render function and merge content layer types * Changes from review * fix: clear content layer cache if config has changed (#11591) * fix: clear content layer cache if config has changed * Add test * Watch config * Change from review * fix: skip glob files in content dir (#11622) * fix: skip glob files in content dir * Changes from review * Log pattern * Refactor content layer into shared instance (#11625) * Refactor content layer into shared instance * Clean up when testing * Handle cleanup * fix: support filters in content layer getCollection (#11631) * Throw when using deprecated getEntryByX functions with content layer (#11637) * Updates to content layer types and jsdocs (#11643) * Add hot key to reload content layer (#11626) * Add hot key to reload content layer * Fix filename * Remove cli message * Update example * Change key to "s" * feat: handle simple mdx rendering (#11633) * feat: handle simple mdx rendering * cleanup * feedback * fix regression * remove log * flip condition * update tests * log collections to understand the error * let's try this alternative * try parallel test to understand the issue * chore: use a new fixture to fix tests * rebase and docs * fix regressions * remove old code * address feedback * rename param * log error * rebase * chore: try a different cache dir to solve the error test * fix invalidation of the module when there's no store available * address suggestion * run formatter * update lock file * Lint * Add experimental content layer flag (#11652) * Add experimental content layer flag * Syntax and format * Aside * Format * Reset content config between runs * Update fixture * Update terminology * Lint * wut * Normalize render function return value (#11663) * Add markdoc support to content layer (#11664) * Add markdoc support to content layer * Switch test to cheerio * Update benchmarks * update lock file * Update content layer flag docs (#11682) * Update content layer flag docs * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * More markdoc * Typo * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update --------- Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Add changeset for content layer experimental release (#11644) * Add changeset for content layer experimental release * Update changeset * Update .changeset/smooth-chicken-wash.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> --------- Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * feat: injectTypes (#11551) * feat: make inline config 1st arg * fix: run config done in sync * feat: start working on injectTypes * feat: write files * feat: adapt core features * feat: migrate db to injectTypes * feat: special db handling * feat: update settings instead of workarounds * fix: create dotAstroDir * feat: refactor sync tests * fix: path * fix: paths * chore: add comments * feat: overwrite content file if exists * chore: remove unused db env related code * feat: use dotAstroDir for settings * chore: simplify astro env sync * feat: use dotAstroDir for preferences * feat: handle db in integration api * chore: reorganize * feat: format * feat: add test * Discard changes to examples/basics/astro.config.mjs * Discard changes to examples/basics/package.json * Discard changes to pnpm-lock.yaml * chore: remove test files * feat: update examples dts * fix: dts * chore: changesets * fix: indentation * Apply suggestions from code review Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> * Apply suggestions from code review Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> * chore: format * Update packages/astro/src/integrations/hooks.ts * Update .changeset/mean-horses-kiss.md * feat: remove formatting * feat: handle fs errors * feat: remove astro:db special path handling * feat: add fs error * Update packages/astro/src/content/types-generator.ts * Update .changeset/mean-horses-kiss.md * Update errors-data.ts * Update .changeset/mean-horses-kiss.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/mean-horses-kiss.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> --------- Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com> * Add file generation and flag for content intellisense (#11639) * feat: add type to infer input type of collection * refactor: * feat: generate json schema for content too * feat: generate a manifest of all the collections * refactor: unnecessary type * fix: only add content collections to manifest * chore: changeset * fix: generate file URLs * fix: flag it properly * fix: save in lower case * docs: add jsdoc to experimental option * nit: move function out * fix: match vscode flag name * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update serious-pumas-run.md * test: add tests * Add content layer support * Apply suggestions from code review * fix: test * Update .changeset/serious-pumas-run.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Apply suggestions from code review * Remove check for json --------- Co-authored-by: Matt Kane <m@mk.gg> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * nit: use same filesystem error as injectTypes * fix: code component was missing support for meta string (#11605) * fix: code component was missing support for meta string Fixed #11604 * Create odd-buttons-pay.md * <Code>: add reference link for meta prop * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update .changeset/odd-buttons-pay.md * Update .changeset/odd-buttons-pay.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> --------- Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Emanuele Stoppa <my.burning@gmail.com> * Deprecates exporting prerender with dynamic values (#11657) * wip * done i think * Add changeset * Use hook instead * Reorder hooks [skip ci] * Update .changeset/eleven-pens-glow.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Fix run * Fix link * Add link Co-authored-by: Sarah Rainsberger <sarah11918@users.noreply.github.com> * More accurate migration [skip ci] --------- Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Sarah Rainsberger <sarah11918@users.noreply.github.com> * Use node parseArgs instead of yargs-parser and arg (#11645) * wip * done * Add changeset * Format * Update * Fix houston * Fix test * Fix test * [ci] format * resolve conflict --------- Co-authored-by: Emanuele Stoppa <my.burning@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Florian Lefebvre <contact@florian-lefebvre.dev> Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com> Co-authored-by: Julien Cayzac <jcayzac@users.noreply.github.com> Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com> Co-authored-by: Sarah Rainsberger <sarah11918@users.noreply.github.com> Co-authored-by: Bjorn Lu <ematipico@users.noreply.github.com>

fix: code component was missing support for meta string

e204036

Fixed #11604

github-actions bot added the pkg: astro Related to the core `astro` package (scope) label Aug 3, 2024

Create odd-buttons-pay.md

988f54d

github-actions bot added the semver: minor Change triggers a `minor` release label Aug 5, 2024

github-actions bot previously requested changes Aug 5, 2024

View reviewed changes

bluwy reviewed Aug 5, 2024

View reviewed changes

packages/astro/components/Code.astro Outdated Show resolved Hide resolved

Princesseuh added this to the 4.14 milestone Aug 7, 2024

<Code>: add reference link for meta prop

e3624a0

jcayzac mentioned this pull request Aug 10, 2024

add docs for meta attribute in Code component withastro/docs#9054

Merged

jcayzac requested a review from bluwy August 11, 2024 08:09

ematipico approved these changes Aug 12, 2024

View reviewed changes

sarah11918 previously requested changes Aug 12, 2024

View reviewed changes

bluwy approved these changes Aug 12, 2024

View reviewed changes

sarah11918 reviewed Aug 12, 2024

View reviewed changes

.changeset/odd-buttons-pay.md Outdated Show resolved Hide resolved

.changeset/odd-buttons-pay.md Outdated Show resolved Hide resolved

Apply suggestions from code review

f1ab60c

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

sarah11918 approved these changes Aug 12, 2024

View reviewed changes

jcayzac commented Aug 13, 2024

View reviewed changes

sarah11918 reviewed Aug 13, 2024

View reviewed changes

.changeset/odd-buttons-pay.md Outdated Show resolved Hide resolved

Update .changeset/odd-buttons-pay.md

16304d2

sarah11918 reviewed Aug 13, 2024

View reviewed changes

.changeset/odd-buttons-pay.md Outdated Show resolved Hide resolved

Update .changeset/odd-buttons-pay.md

2d20fb7

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

ematipico merged commit d3d99fb into withastro:main Aug 14, 2024
12 of 13 checks passed

astrobot-houston mentioned this pull request Aug 14, 2024

[ci] release #11699

Merged

astrobot-houston mentioned this pull request Aug 14, 2024

[ci] release (alpha) #11627

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: code component was missing support for meta string #11605

fix: code component was missing support for meta string #11605

jcayzac commented Aug 3, 2024 •

edited by bluwy

Loading

changeset-bot bot commented Aug 3, 2024 •

edited

Loading

github-actions bot left a comment

bluwy commented Aug 9, 2024

jcayzac commented Aug 9, 2024 •

edited

Loading

jcayzac commented Aug 10, 2024

sarah11918 commented Aug 12, 2024

ematipico commented Aug 12, 2024 •

edited

Loading

sarah11918 commented Aug 12, 2024

sarah11918 commented Aug 12, 2024 •

edited

Loading

sarah11918 left a comment

Princesseuh commented Aug 12, 2024 •

edited

Loading

sarah11918 commented Aug 12, 2024

bluwy left a comment

sarah11918 left a comment

sarah11918 left a comment

jcayzac Aug 13, 2024

sarah11918 Aug 13, 2024

jcayzac Aug 13, 2024

sarah11918 Aug 13, 2024

fix: code component was missing support for meta string #11605

fix: code component was missing support for meta string #11605

Conversation

jcayzac commented Aug 3, 2024 • edited by bluwy Loading

Changes

Testing

Docs

changeset-bot bot commented Aug 3, 2024 • edited Loading

🦋 Changeset detected

github-actions bot left a comment

Choose a reason for hiding this comment

bluwy commented Aug 9, 2024

jcayzac commented Aug 9, 2024 • edited Loading

jcayzac commented Aug 10, 2024

sarah11918 commented Aug 12, 2024

ematipico commented Aug 12, 2024 • edited Loading

sarah11918 commented Aug 12, 2024

sarah11918 commented Aug 12, 2024 • edited Loading

sarah11918 left a comment

Choose a reason for hiding this comment

Princesseuh commented Aug 12, 2024 • edited Loading

sarah11918 commented Aug 12, 2024

bluwy left a comment

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

jcayzac Aug 13, 2024

Choose a reason for hiding this comment

sarah11918 Aug 13, 2024

Choose a reason for hiding this comment

jcayzac Aug 13, 2024

Choose a reason for hiding this comment

sarah11918 Aug 13, 2024

Choose a reason for hiding this comment

jcayzac commented Aug 3, 2024 •

edited by bluwy

Loading

changeset-bot bot commented Aug 3, 2024 •

edited

Loading

jcayzac commented Aug 9, 2024 •

edited

Loading

ematipico commented Aug 12, 2024 •

edited

Loading

sarah11918 commented Aug 12, 2024 •

edited

Loading

Princesseuh commented Aug 12, 2024 •

edited

Loading