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

Add lock file for generate-doc tool #31789

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Conversation

weshaggard
Copy link
Member

A recent package update broke the tool so we are adding a lock file to ensure we have a reliable execution.

For details the newer version of https://www.npmjs.com/package/shiki?activeTab=versions version 1.23.0 introduced a new dependency in shikijs/shiki#832 which no longer compiles.

node_modules/oniguruma-to-es/types/parse.d.ts(61,49): error TS2339: Property 'orphan' does not exist on type '{}'.
node_modules/oniguruma-to-es/types/parse.d.ts(96,31): error TS2339: Property 'atomic' does not exist on type '{}'.
node_modules/oniguruma-to-es/types/parse.d.ts(96,39): error TS2339: Property 'flags' does not exist on type '{}'.

Until we figure out what the best way to fix those issues we are pinning to the older version using a lock file.

@weshaggard weshaggard closed this Nov 15, 2024
@weshaggard weshaggard reopened this Nov 15, 2024
A recent package update broke the tool so we are adding
a lock file to ensure we have a reliable execution.
Copy link
Member

@scbedd scbedd 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 @weshaggard

@weshaggard
Copy link
Member Author

Passed the point of failure so overriding and merging to get other pipelines unblocked.

@weshaggard weshaggard merged commit a24a372 into Azure:main Nov 15, 2024
9 of 24 checks passed
@weshaggard weshaggard deleted the AddLockForGenDoc branch November 15, 2024 19:28
@slevithan
Copy link

slevithan commented Nov 18, 2024

Not sure exactly why this isn't compiling and with which parser, but in the updated version of oniguruma-to-es used by Shiki v1.23.1, I've changed the code for the erroring lines you highlighted to no longer use object destructuring from an empty object that's used as a default argument value. So bumping to the latest Shiki (1.23.1) might resolve this issue.

@weshaggard
Copy link
Member Author

Thanks @slevithan I've submitted PR to update the dependencies at #31813. It does appear as the object destruction was the issue with the version of the compiler we are using.

weshaggard added a commit that referenced this pull request Nov 19, 2024
Follow-up on #31789 as the
dependency was updated to not use the object deconstruction. See comment
#31789 (comment)
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.

4 participants