Bump shikiji, use transformers API, expose transformers API

[blackmann]

Changes

• Bump shikiji version
• Use transformers API. tranforms is deprecated.
• Expose the transformers API so that some tranformer presets or community transformers can be used.

Testing

There's are existing tests for this and they pass.

Docs

We'll need to update the docs to indicate that transformers can be supplied to astro.config.js > markdown.shikiConfig.transformers

/cc @withastro/maintainers-docs for feedback!

[changeset-bot]

🦋 Changeset detected

Latest commit: 7d24b32

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

[ematipico]

@blackmann please a have at the CI, it seems TypeScript can't build the project

[blackmann]

I'm getting this error when trying to build astro

astro:build: src/core/config/schema.ts(67,14): error TS2742: The inferred type of 'AstroConfigSchema' cannot be named without a reference to '.pnpm/[email protected]/node_modules/shikiji-core/dist/chunk-types.mjs'. This is likely not portable. A type annotation is necessary.

Any idea what it means. It's hard trying to understand what it means.

I don't know much about how pnpm works; I'm unable to find the shikiji-core package in any of the node_modules though it's stated as a dependency for shikiji. I dunno if that's the cause.

Ideas? @ematipico

---

Edit:

I imported the types into schema.ts and seems to work. ❇️

[blackmann]

 Tasks:    16 successful, 16 total
Cached:    9 cached, 16 total
  Time:    4m22.645s

All tests passing locally for me. I can't tell what the failure is with the CIs.

@ematipico please have a look¿

[bluwy]

Thanks for the PR! I've pushed some commits to fix the test and some clean-ups. And it looks good to me now. Marking this as minor to be merged on our next minor release push.

For the documentation, we can update https://docs.astro.build/en/guides/markdown-content/#shiki-configuration to add the new option.

[ematipico]

Blocking, as it will be part of our next minor release. We will merge it in the next merge day :)

[sarah11918]

If this adds a new user-configurable option, there needs to be documentation and an example showing this. Where is the config set (code snippet)? What are the values you can set, and what do they do?

I'm going from the description provided in the changeset. If this is not user-configurable, then "exposes a new config option" is not the right way to describe this change, because it implies that there is something you can do here!

[sarah11918]

Blocking this, because we have no documentation.

We will need:
- JSDoc content to update the configuration reference page automatically <- looks like we don't go into that level of Shiki config here, so only the docs PR is required!

• a PR to docs to update the Shiki configuration section as appropriate.

For a minor release, not opposed to showing a code snippet of the config in the changeset if you so decide, either!

[ematipico]

@blackmann could you please help us with documentation? If not provided, we won't be able to release this PR on Thursday

[blackmann]

Yes. On it!

[blackmann]

Updated docs: withastro/docs#6402

@ematipico @sarah11918

[sarah11918]

Just some small light edits to the changeset, for your consideration, but otherwise docs is happy!

docs received!

[sarah11918]

Final approval for docs!