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.

Sign up for GitHub

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

Jump to bottom

yarn docs --ts does not work #13662

Closed
pomek opened this issue Mar 13, 2023 · 0 comments · Fixed by ckeditor/ckeditor5-dev#856
Closed

yarn docs --ts does not work #13662

pomek opened this issue Mar 13, 2023 · 0 comments · Fixed by ckeditor/ckeditor5-dev#856
Assignees
@pomek
Labels
squad:devops Issue to be handled by the Devops team. type:bug This issue reports a buggy (incorrect) behavior.
Milestone
iteration 61 (v37...

Comments

@pomek
Copy link
Member

pomek commented Mar 13, 2023

📝 Provide detailed reproduction steps (if any)

  1. Execute: yarn run docs --ts

✔️ Expected result

The documentation task should not throw any error.

❌ Actual result

It happens on the latest master:

TypeError: Cannot read properties of undefined (reading 'declarations')
    at Converter.onEventEnd (/Users/pomek/Projects/ckeditor/ckeditor5/external/ckeditor5-dev/packages/typedoc-plugins/lib/tag-error/index.js:29:23)
    at triggerEvents (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/utils/events.js:191:43)
    at triggerApi (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/utils/events.js:167:13)
    at eventsApi (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/utils/events.js:60:18)
    at Converter.trigger (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/utils/events.js:389:13)
    at Converter.convert (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/converter/converter.js:77:14)
    at Application.convert (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/application.js:179:40)
    at build (/Users/pomek/Projects/ckeditor/ckeditor5/external/ckeditor5-dev/packages/ckeditor5-dev-docs/lib/buildtypedoc.js:75:35)

Applying a "fix" does not help.

image

TypeError: Cannot read properties of undefined (reading '0')
    at /Users/pomek/Projects/ckeditor/ckeditor5/external/ckeditor5-dev/packages/typedoc-plugins/lib/purge-private-api-docs/index.js:32:67
    at Array.filter (<anonymous>)
    at Converter.<anonymous> (/Users/pomek/Projects/ckeditor/ckeditor5/external/ckeditor5-dev/packages/typedoc-plugins/lib/purge-private-api-docs/index.js:32:5)
    at triggerEvents (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/utils/events.js:191:43)
    at triggerApi (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/utils/events.js:167:13)
    at eventsApi (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/utils/events.js:60:18)
    at Converter.trigger (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/utils/events.js:389:13)
    at Converter.convert (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/converter/converter.js:77:14)
    at Application.convert (/Users/pomek/Projects/ckeditor/ckeditor5/node_modules/typedoc/dist/lib/application.js:179:40)
    at build (/Users/pomek/Projects/ckeditor/ckeditor5/external/ckeditor5-dev/packages/ckeditor5-dev-docs/lib/buildtypedoc.js:75:35)
@pomek pomek added type:bug This issue reports a buggy (incorrect) behavior. squad:devops Issue to be handled by the Devops team. labels Mar 13, 2023
@CKEditorBot CKEditorBot added the status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. label Mar 13, 2023
@pomek pomek self-assigned this Mar 13, 2023
@CKEditorBot CKEditorBot added status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. and removed status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. labels Mar 13, 2023
@pomek pomek mentioned this issue Mar 13, 2023
Merged
psmyrek added a commit to ckeditor/ckeditor5-dev that referenced this issue Mar 14, 2023
@psmyrek
Merge pull request #856 from ckeditor/ck/13662
b50ea99 
Fix (typedoc-plugins): The building documentation process should not crash when processing a non-es6 module file while building from the TypeScript sources. Closes ckeditor/ckeditor5#13662.

Fix (docs): The validator should not crash when processing a non-es6 module file while building from the TypeScript sources. Closes ckeditor/ckeditor5#13662.
@CKEditorBot CKEditorBot removed the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Mar 14, 2023
@CKEditorBot CKEditorBot added this to the iteration 61 milestone Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pomek pomek

Labels
squad:devops Issue to be handled by the Devops team. type:bug This issue reports a buggy (incorrect) behavior.
Projects
None yet
Milestone
iteration 61 (v37.0.0)
Development

Successfully merging a pull request may close this issue.

Building docs when processing a non-es6 module ckeditor/ckeditor5-dev
2 participants
@pomek @CKEditorBot