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

TypeDoc Updates #11539

Open
melloware opened this issue Feb 29, 2024 · 6 comments · Fixed by #11567
Open

TypeDoc Updates #11539

melloware opened this issue Feb 29, 2024 · 6 comments · Fixed by #11567
Assignees
Labels
documentation Documentation needs updating javascript Pull requests that update Javascript code
Milestone

Comments

@melloware
Copy link
Member

melloware commented Feb 29, 2024

@blutorange can you take a pass at updating the typedoc package.json? I am getting warnings from libraries that don't support Node 20. I am getting a warning from Coloris. I would like to update all this before the 14.0.0 release.

Install Warnings

PS C:\dev\primetek\primefaces\primefaces\src\main\type-definitions> npm install
npm WARN EBADENGINE Unsupported engine {
npm WARN EBADENGINE   package: '@es-joy/jsdoccomment@0.10.8',
npm WARN EBADENGINE   required: { node: '^12 || ^14 || ^16' },
npm WARN EBADENGINE   current: { node: 'v20.9.0', npm: '10.1.0' }
npm WARN EBADENGINE }
npm WARN EBADENGINE Unsupported engine {
npm WARN EBADENGINE   package: 'eslint-plugin-jsdoc@36.1.0',
npm WARN EBADENGINE   required: { node: '^12 || ^14 || ^16' },
npm WARN EBADENGINE   current: { node: 'v20.9.0', npm: '10.1.0' }
npm WARN EBADENGINE }

Build Warnings

[INFO] Warning: Specifying multiple comments at the start of a file to use the first comment as the comment for the module has been deprecated. Use @module or @packageDocumentation instead.

Note

This is caused by AutoNumeric index.d.ts having two different comments at the top of the file: https://github.com/autoNumeric/autoNumeric/blob/next/index.d.ts

@melloware melloware added dependencies Any updates to a dependency file javascript Pull requests that update Javascript code labels Feb 29, 2024
@blutorange
Copy link
Contributor

Sure, I'll take look

@melloware
Copy link
Member Author

Thanks !

@melloware melloware added this to the 14.0.0 milestone Feb 29, 2024
@melloware melloware added documentation Documentation needs updating and removed dependencies Any updates to a dependency file labels Mar 1, 2024
melloware added a commit to melloware/primefaces that referenced this issue Mar 4, 2024
@melloware
Copy link
Member Author

Still a bunch more to go but made some progress.

image

@blutorange
Copy link
Contributor

I did take a look it, ideally we need to update all dependencies since some depend on others (e.g. newer ESLint versions require newer TypeScript versions etc). It isn't quite as easy as I had hoped -- especially after the TypeScript update the checker does not seem to work properly. I'm sure it can be fixed, I just didn't have much time in the previous days

@melloware
Copy link
Member Author

I worries I have it good enough to cut a 14.0.0 to NPM and I will move this ticket to 15.0.0 to give you more time to look

@melloware melloware modified the milestones: 14.0.0, 15.0.0 Mar 5, 2024
@melloware
Copy link
Member Author

Also check Editor now that QuillJS 2.0.1 is supposed to have its own Types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation needs updating javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants