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

Fix glob sync query #923

Merged
merged 1 commit into from
Feb 3, 2025
Merged

Conversation

AlexVelezLl
Copy link
Member

@AlexVelezLl AlexVelezLl commented Feb 3, 2025

Description

In #823, we removed the globby package in favor of node-glob, but it seems that due to a version mismatch we were using const { GlobSync } = require('glob'); as the api, but it wasnt working well and when querying the files, it wasnt finding any, and the jsdocs result was an empty object that made our component docs to miss the API info:

image

This PR fixes this using glob.sync instead as suggested in their docs (and suggested by copilot 😅).

Changelog

  • Description: Fixes glob query in extrac api script.
  • Products impact: bugfix.
  • Addresses: -.
  • Components: Docs.
  • Breaking: no
  • Impacts a11y: no
  • Guidance: .

Steps to test

  1. run yarn dev and check that the API sections (props, events, slots) are present in component docs

@MisRob
Copy link
Member

MisRob commented Feb 3, 2025

For reference, I will link #823

Copy link
Member

@MisRob MisRob left a comment

Choose a reason for hiding this comment

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

All good, thank you @AlexVelezLl for fixing KDS on so many fronts today :)!

@MisRob MisRob merged commit dfcc932 into learningequality:develop Feb 3, 2025
10 of 11 checks passed
learning-equality-bot bot pushed a commit that referenced this pull request Feb 3, 2025
@AlexVelezLl
Copy link
Member Author

Oh yes, it was #823 😆, IDK why I linked another unrelated PR hahaha

@AlexVelezLl AlexVelezLl deleted the fix-extract-api branch February 3, 2025 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants