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

Move @types/js-yaml to normal dependencies #2650

Merged
merged 5 commits into from
Dec 2, 2024

Conversation

raviqqe
Copy link
Contributor

@raviqqe raviqqe commented Dec 2, 2024

Description

This PR moves the @types/js-yaml package into a normal dependency in the @astrojs/starlight package.

Because we export TypeScript files directly in the exports field in a package.json file of the @astrojs/starlight package, we need to include all dependencies' @types/* packages in normal dependencies. Otherwise, we get following errors on type check of, for example, astro.config.ts even with skipLibCheck: true in tsconfig.json:

node_modules/@astrojs/starlight/utils/translations-fs.ts:4:18 - error TS7016: Could not find a declaration file for module 'js-yaml'. '/Users/raviqqe/src/github.com/raviqqe/stak/doc/node_modules/js-yaml/dist/js-yaml.mjs' implicitly has an 'any' type.
  Try `npm i --save-dev @types/js-yaml` if it exists or add a new declaration (.d.ts) file containing `declare module 'js-yaml';`

4 import yaml from 'js-yaml';

Copy link

changeset-bot bot commented Dec 2, 2024

🦋 Changeset detected

Latest commit: 33ec151

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

This PR includes changesets to release 1 package
Name Type
@astrojs/starlight 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

Copy link

netlify bot commented Dec 2, 2024

Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit 33ec151
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/674d8e2f8218850008634748
😎 Deploy Preview https://deploy-preview-2650--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added the 🌟 core Changes to Starlight’s main package label Dec 2, 2024
@astrobot-houston
Copy link
Collaborator

Hello! Thank you for opening your first PR to Starlight! ✨

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any issues you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🤩

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

raviqqe and others added 4 commits December 2, 2024 11:13

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Thank you @raviqqe!

@delucis delucis merged commit 38db4ec into withastro:main Dec 2, 2024
15 checks passed
@delucis delucis added the 🌟 patch Change that triggers a patch release label Dec 2, 2024
@astrobot-houston astrobot-houston mentioned this pull request Dec 2, 2024
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Dec 3, 2024

Verified

This commit was signed with the committer’s verified signature.
* main:
  Move `@types/js-yaml` to normal dependencies (withastro#2650)
  [ci] format
  i18n(ru): update some translations (withastro#2643)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌟 core Changes to Starlight’s main package 🌟 patch Change that triggers a patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants